Class AsyncAPIInputProcessor

Static supportedVersions

isFileInput

• isFileInput(input): boolean

• Parameters

  • input: any

  Returns boolean

process

• process(input?, options?): Promise<InputMetaModel>

• Process the input as an AsyncAPI document

  Parameters

  • Optional input: any

  • Optional options: ProcessorOptions

  Returns Promise<InputMetaModel>

shouldProcess

• shouldProcess(input?): boolean

• Figures out if an object is of type AsyncAPI document

  Parameters

  • Optional input: any

  Returns boolean

tryGetVersionOfDocument

• tryGetVersionOfDocument(input?): undefined | string

• Try to find the AsyncAPI version from the input. If it cannot undefined are returned, if it can, the version is returned.

  Parameters

  • Optional input: any

  Returns undefined | string

Static convertToInternalSchema

• convertToInternalSchema(schema, alreadyIteratedSchemas?): boolean | AsyncapiV2Schema

• Reflect the name of the schema and save it to x-modelgen-inferred-name extension.

  This keeps the the id of the model deterministic if used in conjunction with other AsyncAPI tools such as the generator.

  Parameters

  • schema: boolean | SchemaInterface

    to reflect name for

  • alreadyIteratedSchemas: Map<string, AsyncapiV2Schema> = ...

  Returns boolean | AsyncapiV2Schema

Static isFromNewParser

• isFromNewParser(input?): boolean

• Figure out if input is from the new AsyncAPI parser.

  Parameters

  • Optional input: any

  Returns boolean

Static isFromParser

• isFromParser(input?): boolean

• Figure out if input is from the AsyncAPI parser.

  Parameters

  • Optional input: any

  Returns boolean