Appearance

API reference / @chanx-js/server / core / AsyncAPIOptions

Interface: AsyncAPIOptions ​

Defined in: packages/server/src/asyncapi.ts:12

Options for chanx.asyncapi(). Metadata given here goes into the document's info.

Extends ​

  • Partial<Pick<AsyncAPIInfo, "termsOfService" | "contact" | "license" | "tags" | "externalDocs">>

Extended by ​

Properties ​

contact? ​

ts
optional contact?: object;

Defined in: packages/server/src/asyncapi.ts:77

email? ​

ts
optional email?: string;

name? ​

ts
optional name?: string;

url? ​

ts
optional url?: string;

Inherited from ​

AsyncAPIInfo.contact

description? ​

ts
optional description?: string;

Defined in: packages/server/src/asyncapi.ts:20

Defaults to an empty string.

externalDocs? ​

ts
optional externalDocs?: AsyncAPIExternalDocs;

Defined in: packages/server/src/asyncapi.ts:80

Inherited from ​

AsyncAPIInfo.externalDocs

license? ​

ts
optional license?: object;

Defined in: packages/server/src/asyncapi.ts:78

name ​

ts
name: string;

url? ​

ts
optional url?: string;

Inherited from ​

AsyncAPIInfo.license

securitySchemes? ​

ts
optional securitySchemes?: Record<string, AsyncAPISecurityScheme>;

Defined in: packages/server/src/asyncapi.ts:28

AsyncAPI Security Scheme Objects by name; one replaces a credentials one of its name.

serverProtocol? ​

ts
optional serverProtocol?: string;

Defined in: packages/server/src/asyncapi.ts:24

ws or wss. Defaults to ws.

servers? ​

ts
optional servers?: Record<string, AsyncAPIServer>;

Defined in: packages/server/src/asyncapi.ts:26

AsyncAPI Server Objects by name, in place of serverUrl and serverProtocol.

serverUrl? ​

ts
optional serverUrl?: string;

Defined in: packages/server/src/asyncapi.ts:22

The server's host, such as api.example.com. Defaults to localhost:8000.

tags? ​

ts
optional tags?: AsyncAPITag[];

Defined in: packages/server/src/asyncapi.ts:79

Inherited from ​

AsyncAPIInfo.tags

termsOfService? ​

ts
optional termsOfService?: string;

Defined in: packages/server/src/asyncapi.ts:76

A URL to the API's terms of service.

Inherited from ​

AsyncAPIInfo.termsOfService

title? ​

ts
optional title?: string;

Defined in: packages/server/src/asyncapi.ts:16

Defaults to AsyncAPI Documentation.

version? ​

ts
optional version?: string;

Defined in: packages/server/src/asyncapi.ts:18

The API's version. Defaults to 1.0.0.

MIT licensed