PdfPartInfo Content block for main page of pdf document that contains info from openapi info contact if it exists

Hierarchy

Constructors

Methods

  • Generates Content block with contact for main page from openapi file

    Parameters

    Returns Promise<Content>

  • Generates Content block with description content block for main page

    Parameters

    Returns Promise<ContentStack>

  • Generates Content block with email from openapi file

    Parameters

    Returns Promise<Content>

  • Generates Content block with terms of service from openapi file

    Parameters

    Returns 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();

    Parameters

    Returns Promise<Content>

Generated using TypeDoc