API reference / @chanx-js/server / core / HandlerOptions
Interface: HandlerOptions<Out>
Defined in: packages/server/src/consumer.ts:74
Options for .on(), .event(), @On and @OnEvent.
Type Parameters
| Type Parameter |
|---|
Out |
Properties
description?
ts
optional description?: string;Defined in: packages/server/src/consumer.ts:82
The AsyncAPI operation's description.
name?
ts
optional name?: string;Defined in: packages/server/src/consumer.ts:76
The AsyncAPI operation name. Defaults to handle_<action>.
output?
ts
optional output?: Out;Defined in: packages/server/src/consumer.ts:78
What the handler returns: one message or a list. Documented, and checked in development.
summary?
ts
optional summary?: string;Defined in: packages/server/src/consumer.ts:80
The AsyncAPI operation's summary.
tags?
ts
optional tags?: string[];Defined in: packages/server/src/consumer.ts:84
Tags on the AsyncAPI operation.