API reference / @chanx-js/server / core / AsyncAPIChannel
Interface: AsyncAPIChannel
Defined in: packages/server/src/asyncapi.ts:99
A consumer, or a topic at a consumer's address.
Properties
address
ts
address: string;Defined in: packages/server/src/asyncapi.ts:100
bindings?
ts
optional bindings?: object;Defined in: packages/server/src/asyncapi.ts:108
The handshake's query and headers, for consumers that declare credentials.
ws
ts
ws: WebSocketBinding;description?
ts
optional description?: string;Defined in: packages/server/src/asyncapi.ts:102
messages
ts
messages: Record<string, Ref>;Defined in: packages/server/src/asyncapi.ts:106
parameters?
ts
optional parameters?: Record<string, {
description: string;
}>;Defined in: packages/server/src/asyncapi.ts:103
tags?
ts
optional tags?: AsyncAPITag[];Defined in: packages/server/src/asyncapi.ts:109
title
ts
title: string;Defined in: packages/server/src/asyncapi.ts:101
x-topic?
ts
optional x-topic?: object;Defined in: packages/server/src/asyncapi.ts:105
chanx's extension marking a topic channel.
name
ts
name: string;parameters
ts
parameters: string[];pattern
ts
pattern: string;