EventNameFilter interface

Filter events by their name.

Extends

Properties

systemEvents

Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.

type

Polymorphic discriminator, which specifies the different types this object can be

userEventPattern

Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

Property Details

systemEvents

Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.

systemEvents?: string[]

Property Value

string[]

type

Polymorphic discriminator, which specifies the different types this object can be

type: "EventName"

Property Value

"EventName"

userEventPattern

Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

userEventPattern?: string

Property Value

string