Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventHandlerRegistration<EVENT, PARAMS>

Type for registering event handlers.

Type parameters

  • EVENT

  • PARAMS

Hierarchy

  • EventHandlerRegistration

Index

Properties

Optional description

description: string

Optional description of the event handler.

listener

listener: OnEvent<EVENT, PARAMS>

Listener to receive subscription matches.

name

name: string

Name of the event handler.

Optional parameters

parameters: ParametersDefinition<PARAMS>

Define parameters used by this command. Alternative to using paramsMaker: Do not supply both.

Optional paramsMaker

paramsMaker: Maker<PARAMS>

Create the parameters required by this command. Empty parameters will be returned by default.

deprecated

use parameters

subscription

subscription: string

GraphQL subscription to subscribe this listener to. Note: Use GraphQL.subscription() methods of automation-client to create the subscription string

Optional tags

tags: string | string[]

Optional tags of the event handler.

Generated using TypeDoc