Class AsyncAPIInputProcessor

constructor

• new AsyncAPIInputProcessor(): AsyncAPIInputProcessor

  Returns AsyncAPIInputProcessor

StaticsupportedVersions

isFileInput

• isFileInput(input: any): boolean

  Parameters

  • input: any

  Returns boolean

process

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

  Process the input as an AsyncAPI document

  Parameters

  • Optionalinput: any
  • Optionaloptions: ProcessorOptions

  Returns Promise<InputMetaModel>

shouldProcess

• shouldProcess(input?: any): boolean

  Figures out if an object is of type AsyncAPI document

  Parameters

  • Optionalinput: any

  Returns boolean

tryGetVersionOfDocument

• tryGetVersionOfDocument(input?: any): string | undefined

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

  Parameters

  • Optionalinput: any

  Returns string | undefined

StaticconvertToInternalSchema

• convertToInternalSchema(
      schema: boolean | SchemaInterface,
      alreadyIteratedSchemas?: Map<string, AsyncapiV2Schema>,
      context?: string | SchemaContext,
  ): 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> = ...

    map of already processed schemas

  • Optionalcontext: string | SchemaContext

    context information for name inference

  Returns boolean | AsyncapiV2Schema

StaticisFromNewParser

• isFromNewParser(input?: any): boolean

  Figure out if input is from the new AsyncAPI parser.

  Parameters

  • Optionalinput: any

  Returns boolean

StaticisFromParser

• isFromParser(input?: any): boolean

  Figure out if input is from the AsyncAPI parser.

  Parameters

  • Optionalinput: any

  Returns boolean