Class EpAsyncApiChannelDocument

Hierarchy

EpAsyncApiChannelDocument

Constructors

constructor

new EpAsyncApiChannelDocument(epAsyncApiDocument: EpAsyncApiDocument, asyncApiChannelKey: string, asyncApiChannel: Channel): EpAsyncApiChannelDocument
Parameters
- epAsyncApiDocument: EpAsyncApiDocument
- asyncApiChannelKey: string
- asyncApiChannel: Channel
Returns EpAsyncApiChannelDocument
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:39

Properties

`Private` asyncApiChannel

asyncApiChannel: Channel

`Private` asyncApiChannelKey

asyncApiChannelKey: string

`Private` epAsyncApiDocument

epAsyncApiDocument: EpAsyncApiDocument

`Private` `Optional` epAsyncApiMessageDocument

epAsyncApiMessageDocument?: EpAsyncApiMessageDocument

1 channel can only have 1 message document

`Private` `Optional` epEventDescription

epEventDescription?: string

`Private` `Optional` epEventName

epEventName?: string

`Private` `Optional` epEventVersionName

epEventVersionName?: string

Methods

`Private` createEpEventDescription

createEpEventDescription(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:157

`Private` createEpEventName

createEpEventName(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:131

`Private` createEpEventVersionName

createEpEventVersionName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:149

`Private` createMessageDocument

createMessageDocument(): undefined | EpAsyncApiMessageDocument
Get all messages for pub & sub operations. If more than 1 found or they are different return undefined

Returns undefined | EpAsyncApiMessageDocument
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:113

getAllChannelMessageDocuments

getAllChannelMessageDocuments(): Map<EpAsyncApiChannelOperationType, EpAsyncApiMessageDocument[]>
Returns Map<EpAsyncApiChannelOperationType, EpAsyncApiMessageDocument[]>
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:57

getAsyncApiChannel

getAsyncApiChannel(): Channel
Returns Channel
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:296

getAsyncApiChannelKey

getAsyncApiChannelKey(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:298

getBrokerType

getBrokerType(): EBrokerTypes
Returns EBrokerTypes
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:345

getChannelDelimiter

getChannelDelimiter(): EChannelDelimiters
Returns EChannelDelimiters
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:347

getEpAsyncApiChannelParameterDocumentMap

getEpAsyncApiChannelParameterDocumentMap(): undefined | T_EpAsyncApiChannelParameterDocumentMap
Returns undefined | T_EpAsyncApiChannelParameterDocumentMap
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:334

getEpAsyncApiChannelPublishOperation

getEpAsyncApiChannelPublishOperation(): undefined | EpAsynApiChannelPublishOperation
Returns undefined | EpAsynApiChannelPublishOperation
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:349

getEpAsyncApiChannelSubscribeOperation

getEpAsyncApiChannelSubscribeOperation(): undefined | EpAsyncApiChannelSubscribeOperation
Returns undefined | EpAsyncApiChannelSubscribeOperation
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:356

getEpEventDescription

getEpEventDescription(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:323

getEpEventName

getEpEventName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:300

getEpEventVersionName

getEpEventVersionName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:312

`Private` get_X_AsyncApi_EpEventName

get_X_AsyncApi_EpEventName(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:49

validate

validate(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:253

validateBrokerType

validateBrokerType(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:205

`Private` validateChannelMessage

validateChannelMessage(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:221

`Private` validateEpEventName

validateEpEventName(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:164

`Private` validateEpEventVersionName

validateEpEventVersionName(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:188

validate_BestPractices

validate_BestPractices(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelDocument.ts:278