Class EpAsyncApiDocument

Hierarchy

EpAsyncApiDocument

Index

Constructors

Methods

createApplicationDomainName createAssetsApplicationDomainName createBrokerType createChannelDelimiter createEpApiName createEpApiVersionName createOriginalApiSpecJson getApplicationDomainName getAsJson getAsYamlString getAssetsApplicationDomainName getAsyncApiSpecVersion getBrokerType getChannelDelimiter getDescription getEpApiName getEpApiNameAsFileName getEpApiNameAsFilePath getEpApiVersionName getEpAsyncApiChannelDocumentMap getEpAsyncApiEventNames getEpAsyncApiMessageDocumentMap getEpCustomAttributeValue getEpIsShared getEpStateId getJSON getLogInfo getOriginalSpecAsJson getOriginalSpecAsYamlString getTitle getUnprefixedApplicationDomainName getUnprefixedAssetsApplicationDomainName getVersion get_X_EpApplicationDomainNameInfoLevel get_X_EpApplicationDomainNameTopLevel get_X_EpAssetsApplicationDomainNameInfoLevel get_X_EpAssetsApplicationDomainNameTopLevel get_X_EpBrokerTypeInfoLevel get_X_EpBrokerTypeTopLevel get_X_EpChannelDelimiterInfoLevel get_X_EpChannelDelimiterTopLevel get_X_EpSharedFlag get_X_EpStateIdInfoLevel get_X_EpStateNameInfoLevel validate validateEpApiName validateEpApiVersionName validate_BestPractices validate_BrokerType validate_ChannelDelimiter validate_VersionIsSemVerFormat

Constructors

constructor

new EpAsyncApiDocument(originalApiSpec: any, asyncApiDocument: AsyncAPIDocument, overrideEpApplicationDomainName: undefined | string, overrideEpAssetApplicationDomainName: undefined | string, prefixEpApplicationDomainName: undefined | string, overrideBrokerType: undefined | string, overrideChannelDelimiter: undefined | string): EpAsyncApiDocument
Parameters
- originalApiSpec: any
- asyncApiDocument: AsyncAPIDocument
- overrideEpApplicationDomainName: undefined | string
- overrideEpAssetApplicationDomainName: undefined | string
- prefixEpApplicationDomainName: undefined | string
- overrideBrokerType: undefined | string
- overrideChannelDelimiter: undefined | string
Returns EpAsyncApiDocument
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:258

Properties

`Private` applicationDomainName

applicationDomainName: string

`Private` assetsApplicationDomainName

assetsApplicationDomainName: string

`Private` asyncApiDocument

asyncApiDocument: AsyncAPIDocument

`Private` asyncApiDocumentJson

asyncApiDocumentJson: any

`Private` brokerType

brokerType: EBrokerTypes

`Private` channelDelimiter

channelDelimiter: EChannelDelimiters

`Private` epApiName

epApiName: string

`Private` `Optional` epApiVersionName

epApiVersionName?: string

`Private` originalApiSpecJson

originalApiSpecJson: any

`Private` overrideBrokerType

overrideBrokerType: undefined | string

`Private` overrideChannelDelimiter

overrideChannelDelimiter: undefined | string

`Private` overrideEpApplicationDomainName

overrideEpApplicationDomainName: undefined | string

`Private` overrideEpAssetsApplicationDomainName

overrideEpAssetsApplicationDomainName: undefined | string

`Private` unprefixedApplicationDomainName

unprefixedApplicationDomainName: string

`Private` unprefixedAssetsApplicationDomainName

unprefixedAssetsApplicationDomainName: string

`Static` `Private` `Readonly` DefaultBrokerType

DefaultBrokerType: SOLACE = EBrokerTypes.SOLACE

`Static` `Private` `Readonly` DefaultChannelDelimiter

DefaultChannelDelimiter: SLASH = EChannelDelimiters.SLASH

`Static` `Readonly` InvalidBrokerTypeIssue

InvalidBrokerTypeIssue: "Please use a supported brokerType." = "Please use a supported brokerType."

`Static` `Readonly` InvalidChannelDelimiterIssue

InvalidChannelDelimiterIssue: "Please use a supported channel delimiter." = "Please use a supported channel delimiter."

`Static` `Readonly` NotSemVerIssue

NotSemVerIssue: "Please use semantic versioning format for API version." = "Please use semantic versioning format for API version."

Methods

`Private` createApplicationDomainName

createApplicationDomainName(prefix?: string): string
Parameters
- Optional prefix: string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:158

`Private` createAssetsApplicationDomainName

createAssetsApplicationDomainName(prefix?: string): string
Parameters
- Optional prefix: string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:182

`Private` createEpApiVersionName

createEpApiVersionName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:216

`Private` createOriginalApiSpecJson

createOriginalApiSpecJson(originalApiSpec: any): any
Parameters
- originalApiSpec: any
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:225

getApplicationDomainName

getApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:401

getAsJson

getAsJson(): any
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:454

getAsYamlString

getAsYamlString(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:456

getAssetsApplicationDomainName

getAssetsApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:409

getAsyncApiSpecVersion

getAsyncApiSpecVersion(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:383

getBrokerType

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

getChannelDelimiter

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

getDescription

getDescription(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:395

getEpApiName

getEpApiName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:421

getEpApiNameAsFileName

getEpApiNameAsFileName(ext: string): string
Parameters
- ext: string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:427

getEpApiNameAsFilePath

getEpApiNameAsFilePath(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:423

getEpApiVersionName

getEpApiVersionName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:431

getEpAsyncApiChannelDocumentMap

getEpAsyncApiChannelDocumentMap(): T_EpAsyncApiChannelDocumentMap
Returns T_EpAsyncApiChannelDocumentMap
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:488

getEpAsyncApiEventNames

getEpAsyncApiEventNames(): T_EpAsyncApiEventNames
Returns T_EpAsyncApiEventNames
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:465

getEpAsyncApiMessageDocumentMap

getEpAsyncApiMessageDocumentMap(): T_EpAsyncApiMessageDocumentMap
Returns T_EpAsyncApiMessageDocumentMap
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:498

getEpCustomAttributeValue

getEpCustomAttributeValue(name: string): undefined | string
Parameters
- name: string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:450

getEpIsShared

getEpIsShared(defaultValue: boolean): boolean
Parameters
- defaultValue: boolean
Returns boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:436

getEpStateId

getEpStateId(defaultValue: EpAsyncApiStateIds): EpAsyncApiStateIds
Parameters
- defaultValue: EpAsyncApiStateIds
Returns EpAsyncApiStateIds
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:442

`Private` getJSON

getJSON(asyncApiDocument: AsyncAPIDocument): any
Parameters
- asyncApiDocument: AsyncAPIDocument
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:102

getLogInfo

getLogInfo(): T_EpAsyncApi_LogInfo
Returns T_EpAsyncApi_LogInfo
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:515

getOriginalSpecAsJson

getOriginalSpecAsJson(): any
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:461

getOriginalSpecAsYamlString

getOriginalSpecAsYamlString(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:463

getTitle

getTitle(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:387

getUnprefixedApplicationDomainName

getUnprefixedApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:405

getUnprefixedAssetsApplicationDomainName

getUnprefixedAssetsApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:413

getVersion

getVersion(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:391

`Private` get_X_EpApplicationDomainNameInfoLevel

get_X_EpApplicationDomainNameInfoLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:117

`Private` get_X_EpApplicationDomainNameTopLevel

get_X_EpApplicationDomainNameTopLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:113

`Private` get_X_EpAssetsApplicationDomainNameInfoLevel

get_X_EpAssetsApplicationDomainNameInfoLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:123

`Private` get_X_EpAssetsApplicationDomainNameTopLevel

get_X_EpAssetsApplicationDomainNameTopLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:120

`Private` get_X_EpBrokerTypeInfoLevel

get_X_EpBrokerTypeInfoLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:129

`Private` get_X_EpBrokerTypeTopLevel

get_X_EpBrokerTypeTopLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:126

`Private` get_X_EpChannelDelimiterInfoLevel

get_X_EpChannelDelimiterInfoLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:135

`Private` get_X_EpChannelDelimiterTopLevel

get_X_EpChannelDelimiterTopLevel(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:132

`Private` get_X_EpSharedFlag

get_X_EpSharedFlag(): undefined | boolean
Returns undefined | boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:138

`Private` get_X_EpStateIdInfoLevel

get_X_EpStateIdInfoLevel(): undefined | EpAsyncApiStateIds
Returns undefined | EpAsyncApiStateIds
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:143

`Private` get_X_EpStateNameInfoLevel

get_X_EpStateNameInfoLevel(): undefined | EpAsyncApiStateNames
Returns undefined | EpAsyncApiStateNames
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:150

validate

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

`Private` validateEpApiName

validateEpApiName(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:284

`Private` validateEpApiVersionName

validateEpApiVersionName(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:300

validate_BestPractices

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

`Private` validate_BrokerType

validate_BrokerType(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:330

`Private` validate_ChannelDelimiter

validate_ChannelDelimiter(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:344

`Private` validate_VersionIsSemVerFormat

validate_VersionIsSemVerFormat(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiDocument.ts:317

Class EpAsyncApiDocument

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

originalApiSpec: any

asyncApiDocument: AsyncAPIDocument

overrideEpApplicationDomainName: undefined | string

overrideEpAssetApplicationDomainName: undefined | string

prefixEpApplicationDomainName: undefined | string

overrideBrokerType: undefined | string

overrideChannelDelimiter: undefined | string

Returns EpAsyncApiDocument

Properties

Private applicationDomainName

Private assetsApplicationDomainName

Private asyncApiDocument

Private asyncApiDocumentJson

Private brokerType

Private channelDelimiter

Private epApiName

Private Optional epApiVersionName

Private originalApiSpecJson

Private overrideBrokerType

Private overrideChannelDelimiter

Private overrideEpApplicationDomainName

Private overrideEpAssetsApplicationDomainName

Private unprefixedApplicationDomainName

Private unprefixedAssetsApplicationDomainName

Static Private Readonly DefaultBrokerType

Static Private Readonly DefaultChannelDelimiter

Static Readonly InvalidBrokerTypeIssue

Static Readonly InvalidChannelDelimiterIssue

Static Readonly NotSemVerIssue

Methods

Private createApplicationDomainName

Parameters

Optional prefix: string

Returns string

Private createAssetsApplicationDomainName

Parameters

Optional prefix: string

Returns string

Private createBrokerType

Returns EBrokerTypes

Private createChannelDelimiter

Returns EChannelDelimiters

Private createEpApiName

Returns string

Private createEpApiVersionName

Returns string

Private createOriginalApiSpecJson

Parameters

originalApiSpec: any

Returns any

getApplicationDomainName

Returns string

getAsJson

Returns any

getAsYamlString

Returns string

getAssetsApplicationDomainName

Returns string

getAsyncApiSpecVersion

Returns string

getBrokerType

Returns EBrokerTypes

getChannelDelimiter

Returns EChannelDelimiters

getDescription

Returns string

getEpApiName

Returns string

getEpApiNameAsFileName

Parameters

ext: string

`Private` applicationDomainName

`Private` assetsApplicationDomainName

`Private` asyncApiDocument

`Private` asyncApiDocumentJson

`Private` brokerType

`Private` channelDelimiter

`Private` epApiName

`Private` `Optional` epApiVersionName

`Private` originalApiSpecJson

`Private` overrideBrokerType

`Private` overrideChannelDelimiter

`Private` overrideEpApplicationDomainName

`Private` overrideEpAssetsApplicationDomainName

`Private` unprefixedApplicationDomainName

`Private` unprefixedAssetsApplicationDomainName

`Static` `Private` `Readonly` DefaultBrokerType

`Static` `Private` `Readonly` DefaultChannelDelimiter

`Static` `Readonly` InvalidBrokerTypeIssue

`Static` `Readonly` InvalidChannelDelimiterIssue

`Static` `Readonly` NotSemVerIssue

`Private` createApplicationDomainName

`Optional` prefix: string

`Private` createAssetsApplicationDomainName

`Optional` prefix: string

`Private` createBrokerType

`Private` createChannelDelimiter

`Private` createEpApiName

`Private` createEpApiVersionName

`Private` createOriginalApiSpecJson

`Private` getJSON

`Private` get_X_EpApplicationDomainNameInfoLevel

`Private` get_X_EpApplicationDomainNameTopLevel

`Private` get_X_EpAssetsApplicationDomainNameInfoLevel

`Private` get_X_EpAssetsApplicationDomainNameTopLevel

`Private` get_X_EpBrokerTypeInfoLevel

`Private` get_X_EpBrokerTypeTopLevel

`Private` get_X_EpChannelDelimiterInfoLevel

`Private` get_X_EpChannelDelimiterTopLevel

`Private` get_X_EpSharedFlag

`Private` get_X_EpStateIdInfoLevel

`Private` get_X_EpStateNameInfoLevel

`Private` validateEpApiName

`Private` validateEpApiVersionName