Appearance

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

Interface: ChanxOptions ​

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

Options for createChanx().

Properties ​

camelize? ​

ts
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.

consumers ​

ts
consumers: readonly ConsumerLike[];

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

The consumers to serve: consumer() builders or @Consumer classes.

dev? ​

ts
optional dev?: boolean;

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

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

layers? ​

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

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

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

logger? ​

ts
optional logger?: Logger;

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

Defaults to console.

sendCompletion? ​

ts
optional sendCompletion?: boolean;

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

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

MIT licensed