API reference / @chanx-js/nestjs / ChanxModuleOptions

Interface: ChanxModuleOptions

Defined in: packages/nestjs/src/options.ts:6

Options for ChanxModule.forRoot(): createChanx's, less the consumers it finds itself.

Extends

• Omit<ChanxOptions, "consumers">

Properties

asyncapi?

optional asyncapi?: 
  | boolean
  | AsyncAPIServeOptions;

Defined in: packages/nestjs/src/options.ts:10

Serve the AsyncAPI docs page and document on the app's HTTP server, at /asyncapi unless path says otherwise.

---

camelize?

optional camelize?: boolean;

Defined in: packages/server/src/app.ts:44

Convert keys between snake_case on the server and camelCase on the wire. Defaults to false.

Inherited from

Omit.camelize

---

dev?

optional dev?: boolean;

Defined in: packages/server/src/app.ts:50

Development checks, such as undeclared replies. Defaults to NODE_ENV !== 'production'.

Inherited from

Omit.dev

---

layers?

optional layers?: Readonly<Record<string, ChannelLayer>>;

Defined in: packages/server/src/app.ts:42

Channel layers by name. Defaults to { default: new InMemoryChannelLayer() }.

Inherited from

Omit.layers

---

logger?

optional logger?: Logger;

Defined in: packages/server/src/app.ts:48

Defaults to console.

Inherited from

Omit.logger

---

pingInterval?

optional pingInterval?: number;

Defined in: packages/nestjs/src/options.ts:8

Passed to attachChanx: how often idle clients are pinged.

---

sendCompletion?

optional sendCompletion?: boolean;

Defined in: packages/server/src/app.ts:46

Send a complete frame after each handled frame. Defaults to false.

Inherited from

Omit.sendCompletion