Skip to content

Faimulus TypeScript API / @faimulus/driver-sdk / ChannelDriverDefinition

Interface: ChannelDriverDefinition ​

Factory and metadata exported by a trusted channel driver package.

Properties ​

actions? ​

readonly optional actions?: readonly ChannelActionDefinition[]


configSchema ​

readonly configSchema: JsonSchema


displayName ​

readonly displayName: string


outboundMessageSchema? ​

readonly optional outboundMessageSchema?: JsonSchema


outboundTargetSchema? ​

readonly optional outboundTargetSchema?: JsonSchema


type ​

readonly type: string

Methods ​

createChannel() ​

createChannel(context): ChannelInstance

Parameters ​

context ​

ChannelDriverContext

Returns ​

ChannelInstance

Documentation for the current repository state.