Skip to main content

AsyncAPIDocumentInterface

@the-codegen-project/cli • Docs


Home / AsyncAPIDocumentInterface

Interface: AsyncAPIDocumentInterface

Extends​

  • BaseModel<v2.AsyncAPIObject | v3.AsyncAPIObject>.ExtensionsMixinInterface

Properties​

PropertyModifierTypeInherited fromDefined in
_jsonreadonlyAsyncAPIObject | AsyncAPIObjectBaseModel._jsonnode_modules/@asyncapi/parser/esm/models/base.d.ts:8
_metareadonlyModelMetadataBaseModel._metanode_modules/@asyncapi/parser/esm/models/base.d.ts:9

Methods​

allChannels()​

allChannels(): ChannelsInterface

Returns​

ChannelsInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:26


allMessages()​

allMessages(): MessagesInterface

Returns​

MessagesInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:28


allOperations()​

allOperations(): OperationsInterface

Returns​

OperationsInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:27


allSchemas()​

allSchemas(): SchemasInterface

Returns​

SchemasInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:29


allServers()​

allServers(): ServersInterface

Returns​

ServersInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:25


channels()​

channels(): ChannelsInterface

Returns​

ChannelsInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:19


components()​

components(): ComponentsInterface

Returns​

ComponentsInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:24


createModel()​

protected createModel<T>(
Model,
value,
meta): T

Type Parameters​

Type Parameter
T extends BaseModel<any, {}>

Parameters​

ParameterType
ModelConstructor<T>
valueInferModelData<T>
metaOmit<ModelMetadata, "asyncapi"> & InferModelMetadata<T>

Returns​

T

Inherited from​

BaseModel.createModel

Defined in​

node_modules/@asyncapi/parser/esm/models/base.d.ts:16


defaultContentType()​

defaultContentType(): undefined | string

Returns​

undefined | string

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:15


extensions()​

extensions(): ExtensionsInterface

Returns​

ExtensionsInterface

Inherited from​

ExtensionsMixinInterface.extensions

Defined in​

node_modules/@asyncapi/parser/esm/models/mixins.d.ts:15


hasDefaultContentType()​

hasDefaultContentType(): boolean

Returns​

boolean

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:16


info()​

info(): InfoInterface

Returns​

InfoInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:17


json()​

json()​

json<T>(): T
Type Parameters​
Type ParameterDefault type
TAsyncAPIObject | AsyncAPIObject
Returns​

T

Inherited from​

BaseModel.json

Defined in​

node_modules/@asyncapi/parser/esm/models/base.d.ts:11

json(key)​

json<K>(key): AsyncAPIObject | AsyncAPIObject[K]
Type Parameters​
Type Parameter
K extends | "info" | "asyncapi" | "id" | "components" | "servers" | "channels" | `x-${string}` | "defaultContentType"
Parameters​
ParameterType
keyK
Returns​

AsyncAPIObject | AsyncAPIObject[K]

Inherited from​

BaseModel.json

Defined in​

node_modules/@asyncapi/parser/esm/models/base.d.ts:12


jsonPath()​

jsonPath(field?): string

Parameters​

ParameterType
field?string

Returns​

string

Inherited from​

BaseModel.jsonPath

Defined in​

node_modules/@asyncapi/parser/esm/models/base.d.ts:15


messages()​

messages(): MessagesInterface

Returns​

MessagesInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:21


meta()​

meta()​

meta(): ModelMetadata
Returns​

ModelMetadata

Inherited from​

BaseModel.meta

Defined in​

node_modules/@asyncapi/parser/esm/models/base.d.ts:13

meta(key)​

meta<K>(key): ModelMetadata[K]
Type Parameters​
Type Parameter
K extends keyof ModelMetadata
Parameters​
ParameterType
keyK
Returns​

ModelMetadata[K]

Inherited from​

BaseModel.meta

Defined in​

node_modules/@asyncapi/parser/esm/models/base.d.ts:14


operations()​

operations(): OperationsInterface

Returns​

OperationsInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:20


schemas()​

schemas(): SchemasInterface

Returns​

SchemasInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:22


securitySchemes()​

securitySchemes(): SecuritySchemesInterface

Returns​

SecuritySchemesInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:23


servers()​

servers(): ServersInterface

Returns​

ServersInterface

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:18


version()​

version(): string

Returns​

string

Defined in​

node_modules/@asyncapi/parser/esm/models/asyncapi.d.ts:14