Class PdfPartToc

genDef

• genDef(openapiTree, options?): Promise<Content>

• This method create pdfmake content blocks by openapiTree that contains information about openapi specs, by localize that contains information about localize pdfmake content blocks, and by includeExample that contains information about requests and responses.

  Example

  async function main() {
    const processor = new PdfPartProcessor();
    const openapiTree = {} as OpenapiInfoV3;
    const localize = {} as Localize;
    const includeExample = true;
    const result = await processor.genDef(
     openapiTree, 
     localize, 
     includeExample
     );
  }
  
  main();
  Copy

  Parameters

  • openapiTree: OpenapiInfoV3

  • Optional options: IRavageOptions

  Returns Promise<Content>