Skip to content

Type Alias: ChannelActionInfo ​

ChannelActionInfo = BaseActionInfo & Record<string, unknown> & object

The description of an action given to the adapters (ChannelRuntime.actions): one per address (an HTTP route declared for two methods has two), with the fields of its channel (route, command, pattern…).

Type Declaration ​

address ​

readonly address: ActionPattern

The action's address in its channel ({route, method} for HTTP, {command} for CLI, the pattern for service), with its controller prefix.

dto ​

readonly dto: typeof DTO

The DTO validating the action's input (FlexibleDTO, accepting any input, when the action declares none).

returnSchema ​

readonly returnSchema: Schema | undefined

The schema of the action's result, declared with @Return; undefined without it.

Released under the MIT License.