from-data-to-pdf

Index

Interfaces

Functions

Functions

closeBrowser

closeBrowser(browser: Browser): Promise<void>

- Defined in index.ts:27
author

DOUAL Sofian

description

Close given browser.

Parameters
- browser: Browser
Returns Promise<void>

fromHtmlFileToPdf

fromHtmlFileToPdf(files: HTMLTarget[], save: boolean, path?: Path): Promise<FileBuffer[]>

- Defined in index.ts:289
author

DOUAL Sofian

description

Get html files and carries out the process.

Parameters
- files: HTMLTarget[]
- save: boolean
- Optional path: Path
Returns Promise<FileBuffer[]>

fromHtmlFileToString

fromHtmlFileToString(data: HTMLTarget[], path?: string): Promise<FileBuffer[]>

- Defined in index.ts:203
author

DOUAL Sofian

description

Converts HTML files to string.

Parameters
- data: HTMLTarget[]
- Optional path: string
Returns Promise<FileBuffer[]>

generateBuffer

generateBuffer(browser: Browser, targets: FileBuffer[], path?: string): Promise<FileBuffer[]>

- Defined in index.ts:46
author

DOUAL Sofian

description

If path is undefined, returns an array of PDFS buffer. Otherwise, return the path of the saved PDF files.

Parameters
- browser: Browser
- targets: FileBuffer[]
- Optional path: string
Returns Promise<FileBuffer[]>

getPdf

getPdf(targets: FileBuffer[], save: boolean, path?: string): Promise<FileBuffer[]>

- Defined in index.ts:264
author

DOUAL Sofian

description

Carries out the process without to get local files.

Parameters
- targets: FileBuffer[]
- save: boolean
- Optional path: string
Returns Promise<FileBuffer[]>

initBrowser

initBrowser(): Promise<Browser>

- Defined in index.ts:11
author

DOUAL Sofian

description

Return a browser.

Returns Promise<Browser>

initDefaultFolder

initDefaultFolder(): Promise<boolean>

- Defined in index.ts:152
author

DOUAL Sofian

description

Create folders /myApp/temp, /myApp/temp/target, /myApp/temp/generatedPDF.

Returns Promise<boolean>

savePDF

savePDF(targets: FileBuffer[]): Promise<FileBuffer[]>

- Defined in index.ts:120
author

DOUAL Sofian

description

Save the buffer as a PDF file in /temp/generatedPDF/.

Parameters
- targets: FileBuffer[]
Returns Promise<FileBuffer[]>

setPath

setPath(path?: string): string

- Defined in index.ts:316
author

DOUAL Sofian

description

It returns the path of the app directory if path param does not exists. Else if path param exists and it is a relative path, this method joins it with the path of app directory to finally returns the result as string. Else if path param exists and it is an absolute path, this methods return it.

Parameters
- Optional path: string
Returns string

Generated using TypeDoc