Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmitterOptions

Options used for constructing Emitters

Hierarchy

  • EmitterOptions

Index

Properties

Optional allowedEvents

allowedEvents: string[]

A list of allowed events

Optional callback

callback: StreamCallback

An optional callback that is registered with the Stream during creation when event is specified.

see

Stream.on for details

Optional event

event: string | CallbackMap

An event that is registered with the Stream during creation.

see

Stream.on for details. If no event is specified the stream will be created without any pre-registered events.

Optional listeners

listeners: Listeners

The listeners object mapping event names to arrays of callback functions. Must be specified if a stream is provided.

Optional stream

stream: StreamImpl

Set up the emitter with an existing stream