Class DocGeneratorPDF

Class to generate PDF from OpenAPI definition.

Hierarchy

DocGeneratorPDF

Index

Constructors

Properties

_options _pdfDoc

Accessors

Methods

createPdf createPdfAndWriteToFile writeToFile

Constructors

constructor

new DocGeneratorPDF(options?): DocGeneratorPDF
Parameters
- Optional options: IRavageOptions
Returns DocGeneratorPDF
- Defined in structures/docGenerator.ts:14

Properties

`Private` _options

_options: IRavageOptions

`Private` _pdfDoc

_pdfDoc: PDFDoc

Accessors

pdfStyles

set pdfStyles(style): void
setter for pdfStyles
Parameters
- style: StyleDictionary
Returns void
- Defined in structures/docGenerator.ts:22

Methods

createPdf

createPdf(api): Promise<PDFDoc>
Method to build pdf from OpenAPI definition and returns promise with PDFKit.PDFDocument inside
Parameters
- api: string | Document<{}>
  
  An OpenAPI definition, or the file path or URL of an OpenAPI definition. The path can be absolute or relative. In Node, the path is relative to process.cwd(). In the browser, it's relative to the URL of the page.
Returns Promise<PDFDoc>
- Defined in structures/docGenerator.ts:35

createPdfAndWriteToFile

createPdfAndWriteToFile(api, file): Promise<void>
Method to create and write
Parameters
- api: string | Document<{}>
- file: string
Returns Promise<void>
- Defined in structures/docGenerator.ts:64

writeToFile

writeToFile(pdfDocument, file): Promise<void>
Method to write the PDFKit.PDFDocument to *.pdf file
Parameters
- pdfDocument: PDFDoc
- file: string
  
  The file path to write the PDF
Returns Promise<void>
- Defined in structures/docGenerator.ts:47

Generated using TypeDoc