nats-python/openapi_templete/node_modules/@asyncapi/parser/API.md at 1aa1b5f6250a0a5a291d02ca47dc8fa8d73403fe

sandbox/nats-python

Fork 0

Files

T

marys 1aa1b5f625 Befor generating

2026-06-01 13:17:37 +02:00

240 KiB

Raw Blame History

Modules

@asyncapi/parser

Mixins

MixinBindings: Implements functions to deal with the common Bindings object.
MixinDescription: Implements functions to deal with the description field.
MixinExternalDocs: Implements functions to deal with the ExternalDocs object.
MixinSpecificationExtensions: Implements functions to deal with the SpecificationExtensions object.
MixinTags: Implements functions to deal with the Tags object.

Typedefs

SchemaIteratorCallbackType: The different kind of stages when crawling a schema.
SchemaTypesToIterate: The different types of schemas you can iterate

@asyncapi/parser

@asyncapi/parser
- instance
  - .ParserError ⇐ Error
    - new ParserError(definition)
    - .toJS()
  - .AsyncAPIDocument ⇐ Base
    - instance
      - .version() ⇒ string
      - .info() ⇒ Info
      - .id() ⇒ string
      - .hasServers() ⇒ boolean
      - .servers() ⇒ Object.<string, Server>
      - .serverNames() ⇒ Array.<string>
      - .server(name) ⇒ Server
      - .hasDefaultContentType() ⇒ boolean
      - .defaultContentType() ⇒ string | null
      - .hasChannels() ⇒ boolean
      - .channels() ⇒ Object.<string, Channel>
      - .channelNames() ⇒ Array.<string>
      - .channel(name) ⇒ Channel
      - .hasComponents() ⇒ boolean
      - .components() ⇒ Components
      - .hasMessages() ⇒ boolean
      - .allMessages() ⇒ Map.<string, Message>
      - .allSchemas() ⇒ Map.<string, Schema>
      - .hasCircular() ⇒ boolean
      - .traverseSchemas(callback, schemaTypesToIterate)
      - .hasTags() ⇒ boolean
      - .tags() ⇒ Array.<Tag>
      - .tagNames() ⇒ Array.<string>
      - .hasTag(name) ⇒ boolean
      - .tag(name) ⇒ Tag | null
      - .hasExternalDocs() ⇒ boolean
      - .externalDocs() ⇒ ExternalDocs | null
      - .hasExtensions() ⇒ boolean
      - .extensions() ⇒ Object.<string, any>
      - .extensionKeys() ⇒ Array.<string>
      - .extKeys() ⇒ Array.<string>
      - .hasExtension(key) ⇒ boolean
      - .extension(key) ⇒ any
      - .hasExt(key) ⇒ boolean
      - .ext(key) ⇒ any
      - .hasTags() ⇒ boolean
      - .tags() ⇒ Array.<Tag>
      - .tagNames() ⇒ Array.<string>
      - .hasTag(name) ⇒ boolean
      - .tag(name) ⇒ Tag | null
      - .hasExternalDocs() ⇒ boolean
      - .externalDocs() ⇒ ExternalDocs | null
      - .hasExtensions() ⇒ boolean
      - .extensions() ⇒ Object.<string, any>
      - .extensionKeys() ⇒ Array.<string>
      - .extKeys() ⇒ Array.<string>
      - .hasExtension(key) ⇒ boolean
      - .extension(key) ⇒ any
      - .hasExt(key) ⇒ boolean
      - .ext(key) ⇒ any
    - static
      - .stringify(doc, [space]) ⇒ string
      - .parse(doc) ⇒ AsyncAPIDocument
  - .Base
    - .json([key]) ⇒ any
  - .ChannelParameter ⇐ Base
    - .location() ⇒ string
    - .schema() ⇒ Schema
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Channel ⇐ Base
    - .parameters() ⇒ Object.<string, ChannelParameter>
    - .parameter(name) ⇒ ChannelParameter
    - .hasParameters() ⇒ boolean
    - .hasServers() ⇒ boolean
    - .servers() ⇒ Array.<String>
    - .server(index) ⇒ String
    - .publish() ⇒ PublishOperation
    - .subscribe() ⇒ SubscribeOperation
    - .hasPublish() ⇒ boolean
    - .hasSubscribe() ⇒ boolean
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasBindings() ⇒ boolean
    - .bindings() ⇒ Object
    - .bindingProtocols() ⇒ Array.<string>
    - .hasBinding(name) ⇒ boolean
    - .binding(name) ⇒ Object | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Components ⇐ Base
    - .channels() ⇒ Object.<string, Channel>
    - .hasChannels() ⇒ boolean
    - .channel(name) ⇒ Channel
    - .messages() ⇒ Object.<string, Message>
    - .hasMessages() ⇒ boolean
    - .message(name) ⇒ Message
    - .schemas() ⇒ Object.<string, Schema>
    - .hasSchemas() ⇒ boolean
    - .schema(name) ⇒ Schema
    - .securitySchemes() ⇒ Object.<string, SecurityScheme>
    - .hasSecuritySchemes() ⇒ boolean
    - .securityScheme(name) ⇒ SecurityScheme
    - .servers() ⇒ Object.<string, Server>
    - .hasServers() ⇒ boolean
    - .server(name) ⇒ Server
    - .parameters() ⇒ Object.<string, ChannelParameter>
    - .hasParameters() ⇒ boolean
    - .parameter(name) ⇒ ChannelParameter
    - .correlationIds() ⇒ Object.<string, CorrelationId>
    - .hasCorrelationIds() ⇒ boolean
    - .correlationId(name) ⇒ CorrelationId
    - .operationTraits() ⇒ Object.<string, OperationTrait>
    - .hasOperationTraits() ⇒ boolean
    - .operationTrait(name) ⇒ OperationTrait
    - .messageTraits() ⇒ Object.<string, MessageTrait>
    - .hasMessageTraits() ⇒ boolean
    - .messageTrait(name) ⇒ MessageTrait
    - .serverVariables() ⇒ Object.<string, ServerVariable>
    - .hasServerVariables() ⇒ boolean
    - .serverVariable(name) ⇒ ServerVariable
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Contact ⇐ Base
    - .name() ⇒ string
    - .url() ⇒ string
    - .email() ⇒ string
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .CorrelationId ⇐ Base
    - .location() ⇒ string
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .ExternalDocs ⇐ Base
    - .url() ⇒ string
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Info ⇐ Base
    - .title() ⇒ string
    - .version() ⇒ string
    - .termsOfService() ⇒ string | undefined
    - .license() ⇒ License
    - .contact() ⇒ Contact
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .License ⇐ Base
    - .name() ⇒ string
    - .url() ⇒ string
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .MessageTrait ⇐ MessageTraitable
  - .MessageTraitable ⇐ Base
    - .headers() ⇒ Schema
    - .header(name) ⇒ Schema
    - .id() ⇒ string
    - .correlationId() ⇒ CorrelationId
    - .schemaFormat() ⇒ string
    - .contentType() ⇒ string
    - .name() ⇒ string
    - .title() ⇒ string
    - .summary() ⇒ string
    - .examples() ⇒ Array.<any>
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasTags() ⇒ boolean
    - .tags() ⇒ Array.<Tag>
    - .tagNames() ⇒ Array.<string>
    - .hasTag(name) ⇒ boolean
    - .tag(name) ⇒ Tag | null
    - .hasExternalDocs() ⇒ boolean
    - .externalDocs() ⇒ ExternalDocs | null
    - .hasBindings() ⇒ boolean
    - .bindings() ⇒ Object
    - .bindingProtocols() ⇒ Array.<string>
    - .hasBinding(name) ⇒ boolean
    - .binding(name) ⇒ Object | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Message ⇐ MessageTraitable
    - .uid() ⇒ string
    - .payload() ⇒ Schema
    - .traits() ⇒ Array.<MessageTrait>
    - .hasTraits() ⇒ boolean
    - .originalPayload() ⇒ any
    - .originalSchemaFormat() ⇒ string
  - .OAuthFlow ⇐ Base
    - .authorizationUrl() ⇒ string
    - .tokenUrl() ⇒ string
    - .refreshUrl() ⇒ string
    - .scopes() ⇒ Object.<string, string>
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .OperationSecurityRequirement ⇐ Base
  - .OperationTrait ⇐ OperationTraitable
  - .OperationTraitable ⇐ Base
    - .id() ⇒ string
    - .summary() ⇒ string
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasTags() ⇒ boolean
    - .tags() ⇒ Array.<Tag>
    - .tagNames() ⇒ Array.<string>
    - .hasTag(name) ⇒ boolean
    - .tag(name) ⇒ Tag | null
    - .hasExternalDocs() ⇒ boolean
    - .externalDocs() ⇒ ExternalDocs | null
    - .hasBindings() ⇒ boolean
    - .bindings() ⇒ Object
    - .bindingProtocols() ⇒ Array.<string>
    - .hasBinding(name) ⇒ boolean
    - .binding(name) ⇒ Object | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Operation ⇐ OperationTraitable
    - .hasMultipleMessages() ⇒ boolean
    - .traits() ⇒ Array.<OperationTrait>
    - .hasTraits() ⇒ boolean
    - .messages() ⇒ Array.<Message>
    - .message() ⇒ Message
    - .security() ⇒ Array.<OperationSecurityRequirement>
  - .PublishOperation ⇐ Operation
    - .isPublish() ⇒ boolean
    - .isSubscribe() ⇒ boolean
    - .kind() ⇒ string
  - .Schema ⇐ Base
    - new Schema(json, [options])
    - .uid() ⇒ string
    - .$id() ⇒ string
    - .multipleOf() ⇒ number
    - .maximum() ⇒ number
    - .exclusiveMaximum() ⇒ number
    - .minimum() ⇒ number
    - .exclusiveMinimum() ⇒ number
    - .maxLength() ⇒ number
    - .minLength() ⇒ number
    - .pattern() ⇒ string
    - .maxItems() ⇒ number
    - .minItems() ⇒ number
    - .uniqueItems() ⇒ boolean
    - .maxProperties() ⇒ number
    - .minProperties() ⇒ number
    - .required() ⇒ Array.<string>
    - .enum() ⇒ Array.<any>
    - .type() ⇒ string | Array.<string>
    - .allOf() ⇒ Array.<Schema>
    - .oneOf() ⇒ Array.<Schema>
    - .anyOf() ⇒ Array.<Schema>
    - .not() ⇒ Schema
    - .items() ⇒ Schema | Array.<Schema>
    - .properties() ⇒ Object.<string, Schema>
    - .property(name) ⇒ Schema
    - .additionalProperties() ⇒ boolean | Schema
    - .additionalItems() ⇒ Schema
    - .patternProperties() ⇒ Object.<string, Schema>
    - .const() ⇒ any
    - .contains() ⇒ Schema
    - .dependencies() ⇒ Object.<string, (Schema|Array.<string>)>
    - .propertyNames() ⇒ Schema
    - .if() ⇒ Schema
    - .then() ⇒ Schema
    - .else() ⇒ Schema
    - .format() ⇒ string
    - .contentEncoding() ⇒ string
    - .contentMediaType() ⇒ string
    - .definitions() ⇒ Object.<string, Schema>
    - .title() ⇒ string
    - .default() ⇒ any
    - .deprecated() ⇒ boolean
    - .discriminator() ⇒ string
    - .readOnly() ⇒ boolean
    - .writeOnly() ⇒ boolean
    - .examples() ⇒ Array.<any>
    - .isBooleanSchema() ⇒ boolean
    - .isCircular() ⇒ boolean
    - .circularSchema() ⇒ Schema
    - ~~.hasCircularProps() ⇒ boolean~~
    - ~~.circularProps() ⇒ Array.<string>~~
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExternalDocs() ⇒ boolean
    - .externalDocs() ⇒ ExternalDocs | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExternalDocs() ⇒ boolean
    - .externalDocs() ⇒ ExternalDocs | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .SecurityScheme ⇐ Base
    - .type() ⇒ string
    - .name() ⇒ string
    - .in() ⇒ string
    - .scheme() ⇒ string
    - .bearerFormat() ⇒ string
    - .openIdConnectUrl() ⇒ string
    - .flows() ⇒ Object.<string, OAuthFlow>
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .ServerSecurityRequirement ⇐ Base
  - .ServerVariable ⇐ Base
    - .allowedValues() ⇒ Array.<any>
    - .allows(name) ⇒ boolean
    - .hasAllowedValues() ⇒ boolean
    - .defaultValue() ⇒ string
    - .hasDefaultValue() ⇒ boolean
    - .examples() ⇒ Array.<string>
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
  - .Server ⇐ Base
    - .url() ⇒ string
    - .protocol() ⇒ string
    - .protocolVersion() ⇒ string
    - .variables() ⇒ Object.<string, ServerVariable>
    - .variable(name) ⇒ ServerVariable
    - .hasVariables() ⇒ boolean
    - .security() ⇒ Array.<ServerSecurityRequirement>
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasBindings() ⇒ boolean
    - .bindings() ⇒ Object
    - .bindingProtocols() ⇒ Array.<string>
    - .hasBinding(name) ⇒ boolean
    - .binding(name) ⇒ Object | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
    - .hasTags() ⇒ boolean
    - .tags() ⇒ Array.<Tag>
    - .tagNames() ⇒ Array.<string>
    - .hasTag(name) ⇒ boolean
    - .tag(name) ⇒ Tag | null
  - .SubscribeOperation ⇐ Operation
    - .isPublish() ⇒ boolean
    - .isSubscribe() ⇒ boolean
    - .kind() ⇒ string
  - .Tag ⇐ Base
    - .name() ⇒ string
    - .hasDescription() ⇒ boolean
    - .description() ⇒ string | null
    - .hasExternalDocs() ⇒ boolean
    - .externalDocs() ⇒ ExternalDocs | null
    - .hasExtensions() ⇒ boolean
    - .extensions() ⇒ Object.<string, any>
    - .extensionKeys() ⇒ Array.<string>
    - .extKeys() ⇒ Array.<string>
    - .hasExtension(key) ⇒ boolean
    - .extension(key) ⇒ any
    - .hasExt(key) ⇒ boolean
    - .ext(key) ⇒ any
- static
  - .TraverseSchemas ⇒ boolean
- inner
  - ~parse(asyncapiYAMLorJSON, [options]) ⇒ Promise.<AsyncAPIDocument>
  - ~parseFromUrl(url, [fetchOptions], [options]) ⇒ Promise.<AsyncAPIDocument>
  - ~registerSchemaParser(parserModule)
  - ~ParserOptions : Object

@asyncapi/parser.ParserError ⇐ `Error`

Represents an error while trying to parse an AsyncAPI document.

Kind: instance class of @asyncapi/parser
Extends: Error

.ParserError ⇐ Error
- new ParserError(definition)
- .toJS()

new ParserError(definition)

Instantiates an error

Param	Type	Description
definition	`Object`
definition.type	`String`	The type of the error.
definition.title	`String`	The message of the error.
[definition.detail]	`String`	A string containing more detailed information about the error.
[definition.parsedJSON]	`Object`	The resulting JSON after YAML transformation. Or the JSON object if the this was the initial format.
[definition.validationErrors]	`Array.<Object>`	The errors resulting from the validation. For more information, see https://www.npmjs.com/package/better-ajv-errors.
definition.validationErrors.title	`String`	A validation error message.
definition.validationErrors.jsonPointer	`String`	The path to the field that contains the error. Uses JSON Pointer format.
definition.validationErrors.startLine	`Number`	The line where the error starts in the AsyncAPI document.
definition.validationErrors.startColumn	`Number`	The column where the error starts in the AsyncAPI document.
definition.validationErrors.startOffset	`Number`	The offset (starting from the beginning of the document) where the error starts in the AsyncAPI document.
definition.validationErrors.endLine	`Number`	The line where the error ends in the AsyncAPI document.
definition.validationErrors.endColumn	`Number`	The column where the error ends in the AsyncAPI document.
definition.validationErrors.endOffset	`Number`	The offset (starting from the beginning of the document) where the error ends in the AsyncAPI document.
[definition.location]	`Object`	Error location details after trying to parse an invalid JSON or YAML document.
definition.location.startLine	`Number`	The line of the YAML/JSON document where the error starts.
definition.location.startColumn	`Number`	The column of the YAML/JSON document where the error starts.
definition.location.startOffset	`Number`	The offset (starting from the beginning of the document) where the error starts in the YAML/JSON AsyncAPI document.
[definition.refs]	`Array.<Object>`	Error details after trying to resolve $ref's.
definition.refs.title	`String`	A validation error message.
definition.refs.jsonPointer	`String`	The path to the field that contains the error. Uses JSON Pointer format.
definition.refs.startLine	`Number`	The line where the error starts in the AsyncAPI document.
definition.refs.startColumn	`Number`	The column where the error starts in the AsyncAPI document.
definition.refs.startOffset	`Number`	The offset (starting from the beginning of the document) where the error starts in the AsyncAPI document.
definition.refs.endLine	`Number`	The line where the error ends in the AsyncAPI document.
definition.refs.endColumn	`Number`	The column where the error ends in the AsyncAPI document.
definition.refs.endOffset	`Number`	The offset (starting from the beginning of the document) where the error ends in the AsyncAPI document.

parserError.toJS()

Returns a JS object representation of the error.

Kind: instance method of ParserError

@asyncapi/parser.AsyncAPIDocument ⇐ `Base`

Implements functions to deal with the AsyncAPI document.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinTags, MixinExternalDocs, MixinSpecificationExtensions

.AsyncAPIDocument ⇐ Base
- instance
  - .version() ⇒ string
  - .info() ⇒ Info
  - .id() ⇒ string
  - .hasServers() ⇒ boolean
  - .servers() ⇒ Object.<string, Server>
  - .serverNames() ⇒ Array.<string>
  - .server(name) ⇒ Server
  - .hasDefaultContentType() ⇒ boolean
  - .defaultContentType() ⇒ string | null
  - .hasChannels() ⇒ boolean
  - .channels() ⇒ Object.<string, Channel>
  - .channelNames() ⇒ Array.<string>
  - .channel(name) ⇒ Channel
  - .hasComponents() ⇒ boolean
  - .components() ⇒ Components
  - .hasMessages() ⇒ boolean
  - .allMessages() ⇒ Map.<string, Message>
  - .allSchemas() ⇒ Map.<string, Schema>
  - .hasCircular() ⇒ boolean
  - .traverseSchemas(callback, schemaTypesToIterate)
  - .hasTags() ⇒ boolean
  - .tags() ⇒ Array.<Tag>
  - .tagNames() ⇒ Array.<string>
  - .hasTag(name) ⇒ boolean
  - .tag(name) ⇒ Tag | null
  - .hasExternalDocs() ⇒ boolean
  - .externalDocs() ⇒ ExternalDocs | null
  - .hasExtensions() ⇒ boolean
  - .extensions() ⇒ Object.<string, any>
  - .extensionKeys() ⇒ Array.<string>
  - .extKeys() ⇒ Array.<string>
  - .hasExtension(key) ⇒ boolean
  - .extension(key) ⇒ any
  - .hasExt(key) ⇒ boolean
  - .ext(key) ⇒ any
  - .hasTags() ⇒ boolean
  - .tags() ⇒ Array.<Tag>
  - .tagNames() ⇒ Array.<string>
  - .hasTag(name) ⇒ boolean
  - .tag(name) ⇒ Tag | null
  - .hasExternalDocs() ⇒ boolean
  - .externalDocs() ⇒ ExternalDocs | null
  - .hasExtensions() ⇒ boolean
  - .extensions() ⇒ Object.<string, any>
  - .extensionKeys() ⇒ Array.<string>
  - .extKeys() ⇒ Array.<string>
  - .hasExtension(key) ⇒ boolean
  - .extension(key) ⇒ any
  - .hasExt(key) ⇒ boolean
  - .ext(key) ⇒ any
- static
  - .stringify(doc, [space]) ⇒ string
  - .parse(doc) ⇒ AsyncAPIDocument

asyncAPIDocument.version() ⇒ `string`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.info() ⇒ `Info`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.id() ⇒ `string`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.hasServers() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.servers() ⇒ `Object.<string, Server>`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.serverNames() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.server(name) ⇒ `Server`

Kind: instance method of AsyncAPIDocument

Param	Type	Description
name	`string`	Name of the server.

asyncAPIDocument.hasDefaultContentType() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.defaultContentType() ⇒ `string` | `null`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.hasChannels() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.channels() ⇒ `Object.<string, Channel>`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.channelNames() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.channel(name) ⇒ `Channel`

Kind: instance method of AsyncAPIDocument

Param	Type	Description
name	`string`	Name of the channel.

asyncAPIDocument.hasComponents() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.components() ⇒ `Components`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.hasMessages() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.allMessages() ⇒ `Map.<string, Message>`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.allSchemas() ⇒ `Map.<string, Schema>`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.hasCircular() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument

asyncAPIDocument.traverseSchemas(callback, schemaTypesToIterate)

Traverse schemas in the document and select which types of schemas to include. By default all schemas are iterated

Kind: instance method of AsyncAPIDocument

Param	Type
callback	`TraverseSchemas`
schemaTypesToIterate	`Array.<SchemaTypesToIterate>`

asyncAPIDocument.hasTags() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasTags

asyncAPIDocument.tags() ⇒ `Array.<Tag>`

Kind: instance method of AsyncAPIDocument
Mixes: tags

asyncAPIDocument.tagNames() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument
Mixes: tagNames

asyncAPIDocument.hasTag(name) ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasTag

Param	Type	Description
name	`string`	Name of the tag.

asyncAPIDocument.tag(name) ⇒ `Tag` | `null`

Kind: instance method of AsyncAPIDocument
Mixes: tag

Param	Type	Description
name	`string`	Name of the tag.

asyncAPIDocument.hasExternalDocs() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExternalDocs

asyncAPIDocument.externalDocs() ⇒ `ExternalDocs` | `null`

Kind: instance method of AsyncAPIDocument
Mixes: externalDocs

asyncAPIDocument.hasExtensions() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExtensions

asyncAPIDocument.extensions() ⇒ `Object.<string, any>`

Kind: instance method of AsyncAPIDocument
Mixes: extensions

asyncAPIDocument.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument
Mixes: extensionKeys

asyncAPIDocument.extKeys() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument
Mixes: extKeys

asyncAPIDocument.hasExtension(key) ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.extension(key) ⇒ `any`

Kind: instance method of AsyncAPIDocument
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.hasExt(key) ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.ext(key) ⇒ `any`

Kind: instance method of AsyncAPIDocument
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.hasTags() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasTags

asyncAPIDocument.tags() ⇒ `Array.<Tag>`

Kind: instance method of AsyncAPIDocument
Mixes: tags

asyncAPIDocument.tagNames() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument
Mixes: tagNames

asyncAPIDocument.hasTag(name) ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasTag

Param	Type	Description
name	`string`	Name of the tag.

asyncAPIDocument.tag(name) ⇒ `Tag` | `null`

Kind: instance method of AsyncAPIDocument
Mixes: tag

Param	Type	Description
name	`string`	Name of the tag.

asyncAPIDocument.hasExternalDocs() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExternalDocs

asyncAPIDocument.externalDocs() ⇒ `ExternalDocs` | `null`

Kind: instance method of AsyncAPIDocument
Mixes: externalDocs

asyncAPIDocument.hasExtensions() ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExtensions

asyncAPIDocument.extensions() ⇒ `Object.<string, any>`

Kind: instance method of AsyncAPIDocument
Mixes: extensions

asyncAPIDocument.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument
Mixes: extensionKeys

asyncAPIDocument.extKeys() ⇒ `Array.<string>`

Kind: instance method of AsyncAPIDocument
Mixes: extKeys

asyncAPIDocument.hasExtension(key) ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.extension(key) ⇒ `any`

Kind: instance method of AsyncAPIDocument
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.hasExt(key) ⇒ `boolean`

Kind: instance method of AsyncAPIDocument
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

asyncAPIDocument.ext(key) ⇒ `any`

Kind: instance method of AsyncAPIDocument
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

AsyncAPIDocument.stringify(doc, [space]) ⇒ `string`

Converts a valid AsyncAPI document to a JavaScript Object Notation (JSON) string. A stringified AsyncAPI document using this function should be parsed via the AsyncAPIDocument.parse() function - the JSON.parse() function is not compatible.

Kind: static method of AsyncAPIDocument

Param	Type	Description
doc	`AsyncAPIDocument`	A valid AsyncAPIDocument instance.
[space]	`number` \| `string`	Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.

AsyncAPIDocument.parse(doc) ⇒ `AsyncAPIDocument`

Converts a valid stringified AsyncAPIDocument instance into an AsyncAPIDocument instance.

Kind: static method of AsyncAPIDocument

Param	Type	Description
doc	`string`	A valid stringified AsyncAPIDocument instance.

@asyncapi/parser.Base

Implements common functionality for all the models.

Kind: instance class of @asyncapi/parser

base.json([key]) ⇒ `any`

Kind: instance method of Base

Param	Type	Description
[key]	`string`	A key to retrieve from the JSON object.

@asyncapi/parser.ChannelParameter ⇐ `Base`

Implements functions to deal with a ChannelParameter object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinSpecificationExtensions

.ChannelParameter ⇐ Base
- .location() ⇒ string
- .schema() ⇒ Schema
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

channelParameter.location() ⇒ `string`

Kind: instance method of ChannelParameter

channelParameter.schema() ⇒ `Schema`

Kind: instance method of ChannelParameter

channelParameter.hasDescription() ⇒ `boolean`

Kind: instance method of ChannelParameter
Mixes: hasDescription

channelParameter.description() ⇒ `string` | `null`

Kind: instance method of ChannelParameter
Mixes: description

channelParameter.hasExtensions() ⇒ `boolean`

Kind: instance method of ChannelParameter
Mixes: hasExtensions

channelParameter.extensions() ⇒ `Object.<string, any>`

Kind: instance method of ChannelParameter
Mixes: extensions

channelParameter.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of ChannelParameter
Mixes: extensionKeys

channelParameter.extKeys() ⇒ `Array.<string>`

Kind: instance method of ChannelParameter
Mixes: extKeys

channelParameter.hasExtension(key) ⇒ `boolean`

Kind: instance method of ChannelParameter
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

channelParameter.extension(key) ⇒ `any`

Kind: instance method of ChannelParameter
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

channelParameter.hasExt(key) ⇒ `boolean`

Kind: instance method of ChannelParameter
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

channelParameter.ext(key) ⇒ `any`

Kind: instance method of ChannelParameter
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.Channel ⇐ `Base`

Implements functions to deal with a Channel object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinBindings, MixinSpecificationExtensions

.Channel ⇐ Base
- .parameters() ⇒ Object.<string, ChannelParameter>
- .parameter(name) ⇒ ChannelParameter
- .hasParameters() ⇒ boolean
- .hasServers() ⇒ boolean
- .servers() ⇒ Array.<String>
- .server(index) ⇒ String
- .publish() ⇒ PublishOperation
- .subscribe() ⇒ SubscribeOperation
- .hasPublish() ⇒ boolean
- .hasSubscribe() ⇒ boolean
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasBindings() ⇒ boolean
- .bindings() ⇒ Object
- .bindingProtocols() ⇒ Array.<string>
- .hasBinding(name) ⇒ boolean
- .binding(name) ⇒ Object | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

channel.parameters() ⇒ `Object.<string, ChannelParameter>`

Kind: instance method of Channel

channel.parameter(name) ⇒ `ChannelParameter`

Kind: instance method of Channel

Param	Type	Description
name	`string`	Name of the parameter.

channel.hasParameters() ⇒ `boolean`

Kind: instance method of Channel

channel.hasServers() ⇒ `boolean`

Kind: instance method of Channel

channel.servers() ⇒ `Array.<String>`

Kind: instance method of Channel

channel.server(index) ⇒ `String`

Kind: instance method of Channel

Param	Type	Description
index	`number`	Index of the server.

channel.publish() ⇒ `PublishOperation`

Kind: instance method of Channel

channel.subscribe() ⇒ `SubscribeOperation`

Kind: instance method of Channel

channel.hasPublish() ⇒ `boolean`

Kind: instance method of Channel

channel.hasSubscribe() ⇒ `boolean`

Kind: instance method of Channel

channel.hasDescription() ⇒ `boolean`

Kind: instance method of Channel
Mixes: hasDescription

channel.description() ⇒ `string` | `null`

Kind: instance method of Channel
Mixes: description

channel.hasBindings() ⇒ `boolean`

Kind: instance method of Channel
Mixes: hasBindings

channel.bindings() ⇒ `Object`

Kind: instance method of Channel
Mixes: bindings

channel.bindingProtocols() ⇒ `Array.<string>`

Kind: instance method of Channel
Mixes: bindingProtocols

channel.hasBinding(name) ⇒ `boolean`

Kind: instance method of Channel
Mixes: hasBinding

Param	Type	Description
name	`string`	Name of the binding.

channel.binding(name) ⇒ `Object` | `null`

Kind: instance method of Channel
Mixes: binding

Param	Type	Description
name	`string`	Name of the binding.

channel.hasExtensions() ⇒ `boolean`

Kind: instance method of Channel
Mixes: hasExtensions

channel.extensions() ⇒ `Object.<string, any>`

Kind: instance method of Channel
Mixes: extensions

channel.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of Channel
Mixes: extensionKeys

channel.extKeys() ⇒ `Array.<string>`

Kind: instance method of Channel
Mixes: extKeys

channel.hasExtension(key) ⇒ `boolean`

Kind: instance method of Channel
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

channel.extension(key) ⇒ `any`

Kind: instance method of Channel
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

channel.hasExt(key) ⇒ `boolean`

Kind: instance method of Channel
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

channel.ext(key) ⇒ `any`

Kind: instance method of Channel
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.Components ⇐ `Base`

Implements functions to deal with a Components object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinSpecificationExtensions

.Components ⇐ Base
- .channels() ⇒ Object.<string, Channel>
- .hasChannels() ⇒ boolean
- .channel(name) ⇒ Channel
- .messages() ⇒ Object.<string, Message>
- .hasMessages() ⇒ boolean
- .message(name) ⇒ Message
- .schemas() ⇒ Object.<string, Schema>
- .hasSchemas() ⇒ boolean
- .schema(name) ⇒ Schema
- .securitySchemes() ⇒ Object.<string, SecurityScheme>
- .hasSecuritySchemes() ⇒ boolean
- .securityScheme(name) ⇒ SecurityScheme
- .servers() ⇒ Object.<string, Server>
- .hasServers() ⇒ boolean
- .server(name) ⇒ Server
- .parameters() ⇒ Object.<string, ChannelParameter>
- .hasParameters() ⇒ boolean
- .parameter(name) ⇒ ChannelParameter
- .correlationIds() ⇒ Object.<string, CorrelationId>
- .hasCorrelationIds() ⇒ boolean
- .correlationId(name) ⇒ CorrelationId
- .operationTraits() ⇒ Object.<string, OperationTrait>
- .hasOperationTraits() ⇒ boolean
- .operationTrait(name) ⇒ OperationTrait
- .messageTraits() ⇒ Object.<string, MessageTrait>
- .hasMessageTraits() ⇒ boolean
- .messageTrait(name) ⇒ MessageTrait
- .serverVariables() ⇒ Object.<string, ServerVariable>
- .hasServerVariables() ⇒ boolean
- .serverVariable(name) ⇒ ServerVariable
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

components.channels() ⇒ `Object.<string, Channel>`

Kind: instance method of Components

components.hasChannels() ⇒ `boolean`

Kind: instance method of Components

components.channel(name) ⇒ `Channel`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the channel.

components.messages() ⇒ `Object.<string, Message>`

Kind: instance method of Components

components.hasMessages() ⇒ `boolean`

Kind: instance method of Components

components.message(name) ⇒ `Message`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the message.

components.schemas() ⇒ `Object.<string, Schema>`

Kind: instance method of Components

components.hasSchemas() ⇒ `boolean`

Kind: instance method of Components

components.schema(name) ⇒ `Schema`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the schema.

components.securitySchemes() ⇒ `Object.<string, SecurityScheme>`

Kind: instance method of Components

components.hasSecuritySchemes() ⇒ `boolean`

Kind: instance method of Components

components.securityScheme(name) ⇒ `SecurityScheme`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the security schema.

components.servers() ⇒ `Object.<string, Server>`

Kind: instance method of Components

components.hasServers() ⇒ `boolean`

Kind: instance method of Components

components.server(name) ⇒ `Server`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the server.

components.parameters() ⇒ `Object.<string, ChannelParameter>`

Kind: instance method of Components

components.hasParameters() ⇒ `boolean`

Kind: instance method of Components

components.parameter(name) ⇒ `ChannelParameter`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the channel parameter.

components.correlationIds() ⇒ `Object.<string, CorrelationId>`

Kind: instance method of Components

components.hasCorrelationIds() ⇒ `boolean`

Kind: instance method of Components

components.correlationId(name) ⇒ `CorrelationId`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the correlationId.

components.operationTraits() ⇒ `Object.<string, OperationTrait>`

Kind: instance method of Components

components.hasOperationTraits() ⇒ `boolean`

Kind: instance method of Components

components.operationTrait(name) ⇒ `OperationTrait`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the operation trait.

components.messageTraits() ⇒ `Object.<string, MessageTrait>`

Kind: instance method of Components

components.hasMessageTraits() ⇒ `boolean`

Kind: instance method of Components

components.messageTrait(name) ⇒ `MessageTrait`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the message trait.

components.serverVariables() ⇒ `Object.<string, ServerVariable>`

Kind: instance method of Components

components.hasServerVariables() ⇒ `boolean`

Kind: instance method of Components

components.serverVariable(name) ⇒ `ServerVariable`

Kind: instance method of Components

Param	Type	Description
name	`string`	Name of the server variable.

components.hasExtensions() ⇒ `boolean`

Kind: instance method of Components
Mixes: hasExtensions

components.extensions() ⇒ `Object.<string, any>`

Kind: instance method of Components
Mixes: extensions

components.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of Components
Mixes: extensionKeys

components.extKeys() ⇒ `Array.<string>`

Kind: instance method of Components
Mixes: extKeys

components.hasExtension(key) ⇒ `boolean`

Kind: instance method of Components
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

components.extension(key) ⇒ `any`

Kind: instance method of Components
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

components.hasExt(key) ⇒ `boolean`

Kind: instance method of Components
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

components.ext(key) ⇒ `any`

Kind: instance method of Components
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.Contact ⇐ `Base`

Implements functions to deal with the Contact object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinSpecificationExtensions

.Contact ⇐ Base
- .name() ⇒ string
- .url() ⇒ string
- .email() ⇒ string
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

contact.name() ⇒ `string`

Kind: instance method of Contact

contact.url() ⇒ `string`

Kind: instance method of Contact

contact.email() ⇒ `string`

Kind: instance method of Contact

contact.hasExtensions() ⇒ `boolean`

Kind: instance method of Contact
Mixes: hasExtensions

contact.extensions() ⇒ `Object.<string, any>`

Kind: instance method of Contact
Mixes: extensions

contact.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of Contact
Mixes: extensionKeys

contact.extKeys() ⇒ `Array.<string>`

Kind: instance method of Contact
Mixes: extKeys

contact.hasExtension(key) ⇒ `boolean`

Kind: instance method of Contact
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

contact.extension(key) ⇒ `any`

Kind: instance method of Contact
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

contact.hasExt(key) ⇒ `boolean`

Kind: instance method of Contact
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

contact.ext(key) ⇒ `any`

Kind: instance method of Contact
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.CorrelationId ⇐ `Base`

Implements functions to deal with a CorrelationId object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinSpecificationExtensions

.CorrelationId ⇐ Base
- .location() ⇒ string
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

correlationId.location() ⇒ `string`

Kind: instance method of CorrelationId

correlationId.hasDescription() ⇒ `boolean`

Kind: instance method of CorrelationId
Mixes: hasDescription

correlationId.description() ⇒ `string` | `null`

Kind: instance method of CorrelationId
Mixes: description

correlationId.hasExtensions() ⇒ `boolean`

Kind: instance method of CorrelationId
Mixes: hasExtensions

correlationId.extensions() ⇒ `Object.<string, any>`

Kind: instance method of CorrelationId
Mixes: extensions

correlationId.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of CorrelationId
Mixes: extensionKeys

correlationId.extKeys() ⇒ `Array.<string>`

Kind: instance method of CorrelationId
Mixes: extKeys

correlationId.hasExtension(key) ⇒ `boolean`

Kind: instance method of CorrelationId
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

correlationId.extension(key) ⇒ `any`

Kind: instance method of CorrelationId
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

correlationId.hasExt(key) ⇒ `boolean`

Kind: instance method of CorrelationId
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

correlationId.ext(key) ⇒ `any`

Kind: instance method of CorrelationId
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.ExternalDocs ⇐ `Base`

Implements functions to deal with an ExternalDocs object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinSpecificationExtensions

.ExternalDocs ⇐ Base
- .url() ⇒ string
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

externalDocs.url() ⇒ `string`

Kind: instance method of ExternalDocs

externalDocs.hasDescription() ⇒ `boolean`

Kind: instance method of ExternalDocs
Mixes: hasDescription

externalDocs.description() ⇒ `string` | `null`

Kind: instance method of ExternalDocs
Mixes: description

externalDocs.hasExtensions() ⇒ `boolean`

Kind: instance method of ExternalDocs
Mixes: hasExtensions

externalDocs.extensions() ⇒ `Object.<string, any>`

Kind: instance method of ExternalDocs
Mixes: extensions

externalDocs.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of ExternalDocs
Mixes: extensionKeys

externalDocs.extKeys() ⇒ `Array.<string>`

Kind: instance method of ExternalDocs
Mixes: extKeys

externalDocs.hasExtension(key) ⇒ `boolean`

Kind: instance method of ExternalDocs
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

externalDocs.extension(key) ⇒ `any`

Kind: instance method of ExternalDocs
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

externalDocs.hasExt(key) ⇒ `boolean`

Kind: instance method of ExternalDocs
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

externalDocs.ext(key) ⇒ `any`

Kind: instance method of ExternalDocs
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.Info ⇐ `Base`

Implements functions to deal with the Info object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinSpecificationExtensions

.Info ⇐ Base
- .title() ⇒ string
- .version() ⇒ string
- .termsOfService() ⇒ string | undefined
- .license() ⇒ License
- .contact() ⇒ Contact
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

info.title() ⇒ `string`

Kind: instance method of Info

info.version() ⇒ `string`

Kind: instance method of Info

info.termsOfService() ⇒ `string` | `undefined`

Kind: instance method of Info

info.license() ⇒ `License`

Kind: instance method of Info

info.contact() ⇒ `Contact`

Kind: instance method of Info

info.hasDescription() ⇒ `boolean`

Kind: instance method of Info
Mixes: hasDescription

info.description() ⇒ `string` | `null`

Kind: instance method of Info
Mixes: description

info.hasExtensions() ⇒ `boolean`

Kind: instance method of Info
Mixes: hasExtensions

info.extensions() ⇒ `Object.<string, any>`

Kind: instance method of Info
Mixes: extensions

info.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of Info
Mixes: extensionKeys

info.extKeys() ⇒ `Array.<string>`

Kind: instance method of Info
Mixes: extKeys

info.hasExtension(key) ⇒ `boolean`

Kind: instance method of Info
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

info.extension(key) ⇒ `any`

Kind: instance method of Info
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

info.hasExt(key) ⇒ `boolean`

Kind: instance method of Info
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

info.ext(key) ⇒ `any`

Kind: instance method of Info
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.License ⇐ `Base`

Implements functions to deal with the License object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinSpecificationExtensions

.License ⇐ Base
- .name() ⇒ string
- .url() ⇒ string
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

license.name() ⇒ `string`

Kind: instance method of License

license.url() ⇒ `string`

Kind: instance method of License

license.hasExtensions() ⇒ `boolean`

Kind: instance method of License
Mixes: hasExtensions

license.extensions() ⇒ `Object.<string, any>`

Kind: instance method of License
Mixes: extensions

license.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of License
Mixes: extensionKeys

license.extKeys() ⇒ `Array.<string>`

Kind: instance method of License
Mixes: extKeys

license.hasExtension(key) ⇒ `boolean`

Kind: instance method of License
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

license.extension(key) ⇒ `any`

Kind: instance method of License
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

license.hasExt(key) ⇒ `boolean`

Kind: instance method of License
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

license.ext(key) ⇒ `any`

Kind: instance method of License
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.MessageTrait ⇐ `MessageTraitable`

Implements functions to deal with a MessageTrait object.

Kind: instance class of @asyncapi/parser
Extends: MessageTraitable

@asyncapi/parser.MessageTraitable ⇐ `Base`

Implements functions to deal with a the common properties that Message and MessageTrait objects have.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinTags, MixinExternalDocs, MixinBindings, MixinSpecificationExtensions

.MessageTraitable ⇐ Base
- .headers() ⇒ Schema
- .header(name) ⇒ Schema
- .id() ⇒ string
- .correlationId() ⇒ CorrelationId
- .schemaFormat() ⇒ string
- .contentType() ⇒ string
- .name() ⇒ string
- .title() ⇒ string
- .summary() ⇒ string
- .examples() ⇒ Array.<any>
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasTags() ⇒ boolean
- .tags() ⇒ Array.<Tag>
- .tagNames() ⇒ Array.<string>
- .hasTag(name) ⇒ boolean
- .tag(name) ⇒ Tag | null
- .hasExternalDocs() ⇒ boolean
- .externalDocs() ⇒ ExternalDocs | null
- .hasBindings() ⇒ boolean
- .bindings() ⇒ Object
- .bindingProtocols() ⇒ Array.<string>
- .hasBinding(name) ⇒ boolean
- .binding(name) ⇒ Object | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

messageTraitable.headers() ⇒ `Schema`

Kind: instance method of MessageTraitable

messageTraitable.header(name) ⇒ `Schema`

Kind: instance method of MessageTraitable

Param	Type	Description
name	`string`	Name of the header.

messageTraitable.id() ⇒ `string`

Kind: instance method of MessageTraitable

messageTraitable.correlationId() ⇒ `CorrelationId`

Kind: instance method of MessageTraitable

messageTraitable.schemaFormat() ⇒ `string`

Kind: instance method of MessageTraitable

messageTraitable.contentType() ⇒ `string`

Kind: instance method of MessageTraitable

messageTraitable.name() ⇒ `string`

Kind: instance method of MessageTraitable

messageTraitable.title() ⇒ `string`

Kind: instance method of MessageTraitable

messageTraitable.summary() ⇒ `string`

Kind: instance method of MessageTraitable

messageTraitable.examples() ⇒ `Array.<any>`

Kind: instance method of MessageTraitable

messageTraitable.hasDescription() ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasDescription

messageTraitable.description() ⇒ `string` | `null`

Kind: instance method of MessageTraitable
Mixes: description

messageTraitable.hasTags() ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasTags

messageTraitable.tags() ⇒ `Array.<Tag>`

Kind: instance method of MessageTraitable
Mixes: tags

messageTraitable.tagNames() ⇒ `Array.<string>`

Kind: instance method of MessageTraitable
Mixes: tagNames

messageTraitable.hasTag(name) ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasTag

Param	Type	Description
name	`string`	Name of the tag.

messageTraitable.tag(name) ⇒ `Tag` | `null`

Kind: instance method of MessageTraitable
Mixes: tag

Param	Type	Description
name	`string`	Name of the tag.

messageTraitable.hasExternalDocs() ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasExternalDocs

messageTraitable.externalDocs() ⇒ `ExternalDocs` | `null`

Kind: instance method of MessageTraitable
Mixes: externalDocs

messageTraitable.hasBindings() ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasBindings

messageTraitable.bindings() ⇒ `Object`

Kind: instance method of MessageTraitable
Mixes: bindings

messageTraitable.bindingProtocols() ⇒ `Array.<string>`

Kind: instance method of MessageTraitable
Mixes: bindingProtocols

messageTraitable.hasBinding(name) ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasBinding

Param	Type	Description
name	`string`	Name of the binding.

messageTraitable.binding(name) ⇒ `Object` | `null`

Kind: instance method of MessageTraitable
Mixes: binding

Param	Type	Description
name	`string`	Name of the binding.

messageTraitable.hasExtensions() ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasExtensions

messageTraitable.extensions() ⇒ `Object.<string, any>`

Kind: instance method of MessageTraitable
Mixes: extensions

messageTraitable.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of MessageTraitable
Mixes: extensionKeys

messageTraitable.extKeys() ⇒ `Array.<string>`

Kind: instance method of MessageTraitable
Mixes: extKeys

messageTraitable.hasExtension(key) ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

messageTraitable.extension(key) ⇒ `any`

Kind: instance method of MessageTraitable
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

messageTraitable.hasExt(key) ⇒ `boolean`

Kind: instance method of MessageTraitable
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

messageTraitable.ext(key) ⇒ `any`

Kind: instance method of MessageTraitable
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.Message ⇐ `MessageTraitable`

Implements functions to deal with a Message object.

Kind: instance class of @asyncapi/parser
Extends: MessageTraitable

.Message ⇐ MessageTraitable
- .uid() ⇒ string
- .payload() ⇒ Schema
- .traits() ⇒ Array.<MessageTrait>
- .hasTraits() ⇒ boolean
- .originalPayload() ⇒ any
- .originalSchemaFormat() ⇒ string

message.uid() ⇒ `string`

Kind: instance method of Message

message.payload() ⇒ `Schema`

Kind: instance method of Message

message.traits() ⇒ `Array.<MessageTrait>`

Kind: instance method of Message

message.hasTraits() ⇒ `boolean`

Kind: instance method of Message

message.originalPayload() ⇒ `any`

Kind: instance method of Message

message.originalSchemaFormat() ⇒ `string`

Kind: instance method of Message

@asyncapi/parser.OAuthFlow ⇐ `Base`

Implements functions to deal with a OAuthFlow object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinSpecificationExtensions

.OAuthFlow ⇐ Base
- .authorizationUrl() ⇒ string
- .tokenUrl() ⇒ string
- .refreshUrl() ⇒ string
- .scopes() ⇒ Object.<string, string>
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

oAuthFlow.authorizationUrl() ⇒ `string`

Kind: instance method of OAuthFlow

oAuthFlow.tokenUrl() ⇒ `string`

Kind: instance method of OAuthFlow

oAuthFlow.refreshUrl() ⇒ `string`

Kind: instance method of OAuthFlow

oAuthFlow.scopes() ⇒ `Object.<string, string>`

Kind: instance method of OAuthFlow

oAuthFlow.hasExtensions() ⇒ `boolean`

Kind: instance method of OAuthFlow
Mixes: hasExtensions

oAuthFlow.extensions() ⇒ `Object.<string, any>`

Kind: instance method of OAuthFlow
Mixes: extensions

oAuthFlow.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of OAuthFlow
Mixes: extensionKeys

oAuthFlow.extKeys() ⇒ `Array.<string>`

Kind: instance method of OAuthFlow
Mixes: extKeys

oAuthFlow.hasExtension(key) ⇒ `boolean`

Kind: instance method of OAuthFlow
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

oAuthFlow.extension(key) ⇒ `any`

Kind: instance method of OAuthFlow
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

oAuthFlow.hasExt(key) ⇒ `boolean`

Kind: instance method of OAuthFlow
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

oAuthFlow.ext(key) ⇒ `any`

Kind: instance method of OAuthFlow
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.OperationSecurityRequirement ⇐ `Base`

Implements functions to deal with a OperationSecurityRequirement object.

Kind: instance class of @asyncapi/parser
Extends: Base

@asyncapi/parser.OperationTrait ⇐ `OperationTraitable`

Implements functions to deal with a OperationTrait object.

Kind: instance class of @asyncapi/parser
Extends: OperationTraitable

@asyncapi/parser.OperationTraitable ⇐ `Base`

Implements functions to deal with the common properties Operation and OperationTrait object have.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinTags, MixinExternalDocs, MixinBindings, MixinSpecificationExtensions

.OperationTraitable ⇐ Base
- .id() ⇒ string
- .summary() ⇒ string
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasTags() ⇒ boolean
- .tags() ⇒ Array.<Tag>
- .tagNames() ⇒ Array.<string>
- .hasTag(name) ⇒ boolean
- .tag(name) ⇒ Tag | null
- .hasExternalDocs() ⇒ boolean
- .externalDocs() ⇒ ExternalDocs | null
- .hasBindings() ⇒ boolean
- .bindings() ⇒ Object
- .bindingProtocols() ⇒ Array.<string>
- .hasBinding(name) ⇒ boolean
- .binding(name) ⇒ Object | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any

operationTraitable.id() ⇒ `string`

Kind: instance method of OperationTraitable

operationTraitable.summary() ⇒ `string`

Kind: instance method of OperationTraitable

operationTraitable.hasDescription() ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasDescription

operationTraitable.description() ⇒ `string` | `null`

Kind: instance method of OperationTraitable
Mixes: description

operationTraitable.hasTags() ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasTags

operationTraitable.tags() ⇒ `Array.<Tag>`

Kind: instance method of OperationTraitable
Mixes: tags

operationTraitable.tagNames() ⇒ `Array.<string>`

Kind: instance method of OperationTraitable
Mixes: tagNames

operationTraitable.hasTag(name) ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasTag

Param	Type	Description
name	`string`	Name of the tag.

operationTraitable.tag(name) ⇒ `Tag` | `null`

Kind: instance method of OperationTraitable
Mixes: tag

Param	Type	Description
name	`string`	Name of the tag.

operationTraitable.hasExternalDocs() ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasExternalDocs

operationTraitable.externalDocs() ⇒ `ExternalDocs` | `null`

Kind: instance method of OperationTraitable
Mixes: externalDocs

operationTraitable.hasBindings() ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasBindings

operationTraitable.bindings() ⇒ `Object`

Kind: instance method of OperationTraitable
Mixes: bindings

operationTraitable.bindingProtocols() ⇒ `Array.<string>`

Kind: instance method of OperationTraitable
Mixes: bindingProtocols

operationTraitable.hasBinding(name) ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasBinding

Param	Type	Description
name	`string`	Name of the binding.

operationTraitable.binding(name) ⇒ `Object` | `null`

Kind: instance method of OperationTraitable
Mixes: binding

Param	Type	Description
name	`string`	Name of the binding.

operationTraitable.hasExtensions() ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasExtensions

operationTraitable.extensions() ⇒ `Object.<string, any>`

Kind: instance method of OperationTraitable
Mixes: extensions

operationTraitable.extensionKeys() ⇒ `Array.<string>`

Kind: instance method of OperationTraitable
Mixes: extensionKeys

operationTraitable.extKeys() ⇒ `Array.<string>`

Kind: instance method of OperationTraitable
Mixes: extKeys

operationTraitable.hasExtension(key) ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasExtension

Param	Type	Description
key	`string`	Extension key.

operationTraitable.extension(key) ⇒ `any`

Kind: instance method of OperationTraitable
Mixes: extension

Param	Type	Description
key	`string`	Extension key.

operationTraitable.hasExt(key) ⇒ `boolean`

Kind: instance method of OperationTraitable
Mixes: hasExt

Param	Type	Description
key	`string`	Extension key.

operationTraitable.ext(key) ⇒ `any`

Kind: instance method of OperationTraitable
Mixes: ext

Param	Type	Description
key	`string`	Extension key.

@asyncapi/parser.Operation ⇐ `OperationTraitable`

Implements functions to deal with an Operation object.

Kind: instance class of @asyncapi/parser
Extends: OperationTraitable

.Operation ⇐ OperationTraitable
- .hasMultipleMessages() ⇒ boolean
- .traits() ⇒ Array.<OperationTrait>
- .hasTraits() ⇒ boolean
- .messages() ⇒ Array.<Message>
- .message() ⇒ Message
- .security() ⇒ Array.<OperationSecurityRequirement>

operation.hasMultipleMessages() ⇒ `boolean`

Kind: instance method of Operation

operation.traits() ⇒ `Array.<OperationTrait>`

Kind: instance method of Operation

operation.hasTraits() ⇒ `boolean`

Kind: instance method of Operation

operation.messages() ⇒ `Array.<Message>`

Kind: instance method of Operation

operation.message() ⇒ `Message`

Kind: instance method of Operation

operation.security() ⇒ `Array.<OperationSecurityRequirement>`

Kind: instance method of Operation

@asyncapi/parser.PublishOperation ⇐ `Operation`

Implements functions to deal with a PublishOperation object.

Kind: instance class of @asyncapi/parser
Extends: Operation

.PublishOperation ⇐ Operation
- .isPublish() ⇒ boolean
- .isSubscribe() ⇒ boolean
- .kind() ⇒ string

publishOperation.isPublish() ⇒ `boolean`

Kind: instance method of PublishOperation

publishOperation.isSubscribe() ⇒ `boolean`

Kind: instance method of PublishOperation

publishOperation.kind() ⇒ `string`

Kind: instance method of PublishOperation

@asyncapi/parser.Schema ⇐ `Base`

Implements functions to deal with a Schema object.

Kind: instance class of @asyncapi/parser
Extends: Base
Mixes: MixinDescription, MixinExternalDocs, MixinSpecificationExtensions

.Schema ⇐ Base
- new Schema(json, [options])
- .uid() ⇒ string
- .$id() ⇒ string
- .multipleOf() ⇒ number
- .maximum() ⇒ number
- .exclusiveMaximum() ⇒ number
- .minimum() ⇒ number
- .exclusiveMinimum() ⇒ number
- .maxLength() ⇒ number
- .minLength() ⇒ number
- .pattern() ⇒ string
- .maxItems() ⇒ number
- .minItems() ⇒ number
- .uniqueItems() ⇒ boolean
- .maxProperties() ⇒ number
- .minProperties() ⇒ number
- .required() ⇒ Array.<string>
- .enum() ⇒ Array.<any>
- .type() ⇒ string | Array.<string>
- .allOf() ⇒ Array.<Schema>
- .oneOf() ⇒ Array.<Schema>
- .anyOf() ⇒ Array.<Schema>
- .not() ⇒ Schema
- .items() ⇒ Schema | Array.<Schema>
- .properties() ⇒ Object.<string, Schema>
- .property(name) ⇒ Schema
- .additionalProperties() ⇒ boolean | Schema
- .additionalItems() ⇒ Schema
- .patternProperties() ⇒ Object.<string, Schema>
- .const() ⇒ any
- .contains() ⇒ Schema
- .dependencies() ⇒ Object.<string, (Schema|Array.<string>)>
- .propertyNames() ⇒ Schema
- .if() ⇒ Schema
- .then() ⇒ Schema
- .else() ⇒ Schema
- .format() ⇒ string
- .contentEncoding() ⇒ string
- .contentMediaType() ⇒ string
- .definitions() ⇒ Object.<string, Schema>
- .title() ⇒ string
- .default() ⇒ any
- .deprecated() ⇒ boolean
- .discriminator() ⇒ string
- .readOnly() ⇒ boolean
- .writeOnly() ⇒ boolean
- .examples() ⇒ Array.<any>
- .isBooleanSchema() ⇒ boolean
- .isCircular() ⇒ boolean
- .circularSchema() ⇒ Schema
- ~~.hasCircularProps() ⇒ boolean~~
- ~~.circularProps() ⇒ Array.<string>~~
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasExternalDocs() ⇒ boolean
- .externalDocs() ⇒ ExternalDocs | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any
- .hasDescription() ⇒ boolean
- .description() ⇒ string | null
- .hasExternalDocs() ⇒ boolean
- .externalDocs() ⇒ ExternalDocs | null
- .hasExtensions() ⇒ boolean
- .extensions() ⇒ Object.<string, any>
- .extensionKeys() ⇒ Array.<string>
- .extKeys() ⇒ Array.<string>
- .hasExtension(key) ⇒ boolean
- .extension(key) ⇒ any
- .hasExt(key) ⇒ boolean
- .ext(key) ⇒ any