Class PathsTagBuilder

PathsTagBuilder generates Content tag block with paths that tag contains

Hierarchy

PathsTagBuilderBase
- PathsTagBuilder

Index

Constructors

Properties

_options? _pathBuilder

Methods

_genDescription _genHeader _getTagInfo genTag

Constructors

constructor

new PathsTagBuilder(options?): PathsTagBuilder
Parameters
- Optional options: IRavageOptions
Returns PathsTagBuilder
Inherited from PathsTagBuilderBase.constructor
- Defined in pdfParts/pathsTagBuilder.ts:17

Properties

`Protected` `Optional` _options

_options?: IRavageOptions

`Protected` _pathBuilder

_pathBuilder: PathBuilder

Methods

`Protected` _genDescription

_genDescription(tag, openapi): Promise<Content>
Generates description for tag Content
Parameters
- tag: string
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathsTagBuilderBase._genDescription
- Defined in pdfParts/pathsTagBuilder.ts:81

`Protected` _genHeader

_genHeader(tag, tagSeq): Promise<Content>
Generates header for PathTag Content
Parameters
- tag: string
- tagSeq: number
Returns Promise<Content>
Overrides PathsTagBuilderBase._genHeader
- Defined in pdfParts/pathsTagBuilder.ts:71

`Private` _getTagInfo

_getTagInfo(tag, openapi): Promise<TagObject>
Parameters
- tag: string
- openapi: OpenapiInfoV3
Returns Promise<TagObject>
- Defined in pdfParts/pathsTagBuilder.ts:89

genTag

genTag(tag, tagSeq, operationObjects, openapi): Promise<Content>
Generates tag Content with paths for pdf
Parameters
- tag: string
- tagSeq: number
- operationObjects: OperationObjectWithPath[]
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathsTagBuilderBase.genTag
- Defined in pdfParts/pathsTagBuilder.ts:102

Generated using TypeDoc