WaterfallEvent <Arg, Scope>

Hierarchy

• BaseEvent<Arg, [Arg], Scope>
  • WaterfallEvent

Index

Constructors

• constructor

Properties

• listeners
• name

Methods

• clearListeners
• emit
• getListeners
• getScopes
• listen
• once
• unlisten

Constructors

constructor

• new WaterfallEvent<Arg, Scope>(name: string): WaterfallEvent<Arg, Scope>

• Inherited from BaseEvent.constructor

  Type parameters

  • Arg
  • Scope: string = string

Properties

listeners

listeners: Map<* | Scope, Set<(a1: Arg) => Arg>> = ...

Inherited from BaseEvent.listeners

name

name: string

Inherited from BaseEvent.name

Methods

clearListeners

• clearListeners(scope?: Scope): this

• Inherited from BaseEvent.clearListeners

  Remove all listeners from the event.

emit

• emit(arg: Arg, scope?: Scope): Arg

• Overrides BaseEvent.emit

  Synchronously execute listeners with the defined argument value. The return value of each listener will be passed as an argument to the next listener.

getListeners

• getListeners(scope?: Scope): Set<(a1: Arg) => Arg>

• Inherited from BaseEvent.getListeners

  Return a set of listeners for a specific event scope.

getScopes

• getScopes(): (* | Scope)[]

• Inherited from BaseEvent.getScopes

  Return a list of all scopes with listeners.

listen

• listen(listener: (a1: Arg) => Arg, scope?: Scope): Unlistener

• Inherited from BaseEvent.listen

  Register a listener to the event.

once

• once(listener: (a1: Arg) => Arg, scope?: Scope): Unlistener

• Inherited from BaseEvent.once

  Register a listener to the event that only triggers once.

unlisten

• unlisten(listener: (a1: Arg) => Arg, scope?: Scope): this

• Inherited from BaseEvent.unlisten

  Remove a listener from the event.