## 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](#module_@asyncapi/parser) * _instance_ * [.ParserError](#module_@asyncapi/parser+ParserError) ⇐ Error * [new ParserError(definition)](#new_module_@asyncapi/parser+ParserError_new) * [.toJS()](#module_@asyncapi/parser+ParserError+toJS) * [.AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) ⇐ Base * _instance_ * [.version()](#module_@asyncapi/parser+AsyncAPIDocument+version) ⇒ string * [.info()](#module_@asyncapi/parser+AsyncAPIDocument+info) ⇒ Info * [.id()](#module_@asyncapi/parser+AsyncAPIDocument+id) ⇒ string * [.hasServers()](#module_@asyncapi/parser+AsyncAPIDocument+hasServers) ⇒ boolean * [.servers()](#module_@asyncapi/parser+AsyncAPIDocument+servers) ⇒ Object.<string, Server> * [.serverNames()](#module_@asyncapi/parser+AsyncAPIDocument+serverNames) ⇒ Array.<string> * [.server(name)](#module_@asyncapi/parser+AsyncAPIDocument+server) ⇒ Server * [.hasDefaultContentType()](#module_@asyncapi/parser+AsyncAPIDocument+hasDefaultContentType) ⇒ boolean * [.defaultContentType()](#module_@asyncapi/parser+AsyncAPIDocument+defaultContentType) ⇒ string \| null * [.hasChannels()](#module_@asyncapi/parser+AsyncAPIDocument+hasChannels) ⇒ boolean * [.channels()](#module_@asyncapi/parser+AsyncAPIDocument+channels) ⇒ Object.<string, Channel> * [.channelNames()](#module_@asyncapi/parser+AsyncAPIDocument+channelNames) ⇒ Array.<string> * [.channel(name)](#module_@asyncapi/parser+AsyncAPIDocument+channel) ⇒ Channel * [.hasComponents()](#module_@asyncapi/parser+AsyncAPIDocument+hasComponents) ⇒ boolean * [.components()](#module_@asyncapi/parser+AsyncAPIDocument+components) ⇒ Components * [.hasMessages()](#module_@asyncapi/parser+AsyncAPIDocument+hasMessages) ⇒ boolean * [.allMessages()](#module_@asyncapi/parser+AsyncAPIDocument+allMessages) ⇒ Map.<string, Message> * [.allSchemas()](#module_@asyncapi/parser+AsyncAPIDocument+allSchemas) ⇒ Map.<string, Schema> * [.hasCircular()](#module_@asyncapi/parser+AsyncAPIDocument+hasCircular) ⇒ boolean * [.traverseSchemas(callback, schemaTypesToIterate)](#module_@asyncapi/parser+AsyncAPIDocument+traverseSchemas) * [.hasTags()](#module_@asyncapi/parser+AsyncAPIDocument+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+AsyncAPIDocument+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+AsyncAPIDocument+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+AsyncAPIDocument+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+AsyncAPIDocument+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+AsyncAPIDocument+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+AsyncAPIDocument+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+AsyncAPIDocument+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+AsyncAPIDocument+ext) ⇒ any * [.hasTags()](#module_@asyncapi/parser+AsyncAPIDocument+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+AsyncAPIDocument+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+AsyncAPIDocument+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+AsyncAPIDocument+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+AsyncAPIDocument+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+AsyncAPIDocument+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+AsyncAPIDocument+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+AsyncAPIDocument+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+AsyncAPIDocument+ext) ⇒ any * _static_ * [.stringify(doc, [space])](#module_@asyncapi/parser+AsyncAPIDocument.stringify) ⇒ string * [.parse(doc)](#module_@asyncapi/parser+AsyncAPIDocument.parse) ⇒ AsyncAPIDocument * [.Base](#module_@asyncapi/parser+Base) * [.json([key])](#module_@asyncapi/parser+Base+json) ⇒ any * [.ChannelParameter](#module_@asyncapi/parser+ChannelParameter) ⇐ Base * [.location()](#module_@asyncapi/parser+ChannelParameter+location) ⇒ string * [.schema()](#module_@asyncapi/parser+ChannelParameter+schema) ⇒ Schema * [.hasDescription()](#module_@asyncapi/parser+ChannelParameter+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+ChannelParameter+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+ChannelParameter+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+ChannelParameter+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+ChannelParameter+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+ChannelParameter+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+ChannelParameter+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+ChannelParameter+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+ChannelParameter+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+ChannelParameter+ext) ⇒ any * [.Channel](#module_@asyncapi/parser+Channel) ⇐ Base * [.parameters()](#module_@asyncapi/parser+Channel+parameters) ⇒ Object.<string, ChannelParameter> * [.parameter(name)](#module_@asyncapi/parser+Channel+parameter) ⇒ ChannelParameter * [.hasParameters()](#module_@asyncapi/parser+Channel+hasParameters) ⇒ boolean * [.hasServers()](#module_@asyncapi/parser+Channel+hasServers) ⇒ boolean * [.servers()](#module_@asyncapi/parser+Channel+servers) ⇒ Array.<String> * [.server(index)](#module_@asyncapi/parser+Channel+server) ⇒ String * [.publish()](#module_@asyncapi/parser+Channel+publish) ⇒ PublishOperation * [.subscribe()](#module_@asyncapi/parser+Channel+subscribe) ⇒ SubscribeOperation * [.hasPublish()](#module_@asyncapi/parser+Channel+hasPublish) ⇒ boolean * [.hasSubscribe()](#module_@asyncapi/parser+Channel+hasSubscribe) ⇒ boolean * [.hasDescription()](#module_@asyncapi/parser+Channel+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Channel+description) ⇒ string \| null * [.hasBindings()](#module_@asyncapi/parser+Channel+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+Channel+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+Channel+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+Channel+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+Channel+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+Channel+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Channel+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Channel+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Channel+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Channel+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Channel+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Channel+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Channel+ext) ⇒ any * [.Components](#module_@asyncapi/parser+Components) ⇐ Base * [.channels()](#module_@asyncapi/parser+Components+channels) ⇒ Object.<string, Channel> * [.hasChannels()](#module_@asyncapi/parser+Components+hasChannels) ⇒ boolean * [.channel(name)](#module_@asyncapi/parser+Components+channel) ⇒ Channel * [.messages()](#module_@asyncapi/parser+Components+messages) ⇒ Object.<string, Message> * [.hasMessages()](#module_@asyncapi/parser+Components+hasMessages) ⇒ boolean * [.message(name)](#module_@asyncapi/parser+Components+message) ⇒ Message * [.schemas()](#module_@asyncapi/parser+Components+schemas) ⇒ Object.<string, Schema> * [.hasSchemas()](#module_@asyncapi/parser+Components+hasSchemas) ⇒ boolean * [.schema(name)](#module_@asyncapi/parser+Components+schema) ⇒ Schema * [.securitySchemes()](#module_@asyncapi/parser+Components+securitySchemes) ⇒ Object.<string, SecurityScheme> * [.hasSecuritySchemes()](#module_@asyncapi/parser+Components+hasSecuritySchemes) ⇒ boolean * [.securityScheme(name)](#module_@asyncapi/parser+Components+securityScheme) ⇒ SecurityScheme * [.servers()](#module_@asyncapi/parser+Components+servers) ⇒ Object.<string, Server> * [.hasServers()](#module_@asyncapi/parser+Components+hasServers) ⇒ boolean * [.server(name)](#module_@asyncapi/parser+Components+server) ⇒ Server * [.parameters()](#module_@asyncapi/parser+Components+parameters) ⇒ Object.<string, ChannelParameter> * [.hasParameters()](#module_@asyncapi/parser+Components+hasParameters) ⇒ boolean * [.parameter(name)](#module_@asyncapi/parser+Components+parameter) ⇒ ChannelParameter * [.correlationIds()](#module_@asyncapi/parser+Components+correlationIds) ⇒ Object.<string, CorrelationId> * [.hasCorrelationIds()](#module_@asyncapi/parser+Components+hasCorrelationIds) ⇒ boolean * [.correlationId(name)](#module_@asyncapi/parser+Components+correlationId) ⇒ CorrelationId * [.operationTraits()](#module_@asyncapi/parser+Components+operationTraits) ⇒ Object.<string, OperationTrait> * [.hasOperationTraits()](#module_@asyncapi/parser+Components+hasOperationTraits) ⇒ boolean * [.operationTrait(name)](#module_@asyncapi/parser+Components+operationTrait) ⇒ OperationTrait * [.messageTraits()](#module_@asyncapi/parser+Components+messageTraits) ⇒ Object.<string, MessageTrait> * [.hasMessageTraits()](#module_@asyncapi/parser+Components+hasMessageTraits) ⇒ boolean * [.messageTrait(name)](#module_@asyncapi/parser+Components+messageTrait) ⇒ MessageTrait * [.serverVariables()](#module_@asyncapi/parser+Components+serverVariables) ⇒ Object.<string, ServerVariable> * [.hasServerVariables()](#module_@asyncapi/parser+Components+hasServerVariables) ⇒ boolean * [.serverVariable(name)](#module_@asyncapi/parser+Components+serverVariable) ⇒ ServerVariable * [.hasExtensions()](#module_@asyncapi/parser+Components+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Components+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Components+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Components+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Components+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Components+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Components+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Components+ext) ⇒ any * [.Contact](#module_@asyncapi/parser+Contact) ⇐ Base * [.name()](#module_@asyncapi/parser+Contact+name) ⇒ string * [.url()](#module_@asyncapi/parser+Contact+url) ⇒ string * [.email()](#module_@asyncapi/parser+Contact+email) ⇒ string * [.hasExtensions()](#module_@asyncapi/parser+Contact+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Contact+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Contact+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Contact+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Contact+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Contact+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Contact+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Contact+ext) ⇒ any * [.CorrelationId](#module_@asyncapi/parser+CorrelationId) ⇐ Base * [.location()](#module_@asyncapi/parser+CorrelationId+location) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+CorrelationId+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+CorrelationId+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+CorrelationId+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+CorrelationId+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+CorrelationId+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+CorrelationId+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+CorrelationId+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+CorrelationId+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+CorrelationId+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+CorrelationId+ext) ⇒ any * [.ExternalDocs](#module_@asyncapi/parser+ExternalDocs) ⇐ Base * [.url()](#module_@asyncapi/parser+ExternalDocs+url) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+ExternalDocs+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+ExternalDocs+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+ExternalDocs+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+ExternalDocs+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+ExternalDocs+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+ExternalDocs+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+ExternalDocs+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+ExternalDocs+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+ExternalDocs+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+ExternalDocs+ext) ⇒ any * [.Info](#module_@asyncapi/parser+Info) ⇐ Base * [.title()](#module_@asyncapi/parser+Info+title) ⇒ string * [.version()](#module_@asyncapi/parser+Info+version) ⇒ string * [.termsOfService()](#module_@asyncapi/parser+Info+termsOfService) ⇒ string \| undefined * [.license()](#module_@asyncapi/parser+Info+license) ⇒ License * [.contact()](#module_@asyncapi/parser+Info+contact) ⇒ Contact * [.hasDescription()](#module_@asyncapi/parser+Info+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Info+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+Info+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Info+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Info+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Info+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Info+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Info+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Info+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Info+ext) ⇒ any * [.License](#module_@asyncapi/parser+License) ⇐ Base * [.name()](#module_@asyncapi/parser+License+name) ⇒ string * [.url()](#module_@asyncapi/parser+License+url) ⇒ string * [.hasExtensions()](#module_@asyncapi/parser+License+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+License+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+License+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+License+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+License+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+License+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+License+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+License+ext) ⇒ any * [.MessageTrait](#module_@asyncapi/parser+MessageTrait) ⇐ MessageTraitable * [.MessageTraitable](#module_@asyncapi/parser+MessageTraitable) ⇐ Base * [.headers()](#module_@asyncapi/parser+MessageTraitable+headers) ⇒ Schema * [.header(name)](#module_@asyncapi/parser+MessageTraitable+header) ⇒ Schema * [.id()](#module_@asyncapi/parser+MessageTraitable+id) ⇒ string * [.correlationId()](#module_@asyncapi/parser+MessageTraitable+correlationId) ⇒ CorrelationId * [.schemaFormat()](#module_@asyncapi/parser+MessageTraitable+schemaFormat) ⇒ string * [.contentType()](#module_@asyncapi/parser+MessageTraitable+contentType) ⇒ string * [.name()](#module_@asyncapi/parser+MessageTraitable+name) ⇒ string * [.title()](#module_@asyncapi/parser+MessageTraitable+title) ⇒ string * [.summary()](#module_@asyncapi/parser+MessageTraitable+summary) ⇒ string * [.examples()](#module_@asyncapi/parser+MessageTraitable+examples) ⇒ Array.<any> * [.hasDescription()](#module_@asyncapi/parser+MessageTraitable+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+MessageTraitable+description) ⇒ string \| null * [.hasTags()](#module_@asyncapi/parser+MessageTraitable+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+MessageTraitable+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+MessageTraitable+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+MessageTraitable+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+MessageTraitable+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+MessageTraitable+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+MessageTraitable+externalDocs) ⇒ ExternalDocs \| null * [.hasBindings()](#module_@asyncapi/parser+MessageTraitable+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+MessageTraitable+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+MessageTraitable+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+MessageTraitable+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+MessageTraitable+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+MessageTraitable+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+MessageTraitable+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+MessageTraitable+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+MessageTraitable+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+MessageTraitable+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+MessageTraitable+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+MessageTraitable+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+MessageTraitable+ext) ⇒ any * [.Message](#module_@asyncapi/parser+Message) ⇐ MessageTraitable * [.uid()](#module_@asyncapi/parser+Message+uid) ⇒ string * [.payload()](#module_@asyncapi/parser+Message+payload) ⇒ Schema * [.traits()](#module_@asyncapi/parser+Message+traits) ⇒ Array.<MessageTrait> * [.hasTraits()](#module_@asyncapi/parser+Message+hasTraits) ⇒ boolean * [.originalPayload()](#module_@asyncapi/parser+Message+originalPayload) ⇒ any * [.originalSchemaFormat()](#module_@asyncapi/parser+Message+originalSchemaFormat) ⇒ string * [.OAuthFlow](#module_@asyncapi/parser+OAuthFlow) ⇐ Base * [.authorizationUrl()](#module_@asyncapi/parser+OAuthFlow+authorizationUrl) ⇒ string * [.tokenUrl()](#module_@asyncapi/parser+OAuthFlow+tokenUrl) ⇒ string * [.refreshUrl()](#module_@asyncapi/parser+OAuthFlow+refreshUrl) ⇒ string * [.scopes()](#module_@asyncapi/parser+OAuthFlow+scopes) ⇒ Object.<string, string> * [.hasExtensions()](#module_@asyncapi/parser+OAuthFlow+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+OAuthFlow+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+OAuthFlow+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+OAuthFlow+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+OAuthFlow+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+OAuthFlow+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+OAuthFlow+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+OAuthFlow+ext) ⇒ any * [.OperationSecurityRequirement](#module_@asyncapi/parser+OperationSecurityRequirement) ⇐ Base * [.OperationTrait](#module_@asyncapi/parser+OperationTrait) ⇐ OperationTraitable * [.OperationTraitable](#module_@asyncapi/parser+OperationTraitable) ⇐ Base * [.id()](#module_@asyncapi/parser+OperationTraitable+id) ⇒ string * [.summary()](#module_@asyncapi/parser+OperationTraitable+summary) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+OperationTraitable+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+OperationTraitable+description) ⇒ string \| null * [.hasTags()](#module_@asyncapi/parser+OperationTraitable+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+OperationTraitable+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+OperationTraitable+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+OperationTraitable+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+OperationTraitable+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+OperationTraitable+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+OperationTraitable+externalDocs) ⇒ ExternalDocs \| null * [.hasBindings()](#module_@asyncapi/parser+OperationTraitable+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+OperationTraitable+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+OperationTraitable+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+OperationTraitable+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+OperationTraitable+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+OperationTraitable+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+OperationTraitable+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+OperationTraitable+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+OperationTraitable+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+OperationTraitable+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+OperationTraitable+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+OperationTraitable+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+OperationTraitable+ext) ⇒ any * [.Operation](#module_@asyncapi/parser+Operation) ⇐ OperationTraitable * [.hasMultipleMessages()](#module_@asyncapi/parser+Operation+hasMultipleMessages) ⇒ boolean * [.traits()](#module_@asyncapi/parser+Operation+traits) ⇒ Array.<OperationTrait> * [.hasTraits()](#module_@asyncapi/parser+Operation+hasTraits) ⇒ boolean * [.messages()](#module_@asyncapi/parser+Operation+messages) ⇒ Array.<Message> * [.message()](#module_@asyncapi/parser+Operation+message) ⇒ Message * [.security()](#module_@asyncapi/parser+Operation+security) ⇒ Array.<OperationSecurityRequirement> * [.PublishOperation](#module_@asyncapi/parser+PublishOperation) ⇐ Operation * [.isPublish()](#module_@asyncapi/parser+PublishOperation+isPublish) ⇒ boolean * [.isSubscribe()](#module_@asyncapi/parser+PublishOperation+isSubscribe) ⇒ boolean * [.kind()](#module_@asyncapi/parser+PublishOperation+kind) ⇒ string * [.Schema](#module_@asyncapi/parser+Schema) ⇐ Base * [new Schema(json, [options])](#new_module_@asyncapi/parser+Schema_new) * [.uid()](#module_@asyncapi/parser+Schema+uid) ⇒ string * [.$id()](#module_@asyncapi/parser+Schema+$id) ⇒ string * [.multipleOf()](#module_@asyncapi/parser+Schema+multipleOf) ⇒ number * [.maximum()](#module_@asyncapi/parser+Schema+maximum) ⇒ number * [.exclusiveMaximum()](#module_@asyncapi/parser+Schema+exclusiveMaximum) ⇒ number * [.minimum()](#module_@asyncapi/parser+Schema+minimum) ⇒ number * [.exclusiveMinimum()](#module_@asyncapi/parser+Schema+exclusiveMinimum) ⇒ number * [.maxLength()](#module_@asyncapi/parser+Schema+maxLength) ⇒ number * [.minLength()](#module_@asyncapi/parser+Schema+minLength) ⇒ number * [.pattern()](#module_@asyncapi/parser+Schema+pattern) ⇒ string * [.maxItems()](#module_@asyncapi/parser+Schema+maxItems) ⇒ number * [.minItems()](#module_@asyncapi/parser+Schema+minItems) ⇒ number * [.uniqueItems()](#module_@asyncapi/parser+Schema+uniqueItems) ⇒ boolean * [.maxProperties()](#module_@asyncapi/parser+Schema+maxProperties) ⇒ number * [.minProperties()](#module_@asyncapi/parser+Schema+minProperties) ⇒ number * [.required()](#module_@asyncapi/parser+Schema+required) ⇒ Array.<string> * [.enum()](#module_@asyncapi/parser+Schema+enum) ⇒ Array.<any> * [.type()](#module_@asyncapi/parser+Schema+type) ⇒ string \| Array.<string> * [.allOf()](#module_@asyncapi/parser+Schema+allOf) ⇒ Array.<Schema> * [.oneOf()](#module_@asyncapi/parser+Schema+oneOf) ⇒ Array.<Schema> * [.anyOf()](#module_@asyncapi/parser+Schema+anyOf) ⇒ Array.<Schema> * [.not()](#module_@asyncapi/parser+Schema+not) ⇒ Schema * [.items()](#module_@asyncapi/parser+Schema+items) ⇒ Schema \| Array.<Schema> * [.properties()](#module_@asyncapi/parser+Schema+properties) ⇒ Object.<string, Schema> * [.property(name)](#module_@asyncapi/parser+Schema+property) ⇒ Schema * [.additionalProperties()](#module_@asyncapi/parser+Schema+additionalProperties) ⇒ boolean \| Schema * [.additionalItems()](#module_@asyncapi/parser+Schema+additionalItems) ⇒ Schema * [.patternProperties()](#module_@asyncapi/parser+Schema+patternProperties) ⇒ Object.<string, Schema> * [.const()](#module_@asyncapi/parser+Schema+const) ⇒ any * [.contains()](#module_@asyncapi/parser+Schema+contains) ⇒ Schema * [.dependencies()](#module_@asyncapi/parser+Schema+dependencies) ⇒ Object.<string, (Schema\|Array.<string>)> * [.propertyNames()](#module_@asyncapi/parser+Schema+propertyNames) ⇒ Schema * [.if()](#module_@asyncapi/parser+Schema+if) ⇒ Schema * [.then()](#module_@asyncapi/parser+Schema+then) ⇒ Schema * [.else()](#module_@asyncapi/parser+Schema+else) ⇒ Schema * [.format()](#module_@asyncapi/parser+Schema+format) ⇒ string * [.contentEncoding()](#module_@asyncapi/parser+Schema+contentEncoding) ⇒ string * [.contentMediaType()](#module_@asyncapi/parser+Schema+contentMediaType) ⇒ string * [.definitions()](#module_@asyncapi/parser+Schema+definitions) ⇒ Object.<string, Schema> * [.title()](#module_@asyncapi/parser+Schema+title) ⇒ string * [.default()](#module_@asyncapi/parser+Schema+default) ⇒ any * [.deprecated()](#module_@asyncapi/parser+Schema+deprecated) ⇒ boolean * [.discriminator()](#module_@asyncapi/parser+Schema+discriminator) ⇒ string * [.readOnly()](#module_@asyncapi/parser+Schema+readOnly) ⇒ boolean * [.writeOnly()](#module_@asyncapi/parser+Schema+writeOnly) ⇒ boolean * [.examples()](#module_@asyncapi/parser+Schema+examples) ⇒ Array.<any> * [.isBooleanSchema()](#module_@asyncapi/parser+Schema+isBooleanSchema) ⇒ boolean * [.isCircular()](#module_@asyncapi/parser+Schema+isCircular) ⇒ boolean * [.circularSchema()](#module_@asyncapi/parser+Schema+circularSchema) ⇒ Schema * ~~[.hasCircularProps()](#module_@asyncapi/parser+Schema+hasCircularProps) ⇒ boolean~~ * ~~[.circularProps()](#module_@asyncapi/parser+Schema+circularProps) ⇒ Array.<string>~~ * [.hasDescription()](#module_@asyncapi/parser+Schema+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Schema+description) ⇒ string \| null * [.hasExternalDocs()](#module_@asyncapi/parser+Schema+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+Schema+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+Schema+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Schema+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Schema+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Schema+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Schema+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Schema+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Schema+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Schema+ext) ⇒ any * [.hasDescription()](#module_@asyncapi/parser+Schema+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Schema+description) ⇒ string \| null * [.hasExternalDocs()](#module_@asyncapi/parser+Schema+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+Schema+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+Schema+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Schema+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Schema+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Schema+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Schema+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Schema+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Schema+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Schema+ext) ⇒ any * [.SecurityScheme](#module_@asyncapi/parser+SecurityScheme) ⇐ Base * [.type()](#module_@asyncapi/parser+SecurityScheme+type) ⇒ string * [.name()](#module_@asyncapi/parser+SecurityScheme+name) ⇒ string * [.in()](#module_@asyncapi/parser+SecurityScheme+in) ⇒ string * [.scheme()](#module_@asyncapi/parser+SecurityScheme+scheme) ⇒ string * [.bearerFormat()](#module_@asyncapi/parser+SecurityScheme+bearerFormat) ⇒ string * [.openIdConnectUrl()](#module_@asyncapi/parser+SecurityScheme+openIdConnectUrl) ⇒ string * [.flows()](#module_@asyncapi/parser+SecurityScheme+flows) ⇒ Object.<string, OAuthFlow> * [.hasDescription()](#module_@asyncapi/parser+SecurityScheme+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+SecurityScheme+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+SecurityScheme+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+SecurityScheme+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+SecurityScheme+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+SecurityScheme+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+SecurityScheme+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+SecurityScheme+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+SecurityScheme+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+SecurityScheme+ext) ⇒ any * [.ServerSecurityRequirement](#module_@asyncapi/parser+ServerSecurityRequirement) ⇐ Base * [.ServerVariable](#module_@asyncapi/parser+ServerVariable) ⇐ Base * [.allowedValues()](#module_@asyncapi/parser+ServerVariable+allowedValues) ⇒ Array.<any> * [.allows(name)](#module_@asyncapi/parser+ServerVariable+allows) ⇒ boolean * [.hasAllowedValues()](#module_@asyncapi/parser+ServerVariable+hasAllowedValues) ⇒ boolean * [.defaultValue()](#module_@asyncapi/parser+ServerVariable+defaultValue) ⇒ string * [.hasDefaultValue()](#module_@asyncapi/parser+ServerVariable+hasDefaultValue) ⇒ boolean * [.examples()](#module_@asyncapi/parser+ServerVariable+examples) ⇒ Array.<string> * [.hasDescription()](#module_@asyncapi/parser+ServerVariable+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+ServerVariable+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+ServerVariable+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+ServerVariable+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+ServerVariable+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+ServerVariable+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+ServerVariable+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+ServerVariable+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+ServerVariable+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+ServerVariable+ext) ⇒ any * [.Server](#module_@asyncapi/parser+Server) ⇐ Base * [.url()](#module_@asyncapi/parser+Server+url) ⇒ string * [.protocol()](#module_@asyncapi/parser+Server+protocol) ⇒ string * [.protocolVersion()](#module_@asyncapi/parser+Server+protocolVersion) ⇒ string * [.variables()](#module_@asyncapi/parser+Server+variables) ⇒ Object.<string, ServerVariable> * [.variable(name)](#module_@asyncapi/parser+Server+variable) ⇒ ServerVariable * [.hasVariables()](#module_@asyncapi/parser+Server+hasVariables) ⇒ boolean * [.security()](#module_@asyncapi/parser+Server+security) ⇒ Array.<ServerSecurityRequirement> * [.hasDescription()](#module_@asyncapi/parser+Server+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Server+description) ⇒ string \| null * [.hasBindings()](#module_@asyncapi/parser+Server+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+Server+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+Server+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+Server+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+Server+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+Server+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Server+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Server+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Server+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Server+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Server+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Server+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Server+ext) ⇒ any * [.hasTags()](#module_@asyncapi/parser+Server+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+Server+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+Server+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+Server+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+Server+tag) ⇒ Tag \| null * [.SubscribeOperation](#module_@asyncapi/parser+SubscribeOperation) ⇐ Operation * [.isPublish()](#module_@asyncapi/parser+SubscribeOperation+isPublish) ⇒ boolean * [.isSubscribe()](#module_@asyncapi/parser+SubscribeOperation+isSubscribe) ⇒ boolean * [.kind()](#module_@asyncapi/parser+SubscribeOperation+kind) ⇒ string * [.Tag](#module_@asyncapi/parser+Tag) ⇐ Base * [.name()](#module_@asyncapi/parser+Tag+name) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+Tag+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Tag+description) ⇒ string \| null * [.hasExternalDocs()](#module_@asyncapi/parser+Tag+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+Tag+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+Tag+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Tag+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Tag+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Tag+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Tag+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Tag+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Tag+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Tag+ext) ⇒ any * _static_ * [.TraverseSchemas](#module_@asyncapi/parser.TraverseSchemas) ⇒ boolean * _inner_ * [~parse(asyncapiYAMLorJSON, [options])](#module_@asyncapi/parser..parse) ⇒ Promise.<AsyncAPIDocument> * [~parseFromUrl(url, [fetchOptions], [options])](#module_@asyncapi/parser..parseFromUrl) ⇒ Promise.<AsyncAPIDocument> * [~registerSchemaParser(parserModule)](#module_@asyncapi/parser..registerSchemaParser) * [~ParserOptions](#module_@asyncapi/parser..ParserOptions) : Object ### @asyncapi/parser.ParserError ⇐ Error Represents an error while trying to parse an AsyncAPI document. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Error * [.ParserError](#module_@asyncapi/parser+ParserError) ⇐ Error * [new ParserError(definition)](#new_module_@asyncapi/parser+ParserError_new) * [.toJS()](#module_@asyncapi/parser+ParserError+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](#module_@asyncapi/parser+ParserError) ### @asyncapi/parser.AsyncAPIDocument ⇐ Base Implements functions to deal with the AsyncAPI document. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinTags](#MixinTags), [MixinExternalDocs](#MixinExternalDocs), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) ⇐ Base * _instance_ * [.version()](#module_@asyncapi/parser+AsyncAPIDocument+version) ⇒ string * [.info()](#module_@asyncapi/parser+AsyncAPIDocument+info) ⇒ Info * [.id()](#module_@asyncapi/parser+AsyncAPIDocument+id) ⇒ string * [.hasServers()](#module_@asyncapi/parser+AsyncAPIDocument+hasServers) ⇒ boolean * [.servers()](#module_@asyncapi/parser+AsyncAPIDocument+servers) ⇒ Object.<string, Server> * [.serverNames()](#module_@asyncapi/parser+AsyncAPIDocument+serverNames) ⇒ Array.<string> * [.server(name)](#module_@asyncapi/parser+AsyncAPIDocument+server) ⇒ Server * [.hasDefaultContentType()](#module_@asyncapi/parser+AsyncAPIDocument+hasDefaultContentType) ⇒ boolean * [.defaultContentType()](#module_@asyncapi/parser+AsyncAPIDocument+defaultContentType) ⇒ string \| null * [.hasChannels()](#module_@asyncapi/parser+AsyncAPIDocument+hasChannels) ⇒ boolean * [.channels()](#module_@asyncapi/parser+AsyncAPIDocument+channels) ⇒ Object.<string, Channel> * [.channelNames()](#module_@asyncapi/parser+AsyncAPIDocument+channelNames) ⇒ Array.<string> * [.channel(name)](#module_@asyncapi/parser+AsyncAPIDocument+channel) ⇒ Channel * [.hasComponents()](#module_@asyncapi/parser+AsyncAPIDocument+hasComponents) ⇒ boolean * [.components()](#module_@asyncapi/parser+AsyncAPIDocument+components) ⇒ Components * [.hasMessages()](#module_@asyncapi/parser+AsyncAPIDocument+hasMessages) ⇒ boolean * [.allMessages()](#module_@asyncapi/parser+AsyncAPIDocument+allMessages) ⇒ Map.<string, Message> * [.allSchemas()](#module_@asyncapi/parser+AsyncAPIDocument+allSchemas) ⇒ Map.<string, Schema> * [.hasCircular()](#module_@asyncapi/parser+AsyncAPIDocument+hasCircular) ⇒ boolean * [.traverseSchemas(callback, schemaTypesToIterate)](#module_@asyncapi/parser+AsyncAPIDocument+traverseSchemas) * [.hasTags()](#module_@asyncapi/parser+AsyncAPIDocument+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+AsyncAPIDocument+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+AsyncAPIDocument+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+AsyncAPIDocument+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+AsyncAPIDocument+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+AsyncAPIDocument+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+AsyncAPIDocument+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+AsyncAPIDocument+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+AsyncAPIDocument+ext) ⇒ any * [.hasTags()](#module_@asyncapi/parser+AsyncAPIDocument+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+AsyncAPIDocument+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+AsyncAPIDocument+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+AsyncAPIDocument+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+AsyncAPIDocument+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+AsyncAPIDocument+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+AsyncAPIDocument+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+AsyncAPIDocument+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+AsyncAPIDocument+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+AsyncAPIDocument+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+AsyncAPIDocument+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+AsyncAPIDocument+ext) ⇒ any * _static_ * [.stringify(doc, [space])](#module_@asyncapi/parser+AsyncAPIDocument.stringify) ⇒ string * [.parse(doc)](#module_@asyncapi/parser+AsyncAPIDocument.parse) ⇒ AsyncAPIDocument #### asyncAPIDocument.version() ⇒ string **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.info() ⇒ Info **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.id() ⇒ string **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.hasServers() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.servers() ⇒ Object.<string, Server> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.serverNames() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.server(name) ⇒ Server **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the server. | #### asyncAPIDocument.hasDefaultContentType() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.defaultContentType() ⇒ string \| null **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.hasChannels() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.channels() ⇒ Object.<string, Channel> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.channelNames() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.channel(name) ⇒ Channel **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the channel. | #### asyncAPIDocument.hasComponents() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.components() ⇒ Components **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.hasMessages() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.allMessages() ⇒ Map.<string, Message> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.allSchemas() ⇒ Map.<string, Schema> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) #### asyncAPIDocument.hasCircular() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+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](#module_@asyncapi/parser+AsyncAPIDocument) | Param | Type | | --- | --- | | callback | TraverseSchemas | | schemaTypesToIterate | [Array.<SchemaTypesToIterate>](#SchemaTypesToIterate) | #### asyncAPIDocument.hasTags() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasTags](#MixinTags.hasTags) #### asyncAPIDocument.tags() ⇒ Array.<Tag> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [tags](#MixinTags.tags) #### asyncAPIDocument.tagNames() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [tagNames](#MixinTags.tagNames) #### asyncAPIDocument.hasTag(name) ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasTag](#MixinTags.hasTag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### asyncAPIDocument.tag(name) ⇒ Tag \| null **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [tag](#MixinTags.tag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### asyncAPIDocument.hasExternalDocs() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### asyncAPIDocument.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### asyncAPIDocument.hasExtensions() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### asyncAPIDocument.extensions() ⇒ Object.<string, any> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### asyncAPIDocument.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### asyncAPIDocument.extKeys() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### asyncAPIDocument.hasExtension(key) ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.extension(key) ⇒ any **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.hasExt(key) ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.ext(key) ⇒ any **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.hasTags() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasTags](#MixinTags.hasTags) #### asyncAPIDocument.tags() ⇒ Array.<Tag> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [tags](#MixinTags.tags) #### asyncAPIDocument.tagNames() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [tagNames](#MixinTags.tagNames) #### asyncAPIDocument.hasTag(name) ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasTag](#MixinTags.hasTag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### asyncAPIDocument.tag(name) ⇒ Tag \| null **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [tag](#MixinTags.tag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### asyncAPIDocument.hasExternalDocs() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### asyncAPIDocument.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### asyncAPIDocument.hasExtensions() ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### asyncAPIDocument.extensions() ⇒ Object.<string, any> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### asyncAPIDocument.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### asyncAPIDocument.extKeys() ⇒ Array.<string> **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### asyncAPIDocument.hasExtension(key) ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.extension(key) ⇒ any **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.hasExt(key) ⇒ boolean **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### asyncAPIDocument.ext(key) ⇒ any **Kind**: instance method of [AsyncAPIDocument](#module_@asyncapi/parser+AsyncAPIDocument) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser+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](#module_@asyncapi/parser+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](#module_@asyncapi/parser) #### base.json([key]) ⇒ any **Kind**: instance method of [Base](#module_@asyncapi/parser+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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.ChannelParameter](#module_@asyncapi/parser+ChannelParameter) ⇐ Base * [.location()](#module_@asyncapi/parser+ChannelParameter+location) ⇒ string * [.schema()](#module_@asyncapi/parser+ChannelParameter+schema) ⇒ Schema * [.hasDescription()](#module_@asyncapi/parser+ChannelParameter+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+ChannelParameter+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+ChannelParameter+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+ChannelParameter+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+ChannelParameter+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+ChannelParameter+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+ChannelParameter+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+ChannelParameter+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+ChannelParameter+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+ChannelParameter+ext) ⇒ any #### channelParameter.location() ⇒ string **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) #### channelParameter.schema() ⇒ Schema **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) #### channelParameter.hasDescription() ⇒ boolean **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### channelParameter.description() ⇒ string \| null **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [description](#MixinDescription.description) #### channelParameter.hasExtensions() ⇒ boolean **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### channelParameter.extensions() ⇒ Object.<string, any> **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### channelParameter.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### channelParameter.extKeys() ⇒ Array.<string> **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### channelParameter.hasExtension(key) ⇒ boolean **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### channelParameter.extension(key) ⇒ any **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### channelParameter.hasExt(key) ⇒ boolean **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### channelParameter.ext(key) ⇒ any **Kind**: instance method of [ChannelParameter](#module_@asyncapi/parser+ChannelParameter) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinBindings](#MixinBindings), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.Channel](#module_@asyncapi/parser+Channel) ⇐ Base * [.parameters()](#module_@asyncapi/parser+Channel+parameters) ⇒ Object.<string, ChannelParameter> * [.parameter(name)](#module_@asyncapi/parser+Channel+parameter) ⇒ ChannelParameter * [.hasParameters()](#module_@asyncapi/parser+Channel+hasParameters) ⇒ boolean * [.hasServers()](#module_@asyncapi/parser+Channel+hasServers) ⇒ boolean * [.servers()](#module_@asyncapi/parser+Channel+servers) ⇒ Array.<String> * [.server(index)](#module_@asyncapi/parser+Channel+server) ⇒ String * [.publish()](#module_@asyncapi/parser+Channel+publish) ⇒ PublishOperation * [.subscribe()](#module_@asyncapi/parser+Channel+subscribe) ⇒ SubscribeOperation * [.hasPublish()](#module_@asyncapi/parser+Channel+hasPublish) ⇒ boolean * [.hasSubscribe()](#module_@asyncapi/parser+Channel+hasSubscribe) ⇒ boolean * [.hasDescription()](#module_@asyncapi/parser+Channel+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Channel+description) ⇒ string \| null * [.hasBindings()](#module_@asyncapi/parser+Channel+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+Channel+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+Channel+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+Channel+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+Channel+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+Channel+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Channel+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Channel+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Channel+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Channel+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Channel+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Channel+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Channel+ext) ⇒ any #### channel.parameters() ⇒ Object.<string, ChannelParameter> **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.parameter(name) ⇒ ChannelParameter **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the parameter. | #### channel.hasParameters() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.hasServers() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.servers() ⇒ Array.<String> **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.server(index) ⇒ String **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) | Param | Type | Description | | --- | --- | --- | | index | number | Index of the server. | #### channel.publish() ⇒ PublishOperation **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.subscribe() ⇒ SubscribeOperation **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.hasPublish() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.hasSubscribe() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) #### channel.hasDescription() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### channel.description() ⇒ string \| null **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [description](#MixinDescription.description) #### channel.hasBindings() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [hasBindings](#MixinBindings.hasBindings) #### channel.bindings() ⇒ Object **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [bindings](#MixinBindings.bindings) #### channel.bindingProtocols() ⇒ Array.<string> **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [bindingProtocols](#MixinBindings.bindingProtocols) #### channel.hasBinding(name) ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [hasBinding](#MixinBindings.hasBinding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### channel.binding(name) ⇒ Object \| null **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [binding](#MixinBindings.binding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### channel.hasExtensions() ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### channel.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### channel.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### channel.extKeys() ⇒ Array.<string> **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### channel.hasExtension(key) ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### channel.extension(key) ⇒ any **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### channel.hasExt(key) ⇒ boolean **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### channel.ext(key) ⇒ any **Kind**: instance method of [Channel](#module_@asyncapi/parser+Channel) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.Components](#module_@asyncapi/parser+Components) ⇐ Base * [.channels()](#module_@asyncapi/parser+Components+channels) ⇒ Object.<string, Channel> * [.hasChannels()](#module_@asyncapi/parser+Components+hasChannels) ⇒ boolean * [.channel(name)](#module_@asyncapi/parser+Components+channel) ⇒ Channel * [.messages()](#module_@asyncapi/parser+Components+messages) ⇒ Object.<string, Message> * [.hasMessages()](#module_@asyncapi/parser+Components+hasMessages) ⇒ boolean * [.message(name)](#module_@asyncapi/parser+Components+message) ⇒ Message * [.schemas()](#module_@asyncapi/parser+Components+schemas) ⇒ Object.<string, Schema> * [.hasSchemas()](#module_@asyncapi/parser+Components+hasSchemas) ⇒ boolean * [.schema(name)](#module_@asyncapi/parser+Components+schema) ⇒ Schema * [.securitySchemes()](#module_@asyncapi/parser+Components+securitySchemes) ⇒ Object.<string, SecurityScheme> * [.hasSecuritySchemes()](#module_@asyncapi/parser+Components+hasSecuritySchemes) ⇒ boolean * [.securityScheme(name)](#module_@asyncapi/parser+Components+securityScheme) ⇒ SecurityScheme * [.servers()](#module_@asyncapi/parser+Components+servers) ⇒ Object.<string, Server> * [.hasServers()](#module_@asyncapi/parser+Components+hasServers) ⇒ boolean * [.server(name)](#module_@asyncapi/parser+Components+server) ⇒ Server * [.parameters()](#module_@asyncapi/parser+Components+parameters) ⇒ Object.<string, ChannelParameter> * [.hasParameters()](#module_@asyncapi/parser+Components+hasParameters) ⇒ boolean * [.parameter(name)](#module_@asyncapi/parser+Components+parameter) ⇒ ChannelParameter * [.correlationIds()](#module_@asyncapi/parser+Components+correlationIds) ⇒ Object.<string, CorrelationId> * [.hasCorrelationIds()](#module_@asyncapi/parser+Components+hasCorrelationIds) ⇒ boolean * [.correlationId(name)](#module_@asyncapi/parser+Components+correlationId) ⇒ CorrelationId * [.operationTraits()](#module_@asyncapi/parser+Components+operationTraits) ⇒ Object.<string, OperationTrait> * [.hasOperationTraits()](#module_@asyncapi/parser+Components+hasOperationTraits) ⇒ boolean * [.operationTrait(name)](#module_@asyncapi/parser+Components+operationTrait) ⇒ OperationTrait * [.messageTraits()](#module_@asyncapi/parser+Components+messageTraits) ⇒ Object.<string, MessageTrait> * [.hasMessageTraits()](#module_@asyncapi/parser+Components+hasMessageTraits) ⇒ boolean * [.messageTrait(name)](#module_@asyncapi/parser+Components+messageTrait) ⇒ MessageTrait * [.serverVariables()](#module_@asyncapi/parser+Components+serverVariables) ⇒ Object.<string, ServerVariable> * [.hasServerVariables()](#module_@asyncapi/parser+Components+hasServerVariables) ⇒ boolean * [.serverVariable(name)](#module_@asyncapi/parser+Components+serverVariable) ⇒ ServerVariable * [.hasExtensions()](#module_@asyncapi/parser+Components+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Components+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Components+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Components+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Components+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Components+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Components+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Components+ext) ⇒ any #### components.channels() ⇒ Object.<string, Channel> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasChannels() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.channel(name) ⇒ Channel **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the channel. | #### components.messages() ⇒ Object.<string, Message> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasMessages() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.message(name) ⇒ Message **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the message. | #### components.schemas() ⇒ Object.<string, Schema> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasSchemas() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.schema(name) ⇒ Schema **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the schema. | #### components.securitySchemes() ⇒ Object.<string, SecurityScheme> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasSecuritySchemes() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.securityScheme(name) ⇒ SecurityScheme **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the security schema. | #### components.servers() ⇒ Object.<string, Server> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasServers() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.server(name) ⇒ Server **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the server. | #### components.parameters() ⇒ Object.<string, ChannelParameter> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasParameters() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.parameter(name) ⇒ ChannelParameter **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the channel parameter. | #### components.correlationIds() ⇒ Object.<string, CorrelationId> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasCorrelationIds() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.correlationId(name) ⇒ CorrelationId **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the correlationId. | #### components.operationTraits() ⇒ Object.<string, OperationTrait> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasOperationTraits() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.operationTrait(name) ⇒ OperationTrait **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the operation trait. | #### components.messageTraits() ⇒ Object.<string, MessageTrait> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasMessageTraits() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.messageTrait(name) ⇒ MessageTrait **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the message trait. | #### components.serverVariables() ⇒ Object.<string, ServerVariable> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.hasServerVariables() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) #### components.serverVariable(name) ⇒ ServerVariable **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the server variable. | #### components.hasExtensions() ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### components.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### components.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### components.extKeys() ⇒ Array.<string> **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### components.hasExtension(key) ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### components.extension(key) ⇒ any **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### components.hasExt(key) ⇒ boolean **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### components.ext(key) ⇒ any **Kind**: instance method of [Components](#module_@asyncapi/parser+Components) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.Contact](#module_@asyncapi/parser+Contact) ⇐ Base * [.name()](#module_@asyncapi/parser+Contact+name) ⇒ string * [.url()](#module_@asyncapi/parser+Contact+url) ⇒ string * [.email()](#module_@asyncapi/parser+Contact+email) ⇒ string * [.hasExtensions()](#module_@asyncapi/parser+Contact+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Contact+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Contact+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Contact+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Contact+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Contact+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Contact+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Contact+ext) ⇒ any #### contact.name() ⇒ string **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) #### contact.url() ⇒ string **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) #### contact.email() ⇒ string **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) #### contact.hasExtensions() ⇒ boolean **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### contact.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### contact.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### contact.extKeys() ⇒ Array.<string> **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### contact.hasExtension(key) ⇒ boolean **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### contact.extension(key) ⇒ any **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### contact.hasExt(key) ⇒ boolean **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### contact.ext(key) ⇒ any **Kind**: instance method of [Contact](#module_@asyncapi/parser+Contact) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.CorrelationId](#module_@asyncapi/parser+CorrelationId) ⇐ Base * [.location()](#module_@asyncapi/parser+CorrelationId+location) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+CorrelationId+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+CorrelationId+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+CorrelationId+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+CorrelationId+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+CorrelationId+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+CorrelationId+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+CorrelationId+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+CorrelationId+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+CorrelationId+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+CorrelationId+ext) ⇒ any #### correlationId.location() ⇒ string **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) #### correlationId.hasDescription() ⇒ boolean **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### correlationId.description() ⇒ string \| null **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [description](#MixinDescription.description) #### correlationId.hasExtensions() ⇒ boolean **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### correlationId.extensions() ⇒ Object.<string, any> **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### correlationId.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### correlationId.extKeys() ⇒ Array.<string> **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### correlationId.hasExtension(key) ⇒ boolean **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### correlationId.extension(key) ⇒ any **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### correlationId.hasExt(key) ⇒ boolean **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### correlationId.ext(key) ⇒ any **Kind**: instance method of [CorrelationId](#module_@asyncapi/parser+CorrelationId) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.ExternalDocs](#module_@asyncapi/parser+ExternalDocs) ⇐ Base * [.url()](#module_@asyncapi/parser+ExternalDocs+url) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+ExternalDocs+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+ExternalDocs+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+ExternalDocs+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+ExternalDocs+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+ExternalDocs+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+ExternalDocs+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+ExternalDocs+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+ExternalDocs+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+ExternalDocs+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+ExternalDocs+ext) ⇒ any #### externalDocs.url() ⇒ string **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) #### externalDocs.hasDescription() ⇒ boolean **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### externalDocs.description() ⇒ string \| null **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [description](#MixinDescription.description) #### externalDocs.hasExtensions() ⇒ boolean **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### externalDocs.extensions() ⇒ Object.<string, any> **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### externalDocs.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### externalDocs.extKeys() ⇒ Array.<string> **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### externalDocs.hasExtension(key) ⇒ boolean **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### externalDocs.extension(key) ⇒ any **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### externalDocs.hasExt(key) ⇒ boolean **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### externalDocs.ext(key) ⇒ any **Kind**: instance method of [ExternalDocs](#module_@asyncapi/parser+ExternalDocs) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.Info](#module_@asyncapi/parser+Info) ⇐ Base * [.title()](#module_@asyncapi/parser+Info+title) ⇒ string * [.version()](#module_@asyncapi/parser+Info+version) ⇒ string * [.termsOfService()](#module_@asyncapi/parser+Info+termsOfService) ⇒ string \| undefined * [.license()](#module_@asyncapi/parser+Info+license) ⇒ License * [.contact()](#module_@asyncapi/parser+Info+contact) ⇒ Contact * [.hasDescription()](#module_@asyncapi/parser+Info+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Info+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+Info+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Info+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Info+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Info+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Info+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Info+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Info+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Info+ext) ⇒ any #### info.title() ⇒ string **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) #### info.version() ⇒ string **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) #### info.termsOfService() ⇒ string \| undefined **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) #### info.license() ⇒ License **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) #### info.contact() ⇒ Contact **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) #### info.hasDescription() ⇒ boolean **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### info.description() ⇒ string \| null **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [description](#MixinDescription.description) #### info.hasExtensions() ⇒ boolean **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### info.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### info.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### info.extKeys() ⇒ Array.<string> **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### info.hasExtension(key) ⇒ boolean **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### info.extension(key) ⇒ any **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### info.hasExt(key) ⇒ boolean **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### info.ext(key) ⇒ any **Kind**: instance method of [Info](#module_@asyncapi/parser+Info) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.License](#module_@asyncapi/parser+License) ⇐ Base * [.name()](#module_@asyncapi/parser+License+name) ⇒ string * [.url()](#module_@asyncapi/parser+License+url) ⇒ string * [.hasExtensions()](#module_@asyncapi/parser+License+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+License+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+License+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+License+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+License+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+License+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+License+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+License+ext) ⇒ any #### license.name() ⇒ string **Kind**: instance method of [License](#module_@asyncapi/parser+License) #### license.url() ⇒ string **Kind**: instance method of [License](#module_@asyncapi/parser+License) #### license.hasExtensions() ⇒ boolean **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### license.extensions() ⇒ Object.<string, any> **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### license.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### license.extKeys() ⇒ Array.<string> **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### license.hasExtension(key) ⇒ boolean **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### license.extension(key) ⇒ any **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### license.hasExt(key) ⇒ boolean **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### license.ext(key) ⇒ any **Kind**: instance method of [License](#module_@asyncapi/parser+License) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinTags](#MixinTags), [MixinExternalDocs](#MixinExternalDocs), [MixinBindings](#MixinBindings), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.MessageTraitable](#module_@asyncapi/parser+MessageTraitable) ⇐ Base * [.headers()](#module_@asyncapi/parser+MessageTraitable+headers) ⇒ Schema * [.header(name)](#module_@asyncapi/parser+MessageTraitable+header) ⇒ Schema * [.id()](#module_@asyncapi/parser+MessageTraitable+id) ⇒ string * [.correlationId()](#module_@asyncapi/parser+MessageTraitable+correlationId) ⇒ CorrelationId * [.schemaFormat()](#module_@asyncapi/parser+MessageTraitable+schemaFormat) ⇒ string * [.contentType()](#module_@asyncapi/parser+MessageTraitable+contentType) ⇒ string * [.name()](#module_@asyncapi/parser+MessageTraitable+name) ⇒ string * [.title()](#module_@asyncapi/parser+MessageTraitable+title) ⇒ string * [.summary()](#module_@asyncapi/parser+MessageTraitable+summary) ⇒ string * [.examples()](#module_@asyncapi/parser+MessageTraitable+examples) ⇒ Array.<any> * [.hasDescription()](#module_@asyncapi/parser+MessageTraitable+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+MessageTraitable+description) ⇒ string \| null * [.hasTags()](#module_@asyncapi/parser+MessageTraitable+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+MessageTraitable+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+MessageTraitable+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+MessageTraitable+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+MessageTraitable+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+MessageTraitable+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+MessageTraitable+externalDocs) ⇒ ExternalDocs \| null * [.hasBindings()](#module_@asyncapi/parser+MessageTraitable+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+MessageTraitable+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+MessageTraitable+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+MessageTraitable+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+MessageTraitable+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+MessageTraitable+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+MessageTraitable+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+MessageTraitable+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+MessageTraitable+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+MessageTraitable+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+MessageTraitable+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+MessageTraitable+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+MessageTraitable+ext) ⇒ any #### messageTraitable.headers() ⇒ Schema **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.header(name) ⇒ Schema **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the header. | #### messageTraitable.id() ⇒ string **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.correlationId() ⇒ CorrelationId **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.schemaFormat() ⇒ string **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.contentType() ⇒ string **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.name() ⇒ string **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.title() ⇒ string **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.summary() ⇒ string **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.examples() ⇒ Array.<any> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) #### messageTraitable.hasDescription() ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### messageTraitable.description() ⇒ string \| null **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [description](#MixinDescription.description) #### messageTraitable.hasTags() ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasTags](#MixinTags.hasTags) #### messageTraitable.tags() ⇒ Array.<Tag> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [tags](#MixinTags.tags) #### messageTraitable.tagNames() ⇒ Array.<string> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [tagNames](#MixinTags.tagNames) #### messageTraitable.hasTag(name) ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasTag](#MixinTags.hasTag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### messageTraitable.tag(name) ⇒ Tag \| null **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [tag](#MixinTags.tag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### messageTraitable.hasExternalDocs() ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### messageTraitable.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### messageTraitable.hasBindings() ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasBindings](#MixinBindings.hasBindings) #### messageTraitable.bindings() ⇒ Object **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [bindings](#MixinBindings.bindings) #### messageTraitable.bindingProtocols() ⇒ Array.<string> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [bindingProtocols](#MixinBindings.bindingProtocols) #### messageTraitable.hasBinding(name) ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasBinding](#MixinBindings.hasBinding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### messageTraitable.binding(name) ⇒ Object \| null **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [binding](#MixinBindings.binding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### messageTraitable.hasExtensions() ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### messageTraitable.extensions() ⇒ Object.<string, any> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### messageTraitable.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### messageTraitable.extKeys() ⇒ Array.<string> **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### messageTraitable.hasExtension(key) ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### messageTraitable.extension(key) ⇒ any **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### messageTraitable.hasExt(key) ⇒ boolean **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### messageTraitable.ext(key) ⇒ any **Kind**: instance method of [MessageTraitable](#module_@asyncapi/parser+MessageTraitable) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: MessageTraitable * [.Message](#module_@asyncapi/parser+Message) ⇐ MessageTraitable * [.uid()](#module_@asyncapi/parser+Message+uid) ⇒ string * [.payload()](#module_@asyncapi/parser+Message+payload) ⇒ Schema * [.traits()](#module_@asyncapi/parser+Message+traits) ⇒ Array.<MessageTrait> * [.hasTraits()](#module_@asyncapi/parser+Message+hasTraits) ⇒ boolean * [.originalPayload()](#module_@asyncapi/parser+Message+originalPayload) ⇒ any * [.originalSchemaFormat()](#module_@asyncapi/parser+Message+originalSchemaFormat) ⇒ string #### message.uid() ⇒ string **Kind**: instance method of [Message](#module_@asyncapi/parser+Message) #### message.payload() ⇒ Schema **Kind**: instance method of [Message](#module_@asyncapi/parser+Message) #### message.traits() ⇒ Array.<MessageTrait> **Kind**: instance method of [Message](#module_@asyncapi/parser+Message) #### message.hasTraits() ⇒ boolean **Kind**: instance method of [Message](#module_@asyncapi/parser+Message) #### message.originalPayload() ⇒ any **Kind**: instance method of [Message](#module_@asyncapi/parser+Message) #### message.originalSchemaFormat() ⇒ string **Kind**: instance method of [Message](#module_@asyncapi/parser+Message) ### @asyncapi/parser.OAuthFlow ⇐ Base Implements functions to deal with a OAuthFlow object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.OAuthFlow](#module_@asyncapi/parser+OAuthFlow) ⇐ Base * [.authorizationUrl()](#module_@asyncapi/parser+OAuthFlow+authorizationUrl) ⇒ string * [.tokenUrl()](#module_@asyncapi/parser+OAuthFlow+tokenUrl) ⇒ string * [.refreshUrl()](#module_@asyncapi/parser+OAuthFlow+refreshUrl) ⇒ string * [.scopes()](#module_@asyncapi/parser+OAuthFlow+scopes) ⇒ Object.<string, string> * [.hasExtensions()](#module_@asyncapi/parser+OAuthFlow+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+OAuthFlow+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+OAuthFlow+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+OAuthFlow+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+OAuthFlow+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+OAuthFlow+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+OAuthFlow+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+OAuthFlow+ext) ⇒ any #### oAuthFlow.authorizationUrl() ⇒ string **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) #### oAuthFlow.tokenUrl() ⇒ string **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) #### oAuthFlow.refreshUrl() ⇒ string **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) #### oAuthFlow.scopes() ⇒ Object.<string, string> **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) #### oAuthFlow.hasExtensions() ⇒ boolean **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### oAuthFlow.extensions() ⇒ Object.<string, any> **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### oAuthFlow.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### oAuthFlow.extKeys() ⇒ Array.<string> **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### oAuthFlow.hasExtension(key) ⇒ boolean **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### oAuthFlow.extension(key) ⇒ any **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### oAuthFlow.hasExt(key) ⇒ boolean **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### oAuthFlow.ext(key) ⇒ any **Kind**: instance method of [OAuthFlow](#module_@asyncapi/parser+OAuthFlow) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: Base ### @asyncapi/parser.OperationTrait ⇐ OperationTraitable Implements functions to deal with a OperationTrait object. **Kind**: instance class of [@asyncapi/parser](#module_@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](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinTags](#MixinTags), [MixinExternalDocs](#MixinExternalDocs), [MixinBindings](#MixinBindings), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.OperationTraitable](#module_@asyncapi/parser+OperationTraitable) ⇐ Base * [.id()](#module_@asyncapi/parser+OperationTraitable+id) ⇒ string * [.summary()](#module_@asyncapi/parser+OperationTraitable+summary) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+OperationTraitable+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+OperationTraitable+description) ⇒ string \| null * [.hasTags()](#module_@asyncapi/parser+OperationTraitable+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+OperationTraitable+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+OperationTraitable+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+OperationTraitable+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+OperationTraitable+tag) ⇒ Tag \| null * [.hasExternalDocs()](#module_@asyncapi/parser+OperationTraitable+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+OperationTraitable+externalDocs) ⇒ ExternalDocs \| null * [.hasBindings()](#module_@asyncapi/parser+OperationTraitable+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+OperationTraitable+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+OperationTraitable+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+OperationTraitable+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+OperationTraitable+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+OperationTraitable+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+OperationTraitable+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+OperationTraitable+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+OperationTraitable+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+OperationTraitable+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+OperationTraitable+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+OperationTraitable+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+OperationTraitable+ext) ⇒ any #### operationTraitable.id() ⇒ string **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) #### operationTraitable.summary() ⇒ string **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) #### operationTraitable.hasDescription() ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### operationTraitable.description() ⇒ string \| null **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [description](#MixinDescription.description) #### operationTraitable.hasTags() ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasTags](#MixinTags.hasTags) #### operationTraitable.tags() ⇒ Array.<Tag> **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [tags](#MixinTags.tags) #### operationTraitable.tagNames() ⇒ Array.<string> **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [tagNames](#MixinTags.tagNames) #### operationTraitable.hasTag(name) ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasTag](#MixinTags.hasTag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### operationTraitable.tag(name) ⇒ Tag \| null **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [tag](#MixinTags.tag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### operationTraitable.hasExternalDocs() ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### operationTraitable.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### operationTraitable.hasBindings() ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasBindings](#MixinBindings.hasBindings) #### operationTraitable.bindings() ⇒ Object **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [bindings](#MixinBindings.bindings) #### operationTraitable.bindingProtocols() ⇒ Array.<string> **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [bindingProtocols](#MixinBindings.bindingProtocols) #### operationTraitable.hasBinding(name) ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasBinding](#MixinBindings.hasBinding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### operationTraitable.binding(name) ⇒ Object \| null **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [binding](#MixinBindings.binding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### operationTraitable.hasExtensions() ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### operationTraitable.extensions() ⇒ Object.<string, any> **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### operationTraitable.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### operationTraitable.extKeys() ⇒ Array.<string> **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### operationTraitable.hasExtension(key) ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### operationTraitable.extension(key) ⇒ any **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### operationTraitable.hasExt(key) ⇒ boolean **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### operationTraitable.ext(key) ⇒ any **Kind**: instance method of [OperationTraitable](#module_@asyncapi/parser+OperationTraitable) **Mixes**: [ext](#MixinSpecificationExtensions.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](#module_@asyncapi/parser) **Extends**: OperationTraitable * [.Operation](#module_@asyncapi/parser+Operation) ⇐ OperationTraitable * [.hasMultipleMessages()](#module_@asyncapi/parser+Operation+hasMultipleMessages) ⇒ boolean * [.traits()](#module_@asyncapi/parser+Operation+traits) ⇒ Array.<OperationTrait> * [.hasTraits()](#module_@asyncapi/parser+Operation+hasTraits) ⇒ boolean * [.messages()](#module_@asyncapi/parser+Operation+messages) ⇒ Array.<Message> * [.message()](#module_@asyncapi/parser+Operation+message) ⇒ Message * [.security()](#module_@asyncapi/parser+Operation+security) ⇒ Array.<OperationSecurityRequirement> #### operation.hasMultipleMessages() ⇒ boolean **Kind**: instance method of [Operation](#module_@asyncapi/parser+Operation) #### operation.traits() ⇒ Array.<OperationTrait> **Kind**: instance method of [Operation](#module_@asyncapi/parser+Operation) #### operation.hasTraits() ⇒ boolean **Kind**: instance method of [Operation](#module_@asyncapi/parser+Operation) #### operation.messages() ⇒ Array.<Message> **Kind**: instance method of [Operation](#module_@asyncapi/parser+Operation) #### operation.message() ⇒ Message **Kind**: instance method of [Operation](#module_@asyncapi/parser+Operation) #### operation.security() ⇒ Array.<OperationSecurityRequirement> **Kind**: instance method of [Operation](#module_@asyncapi/parser+Operation) ### @asyncapi/parser.PublishOperation ⇐ Operation Implements functions to deal with a PublishOperation object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Operation * [.PublishOperation](#module_@asyncapi/parser+PublishOperation) ⇐ Operation * [.isPublish()](#module_@asyncapi/parser+PublishOperation+isPublish) ⇒ boolean * [.isSubscribe()](#module_@asyncapi/parser+PublishOperation+isSubscribe) ⇒ boolean * [.kind()](#module_@asyncapi/parser+PublishOperation+kind) ⇒ string #### publishOperation.isPublish() ⇒ boolean **Kind**: instance method of [PublishOperation](#module_@asyncapi/parser+PublishOperation) #### publishOperation.isSubscribe() ⇒ boolean **Kind**: instance method of [PublishOperation](#module_@asyncapi/parser+PublishOperation) #### publishOperation.kind() ⇒ string **Kind**: instance method of [PublishOperation](#module_@asyncapi/parser+PublishOperation) ### @asyncapi/parser.Schema ⇐ Base Implements functions to deal with a Schema object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinExternalDocs](#MixinExternalDocs), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.Schema](#module_@asyncapi/parser+Schema) ⇐ Base * [new Schema(json, [options])](#new_module_@asyncapi/parser+Schema_new) * [.uid()](#module_@asyncapi/parser+Schema+uid) ⇒ string * [.$id()](#module_@asyncapi/parser+Schema+$id) ⇒ string * [.multipleOf()](#module_@asyncapi/parser+Schema+multipleOf) ⇒ number * [.maximum()](#module_@asyncapi/parser+Schema+maximum) ⇒ number * [.exclusiveMaximum()](#module_@asyncapi/parser+Schema+exclusiveMaximum) ⇒ number * [.minimum()](#module_@asyncapi/parser+Schema+minimum) ⇒ number * [.exclusiveMinimum()](#module_@asyncapi/parser+Schema+exclusiveMinimum) ⇒ number * [.maxLength()](#module_@asyncapi/parser+Schema+maxLength) ⇒ number * [.minLength()](#module_@asyncapi/parser+Schema+minLength) ⇒ number * [.pattern()](#module_@asyncapi/parser+Schema+pattern) ⇒ string * [.maxItems()](#module_@asyncapi/parser+Schema+maxItems) ⇒ number * [.minItems()](#module_@asyncapi/parser+Schema+minItems) ⇒ number * [.uniqueItems()](#module_@asyncapi/parser+Schema+uniqueItems) ⇒ boolean * [.maxProperties()](#module_@asyncapi/parser+Schema+maxProperties) ⇒ number * [.minProperties()](#module_@asyncapi/parser+Schema+minProperties) ⇒ number * [.required()](#module_@asyncapi/parser+Schema+required) ⇒ Array.<string> * [.enum()](#module_@asyncapi/parser+Schema+enum) ⇒ Array.<any> * [.type()](#module_@asyncapi/parser+Schema+type) ⇒ string \| Array.<string> * [.allOf()](#module_@asyncapi/parser+Schema+allOf) ⇒ Array.<Schema> * [.oneOf()](#module_@asyncapi/parser+Schema+oneOf) ⇒ Array.<Schema> * [.anyOf()](#module_@asyncapi/parser+Schema+anyOf) ⇒ Array.<Schema> * [.not()](#module_@asyncapi/parser+Schema+not) ⇒ Schema * [.items()](#module_@asyncapi/parser+Schema+items) ⇒ Schema \| Array.<Schema> * [.properties()](#module_@asyncapi/parser+Schema+properties) ⇒ Object.<string, Schema> * [.property(name)](#module_@asyncapi/parser+Schema+property) ⇒ Schema * [.additionalProperties()](#module_@asyncapi/parser+Schema+additionalProperties) ⇒ boolean \| Schema * [.additionalItems()](#module_@asyncapi/parser+Schema+additionalItems) ⇒ Schema * [.patternProperties()](#module_@asyncapi/parser+Schema+patternProperties) ⇒ Object.<string, Schema> * [.const()](#module_@asyncapi/parser+Schema+const) ⇒ any * [.contains()](#module_@asyncapi/parser+Schema+contains) ⇒ Schema * [.dependencies()](#module_@asyncapi/parser+Schema+dependencies) ⇒ Object.<string, (Schema\|Array.<string>)> * [.propertyNames()](#module_@asyncapi/parser+Schema+propertyNames) ⇒ Schema * [.if()](#module_@asyncapi/parser+Schema+if) ⇒ Schema * [.then()](#module_@asyncapi/parser+Schema+then) ⇒ Schema * [.else()](#module_@asyncapi/parser+Schema+else) ⇒ Schema * [.format()](#module_@asyncapi/parser+Schema+format) ⇒ string * [.contentEncoding()](#module_@asyncapi/parser+Schema+contentEncoding) ⇒ string * [.contentMediaType()](#module_@asyncapi/parser+Schema+contentMediaType) ⇒ string * [.definitions()](#module_@asyncapi/parser+Schema+definitions) ⇒ Object.<string, Schema> * [.title()](#module_@asyncapi/parser+Schema+title) ⇒ string * [.default()](#module_@asyncapi/parser+Schema+default) ⇒ any * [.deprecated()](#module_@asyncapi/parser+Schema+deprecated) ⇒ boolean * [.discriminator()](#module_@asyncapi/parser+Schema+discriminator) ⇒ string * [.readOnly()](#module_@asyncapi/parser+Schema+readOnly) ⇒ boolean * [.writeOnly()](#module_@asyncapi/parser+Schema+writeOnly) ⇒ boolean * [.examples()](#module_@asyncapi/parser+Schema+examples) ⇒ Array.<any> * [.isBooleanSchema()](#module_@asyncapi/parser+Schema+isBooleanSchema) ⇒ boolean * [.isCircular()](#module_@asyncapi/parser+Schema+isCircular) ⇒ boolean * [.circularSchema()](#module_@asyncapi/parser+Schema+circularSchema) ⇒ Schema * ~~[.hasCircularProps()](#module_@asyncapi/parser+Schema+hasCircularProps) ⇒ boolean~~ * ~~[.circularProps()](#module_@asyncapi/parser+Schema+circularProps) ⇒ Array.<string>~~ * [.hasDescription()](#module_@asyncapi/parser+Schema+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Schema+description) ⇒ string \| null * [.hasExternalDocs()](#module_@asyncapi/parser+Schema+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+Schema+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+Schema+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Schema+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Schema+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Schema+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Schema+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Schema+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Schema+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Schema+ext) ⇒ any * [.hasDescription()](#module_@asyncapi/parser+Schema+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Schema+description) ⇒ string \| null * [.hasExternalDocs()](#module_@asyncapi/parser+Schema+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+Schema+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+Schema+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Schema+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Schema+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Schema+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Schema+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Schema+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Schema+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Schema+ext) ⇒ any #### new Schema(json, [options]) Instantiates a schema object | Param | Type | Description | | --- | --- | --- | | json | any | Schema definition | | [options] | Object | | | [options.parent] | Schema | Parent schema definition | #### schema.uid() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.$id() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.multipleOf() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.maximum() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.exclusiveMaximum() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.minimum() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.exclusiveMinimum() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.maxLength() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.minLength() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.pattern() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.maxItems() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.minItems() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.uniqueItems() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.maxProperties() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.minProperties() ⇒ number **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.required() ⇒ Array.<string> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.enum() ⇒ Array.<any> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.type() ⇒ string \| Array.<string> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.allOf() ⇒ Array.<Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.oneOf() ⇒ Array.<Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.anyOf() ⇒ Array.<Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.not() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.items() ⇒ Schema \| Array.<Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.properties() ⇒ Object.<string, Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.property(name) ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the property. | #### schema.additionalProperties() ⇒ boolean \| Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.additionalItems() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.patternProperties() ⇒ Object.<string, Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.const() ⇒ any **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.contains() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.dependencies() ⇒ Object.<string, (Schema\|Array.<string>)> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.propertyNames() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.if() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.then() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.else() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.format() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.contentEncoding() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.contentMediaType() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.definitions() ⇒ Object.<string, Schema> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.title() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.default() ⇒ any **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.deprecated() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.discriminator() ⇒ string **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.readOnly() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.writeOnly() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.examples() ⇒ Array.<any> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.isBooleanSchema() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.isCircular() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.circularSchema() ⇒ Schema **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### ~~schema.hasCircularProps() ⇒ boolean~~ ***Deprecated*** **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### ~~schema.circularProps() ⇒ Array.<string>~~ ***Deprecated*** **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) #### schema.hasDescription() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### schema.description() ⇒ string \| null **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [description](#MixinDescription.description) #### schema.hasExternalDocs() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### schema.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### schema.hasExtensions() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### schema.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### schema.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### schema.extKeys() ⇒ Array.<string> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### schema.hasExtension(key) ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.extension(key) ⇒ any **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.hasExt(key) ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.ext(key) ⇒ any **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.hasDescription() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### schema.description() ⇒ string \| null **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [description](#MixinDescription.description) #### schema.hasExternalDocs() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### schema.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### schema.hasExtensions() ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### schema.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### schema.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### schema.extKeys() ⇒ Array.<string> **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### schema.hasExtension(key) ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.extension(key) ⇒ any **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.hasExt(key) ⇒ boolean **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### schema.ext(key) ⇒ any **Kind**: instance method of [Schema](#module_@asyncapi/parser+Schema) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### @asyncapi/parser.SecurityScheme ⇐ Base Implements functions to deal with a SecurityScheme object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.SecurityScheme](#module_@asyncapi/parser+SecurityScheme) ⇐ Base * [.type()](#module_@asyncapi/parser+SecurityScheme+type) ⇒ string * [.name()](#module_@asyncapi/parser+SecurityScheme+name) ⇒ string * [.in()](#module_@asyncapi/parser+SecurityScheme+in) ⇒ string * [.scheme()](#module_@asyncapi/parser+SecurityScheme+scheme) ⇒ string * [.bearerFormat()](#module_@asyncapi/parser+SecurityScheme+bearerFormat) ⇒ string * [.openIdConnectUrl()](#module_@asyncapi/parser+SecurityScheme+openIdConnectUrl) ⇒ string * [.flows()](#module_@asyncapi/parser+SecurityScheme+flows) ⇒ Object.<string, OAuthFlow> * [.hasDescription()](#module_@asyncapi/parser+SecurityScheme+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+SecurityScheme+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+SecurityScheme+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+SecurityScheme+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+SecurityScheme+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+SecurityScheme+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+SecurityScheme+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+SecurityScheme+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+SecurityScheme+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+SecurityScheme+ext) ⇒ any #### securityScheme.type() ⇒ string **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.name() ⇒ string **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.in() ⇒ string **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.scheme() ⇒ string **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.bearerFormat() ⇒ string **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.openIdConnectUrl() ⇒ string **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.flows() ⇒ Object.<string, OAuthFlow> **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) #### securityScheme.hasDescription() ⇒ boolean **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### securityScheme.description() ⇒ string \| null **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [description](#MixinDescription.description) #### securityScheme.hasExtensions() ⇒ boolean **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### securityScheme.extensions() ⇒ Object.<string, any> **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### securityScheme.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### securityScheme.extKeys() ⇒ Array.<string> **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### securityScheme.hasExtension(key) ⇒ boolean **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### securityScheme.extension(key) ⇒ any **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### securityScheme.hasExt(key) ⇒ boolean **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### securityScheme.ext(key) ⇒ any **Kind**: instance method of [SecurityScheme](#module_@asyncapi/parser+SecurityScheme) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### @asyncapi/parser.ServerSecurityRequirement ⇐ Base Implements functions to deal with a ServerSecurityRequirement object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base ### @asyncapi/parser.ServerVariable ⇐ Base Implements functions to deal with a ServerVariable object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.ServerVariable](#module_@asyncapi/parser+ServerVariable) ⇐ Base * [.allowedValues()](#module_@asyncapi/parser+ServerVariable+allowedValues) ⇒ Array.<any> * [.allows(name)](#module_@asyncapi/parser+ServerVariable+allows) ⇒ boolean * [.hasAllowedValues()](#module_@asyncapi/parser+ServerVariable+hasAllowedValues) ⇒ boolean * [.defaultValue()](#module_@asyncapi/parser+ServerVariable+defaultValue) ⇒ string * [.hasDefaultValue()](#module_@asyncapi/parser+ServerVariable+hasDefaultValue) ⇒ boolean * [.examples()](#module_@asyncapi/parser+ServerVariable+examples) ⇒ Array.<string> * [.hasDescription()](#module_@asyncapi/parser+ServerVariable+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+ServerVariable+description) ⇒ string \| null * [.hasExtensions()](#module_@asyncapi/parser+ServerVariable+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+ServerVariable+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+ServerVariable+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+ServerVariable+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+ServerVariable+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+ServerVariable+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+ServerVariable+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+ServerVariable+ext) ⇒ any #### serverVariable.allowedValues() ⇒ Array.<any> **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) #### serverVariable.allows(name) ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the variable. | #### serverVariable.hasAllowedValues() ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) #### serverVariable.defaultValue() ⇒ string **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) #### serverVariable.hasDefaultValue() ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) #### serverVariable.examples() ⇒ Array.<string> **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) #### serverVariable.hasDescription() ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### serverVariable.description() ⇒ string \| null **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [description](#MixinDescription.description) #### serverVariable.hasExtensions() ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### serverVariable.extensions() ⇒ Object.<string, any> **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### serverVariable.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### serverVariable.extKeys() ⇒ Array.<string> **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### serverVariable.hasExtension(key) ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### serverVariable.extension(key) ⇒ any **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### serverVariable.hasExt(key) ⇒ boolean **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### serverVariable.ext(key) ⇒ any **Kind**: instance method of [ServerVariable](#module_@asyncapi/parser+ServerVariable) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### @asyncapi/parser.Server ⇐ Base Implements functions to deal with a Server object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinBindings](#MixinBindings), [MixinSpecificationExtensions](#MixinSpecificationExtensions), [MixinTags](#MixinTags) * [.Server](#module_@asyncapi/parser+Server) ⇐ Base * [.url()](#module_@asyncapi/parser+Server+url) ⇒ string * [.protocol()](#module_@asyncapi/parser+Server+protocol) ⇒ string * [.protocolVersion()](#module_@asyncapi/parser+Server+protocolVersion) ⇒ string * [.variables()](#module_@asyncapi/parser+Server+variables) ⇒ Object.<string, ServerVariable> * [.variable(name)](#module_@asyncapi/parser+Server+variable) ⇒ ServerVariable * [.hasVariables()](#module_@asyncapi/parser+Server+hasVariables) ⇒ boolean * [.security()](#module_@asyncapi/parser+Server+security) ⇒ Array.<ServerSecurityRequirement> * [.hasDescription()](#module_@asyncapi/parser+Server+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Server+description) ⇒ string \| null * [.hasBindings()](#module_@asyncapi/parser+Server+hasBindings) ⇒ boolean * [.bindings()](#module_@asyncapi/parser+Server+bindings) ⇒ Object * [.bindingProtocols()](#module_@asyncapi/parser+Server+bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#module_@asyncapi/parser+Server+hasBinding) ⇒ boolean * [.binding(name)](#module_@asyncapi/parser+Server+binding) ⇒ Object \| null * [.hasExtensions()](#module_@asyncapi/parser+Server+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Server+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Server+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Server+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Server+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Server+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Server+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Server+ext) ⇒ any * [.hasTags()](#module_@asyncapi/parser+Server+hasTags) ⇒ boolean * [.tags()](#module_@asyncapi/parser+Server+tags) ⇒ Array.<Tag> * [.tagNames()](#module_@asyncapi/parser+Server+tagNames) ⇒ Array.<string> * [.hasTag(name)](#module_@asyncapi/parser+Server+hasTag) ⇒ boolean * [.tag(name)](#module_@asyncapi/parser+Server+tag) ⇒ Tag \| null #### server.url() ⇒ string **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) #### server.protocol() ⇒ string **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) #### server.protocolVersion() ⇒ string **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) #### server.variables() ⇒ Object.<string, ServerVariable> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) #### server.variable(name) ⇒ ServerVariable **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the server variable. | #### server.hasVariables() ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) #### server.security() ⇒ Array.<ServerSecurityRequirement> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) #### server.hasDescription() ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### server.description() ⇒ string \| null **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [description](#MixinDescription.description) #### server.hasBindings() ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasBindings](#MixinBindings.hasBindings) #### server.bindings() ⇒ Object **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [bindings](#MixinBindings.bindings) #### server.bindingProtocols() ⇒ Array.<string> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [bindingProtocols](#MixinBindings.bindingProtocols) #### server.hasBinding(name) ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasBinding](#MixinBindings.hasBinding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### server.binding(name) ⇒ Object \| null **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [binding](#MixinBindings.binding) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | #### server.hasExtensions() ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### server.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### server.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### server.extKeys() ⇒ Array.<string> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### server.hasExtension(key) ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### server.extension(key) ⇒ any **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### server.hasExt(key) ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### server.ext(key) ⇒ any **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### server.hasTags() ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasTags](#MixinTags.hasTags) #### server.tags() ⇒ Array.<Tag> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [tags](#MixinTags.tags) #### server.tagNames() ⇒ Array.<string> **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [tagNames](#MixinTags.tagNames) #### server.hasTag(name) ⇒ boolean **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [hasTag](#MixinTags.hasTag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | #### server.tag(name) ⇒ Tag \| null **Kind**: instance method of [Server](#module_@asyncapi/parser+Server) **Mixes**: [tag](#MixinTags.tag) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | ### @asyncapi/parser.SubscribeOperation ⇐ Operation Implements functions to deal with a SubscribeOperation object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Operation * [.SubscribeOperation](#module_@asyncapi/parser+SubscribeOperation) ⇐ Operation * [.isPublish()](#module_@asyncapi/parser+SubscribeOperation+isPublish) ⇒ boolean * [.isSubscribe()](#module_@asyncapi/parser+SubscribeOperation+isSubscribe) ⇒ boolean * [.kind()](#module_@asyncapi/parser+SubscribeOperation+kind) ⇒ string #### subscribeOperation.isPublish() ⇒ boolean **Kind**: instance method of [SubscribeOperation](#module_@asyncapi/parser+SubscribeOperation) #### subscribeOperation.isSubscribe() ⇒ boolean **Kind**: instance method of [SubscribeOperation](#module_@asyncapi/parser+SubscribeOperation) #### subscribeOperation.kind() ⇒ string **Kind**: instance method of [SubscribeOperation](#module_@asyncapi/parser+SubscribeOperation) ### @asyncapi/parser.Tag ⇐ Base Implements functions to deal with a Tag object. **Kind**: instance class of [@asyncapi/parser](#module_@asyncapi/parser) **Extends**: Base **Mixes**: [MixinDescription](#MixinDescription), [MixinExternalDocs](#MixinExternalDocs), [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.Tag](#module_@asyncapi/parser+Tag) ⇐ Base * [.name()](#module_@asyncapi/parser+Tag+name) ⇒ string * [.hasDescription()](#module_@asyncapi/parser+Tag+hasDescription) ⇒ boolean * [.description()](#module_@asyncapi/parser+Tag+description) ⇒ string \| null * [.hasExternalDocs()](#module_@asyncapi/parser+Tag+hasExternalDocs) ⇒ boolean * [.externalDocs()](#module_@asyncapi/parser+Tag+externalDocs) ⇒ ExternalDocs \| null * [.hasExtensions()](#module_@asyncapi/parser+Tag+hasExtensions) ⇒ boolean * [.extensions()](#module_@asyncapi/parser+Tag+extensions) ⇒ Object.<string, any> * [.extensionKeys()](#module_@asyncapi/parser+Tag+extensionKeys) ⇒ Array.<string> * [.extKeys()](#module_@asyncapi/parser+Tag+extKeys) ⇒ Array.<string> * [.hasExtension(key)](#module_@asyncapi/parser+Tag+hasExtension) ⇒ boolean * [.extension(key)](#module_@asyncapi/parser+Tag+extension) ⇒ any * [.hasExt(key)](#module_@asyncapi/parser+Tag+hasExt) ⇒ boolean * [.ext(key)](#module_@asyncapi/parser+Tag+ext) ⇒ any #### tag.name() ⇒ string **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) #### tag.hasDescription() ⇒ boolean **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [hasDescription](#MixinDescription.hasDescription) #### tag.description() ⇒ string \| null **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [description](#MixinDescription.description) #### tag.hasExternalDocs() ⇒ boolean **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [hasExternalDocs](#MixinExternalDocs.hasExternalDocs) #### tag.externalDocs() ⇒ ExternalDocs \| null **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [externalDocs](#MixinExternalDocs.externalDocs) #### tag.hasExtensions() ⇒ boolean **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [hasExtensions](#MixinSpecificationExtensions.hasExtensions) #### tag.extensions() ⇒ Object.<string, any> **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [extensions](#MixinSpecificationExtensions.extensions) #### tag.extensionKeys() ⇒ Array.<string> **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [extensionKeys](#MixinSpecificationExtensions.extensionKeys) #### tag.extKeys() ⇒ Array.<string> **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [extKeys](#MixinSpecificationExtensions.extKeys) #### tag.hasExtension(key) ⇒ boolean **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [hasExtension](#MixinSpecificationExtensions.hasExtension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### tag.extension(key) ⇒ any **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [extension](#MixinSpecificationExtensions.extension) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### tag.hasExt(key) ⇒ boolean **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [hasExt](#MixinSpecificationExtensions.hasExt) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | #### tag.ext(key) ⇒ any **Kind**: instance method of [Tag](#module_@asyncapi/parser+Tag) **Mixes**: [ext](#MixinSpecificationExtensions.ext) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### @asyncapi/parser.TraverseSchemas ⇒ boolean Callback used when crawling a schema. **Kind**: static typedef of [@asyncapi/parser](#module_@asyncapi/parser) **Returns**: boolean - should the crawler continue crawling the schema? | Param | Type | Description | | --- | --- | --- | | schema | Schema | which is being crawled | | propName | String | if the schema is from a property get the name of such | | callbackType | [SchemaIteratorCallbackType](#SchemaIteratorCallbackType) | is the schema a new one or is the crawler finishing one. | ### @asyncapi/parser~parse(asyncapiYAMLorJSON, [options]) ⇒ Promise.<AsyncAPIDocument> Parses and validate an AsyncAPI document from YAML or JSON. **Kind**: inner method of [@asyncapi/parser](#module_@asyncapi/parser) **Returns**: Promise.<AsyncAPIDocument> - The parsed AsyncAPI document. | Param | Type | Description | | --- | --- | --- | | asyncapiYAMLorJSON | String \| Object | An AsyncAPI document in JSON or YAML format. | | [options] | ParserOptions | Configuration options object [ParserOptions](#asyncapiparserparseroptions--object) | ### @asyncapi/parser~parseFromUrl(url, [fetchOptions], [options]) ⇒ Promise.<AsyncAPIDocument> Fetches an AsyncAPI document from the given URL and passes its content to the `parse` method. **Kind**: inner method of [@asyncapi/parser](#module_@asyncapi/parser) **Returns**: Promise.<AsyncAPIDocument> - The parsed AsyncAPI document. | Param | Type | Description | | --- | --- | --- | | url | String | URL where the AsyncAPI document is located. | | [fetchOptions] | Object | Configuration to pass to the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Request) call. | | [options] | ParserOptions | Configuration to pass to the [ParserOptions](#asyncapiparserparseroptions--object) method. | ### @asyncapi/parser~registerSchemaParser(parserModule) Registers a new schema parser. Schema parsers are in charge of parsing and transforming payloads to AsyncAPI Schema format. **Kind**: inner method of [@asyncapi/parser](#module_@asyncapi/parser) | Param | Type | Description | | --- | --- | --- | | parserModule | Object | The schema parser module containing parse() and getMimeTypes() functions. | ### @asyncapi/parser~ParserOptions : Object The complete list of parse configuration options used to parse the given data. **Kind**: inner typedef of [@asyncapi/parser](#module_@asyncapi/parser) **Properties** | Name | Type | Description | | --- | --- | --- | | [path] | String | Path to the AsyncAPI document. It will be used to resolve relative references. Defaults to current working dir. | | [parse] | Object | Options object to pass to [json-schema-ref-parser](https://apitools.dev/json-schema-ref-parser/docs/options.html). | | [resolve] | Object | Options object to pass to [json-schema-ref-parser](https://apitools.dev/json-schema-ref-parser/docs/options.html). | | [applyTraits] | Boolean | Whether to resolve and apply traits or not. Defaults to true. | ## MixinBindings Implements functions to deal with the common Bindings object. **Kind**: global mixin * [MixinBindings](#MixinBindings) * [.hasBindings()](#MixinBindings.hasBindings) ⇒ boolean * [.bindings()](#MixinBindings.bindings) ⇒ Object * [.bindingProtocols()](#MixinBindings.bindingProtocols) ⇒ Array.<string> * [.hasBinding(name)](#MixinBindings.hasBinding) ⇒ boolean * [.binding(name)](#MixinBindings.binding) ⇒ Object \| null ### MixinBindings.hasBindings() ⇒ boolean **Kind**: static method of [MixinBindings](#MixinBindings) ### MixinBindings.bindings() ⇒ Object **Kind**: static method of [MixinBindings](#MixinBindings) ### MixinBindings.bindingProtocols() ⇒ Array.<string> **Kind**: static method of [MixinBindings](#MixinBindings) ### MixinBindings.hasBinding(name) ⇒ boolean **Kind**: static method of [MixinBindings](#MixinBindings) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | ### MixinBindings.binding(name) ⇒ Object \| null **Kind**: static method of [MixinBindings](#MixinBindings) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the binding. | ## MixinDescription Implements functions to deal with the description field. **Kind**: global mixin * [MixinDescription](#MixinDescription) * [.hasDescription()](#MixinDescription.hasDescription) ⇒ boolean * [.description()](#MixinDescription.description) ⇒ string \| null ### MixinDescription.hasDescription() ⇒ boolean **Kind**: static method of [MixinDescription](#MixinDescription) ### MixinDescription.description() ⇒ string \| null **Kind**: static method of [MixinDescription](#MixinDescription) ## MixinExternalDocs Implements functions to deal with the ExternalDocs object. **Kind**: global mixin * [MixinExternalDocs](#MixinExternalDocs) * [.hasExternalDocs()](#MixinExternalDocs.hasExternalDocs) ⇒ boolean * [.externalDocs()](#MixinExternalDocs.externalDocs) ⇒ ExternalDocs \| null ### MixinExternalDocs.hasExternalDocs() ⇒ boolean **Kind**: static method of [MixinExternalDocs](#MixinExternalDocs) ### MixinExternalDocs.externalDocs() ⇒ ExternalDocs \| null **Kind**: static method of [MixinExternalDocs](#MixinExternalDocs) ## MixinSpecificationExtensions Implements functions to deal with the SpecificationExtensions object. **Kind**: global mixin * [MixinSpecificationExtensions](#MixinSpecificationExtensions) * [.hasExtensions()](#MixinSpecificationExtensions.hasExtensions) ⇒ boolean * [.extensions()](#MixinSpecificationExtensions.extensions) ⇒ Object.<string, any> * [.extensionKeys()](#MixinSpecificationExtensions.extensionKeys) ⇒ Array.<string> * [.extKeys()](#MixinSpecificationExtensions.extKeys) ⇒ Array.<string> * [.hasExtension(key)](#MixinSpecificationExtensions.hasExtension) ⇒ boolean * [.extension(key)](#MixinSpecificationExtensions.extension) ⇒ any * [.hasExt(key)](#MixinSpecificationExtensions.hasExt) ⇒ boolean * [.ext(key)](#MixinSpecificationExtensions.ext) ⇒ any ### MixinSpecificationExtensions.hasExtensions() ⇒ boolean **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) ### MixinSpecificationExtensions.extensions() ⇒ Object.<string, any> **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) ### MixinSpecificationExtensions.extensionKeys() ⇒ Array.<string> **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) ### MixinSpecificationExtensions.extKeys() ⇒ Array.<string> **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) ### MixinSpecificationExtensions.hasExtension(key) ⇒ boolean **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### MixinSpecificationExtensions.extension(key) ⇒ any **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### MixinSpecificationExtensions.hasExt(key) ⇒ boolean **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ### MixinSpecificationExtensions.ext(key) ⇒ any **Kind**: static method of [MixinSpecificationExtensions](#MixinSpecificationExtensions) | Param | Type | Description | | --- | --- | --- | | key | string | Extension key. | ## MixinTags Implements functions to deal with the Tags object. **Kind**: global mixin * [MixinTags](#MixinTags) * [.hasTags()](#MixinTags.hasTags) ⇒ boolean * [.tags()](#MixinTags.tags) ⇒ Array.<Tag> * [.tagNames()](#MixinTags.tagNames) ⇒ Array.<string> * [.hasTag(name)](#MixinTags.hasTag) ⇒ boolean * [.tag(name)](#MixinTags.tag) ⇒ Tag \| null ### MixinTags.hasTags() ⇒ boolean **Kind**: static method of [MixinTags](#MixinTags) ### MixinTags.tags() ⇒ Array.<Tag> **Kind**: static method of [MixinTags](#MixinTags) ### MixinTags.tagNames() ⇒ Array.<string> **Kind**: static method of [MixinTags](#MixinTags) ### MixinTags.hasTag(name) ⇒ boolean **Kind**: static method of [MixinTags](#MixinTags) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | ### MixinTags.tag(name) ⇒ Tag \| null **Kind**: static method of [MixinTags](#MixinTags) | Param | Type | Description | | --- | --- | --- | | name | string | Name of the tag. | ## SchemaIteratorCallbackType The different kind of stages when crawling a schema. **Kind**: global typedef **Properties** | Name | Type | Description | | --- | --- | --- | | NEW_SCHEMA | string | The crawler just started crawling a schema. | | END_SCHEMA | string | The crawler just finished crawling a schema. | ## SchemaTypesToIterate The different types of schemas you can iterate **Kind**: global typedef **Properties** | Name | Type | Description | | --- | --- | --- | | parameters | string | Crawl all schemas in parameters | | payloads | string | Crawl all schemas in payloads | | headers | string | Crawl all schemas in headers | | components | string | Crawl all schemas in components | | objects | string | Crawl all schemas of type object | | arrays | string | Crawl all schemas of type array | | oneOfs | string | Crawl all schemas in oneOf's | | allOfs | string | Crawl all schemas in allOf's | | anyOfs | string | Crawl all schemas in anyOf's | | nots | string | Crawl all schemas in not field | | propertyNames | string | Crawl all schemas in propertyNames field | | patternProperties | string | Crawl all schemas in patternProperties field | | contains | string | Crawl all schemas in contains field | | ifs | string | Crawl all schemas in if field | | thenes | string | Crawl all schemas in then field | | elses | string | Crawl all schemas in else field | | dependencies | string | Crawl all schemas in dependencies field | | definitions | string | Crawl all schemas in definitions field |