Options
All
  • Public
  • Public/Protected
  • All
Menu

SpinalEventEmitter is a singleton class that allows to emit and listen to events

export

Hierarchy

  • SpinalEventEmitter

Index

Constructors

Properties

emit: { <Key>(type: Key, event: Record<EventType, unknown>[Key]): void; <Key>(type: undefined extends Record<EventType, unknown>[Key] ? Key : never): void } = ...

Type declaration

    • <Key>(type: Key, event: Record<EventType, unknown>[Key]): void
    • <Key>(type: undefined extends Record<EventType, unknown>[Key] ? Key : never): void
    • Type Parameters

      • Key extends EventType

      Parameters

      • type: Key
      • event: Record<EventType, unknown>[Key]

      Returns void

    • Type Parameters

      • Key extends EventType

      Parameters

      • type: undefined extends Record<EventType, unknown>[Key] ? Key : never

      Returns void

emitter: Emitter<Record<EventType, unknown>> = ...
off: { <Key>(type: Key, handler?: Handler<Record<EventType, unknown>[Key]>): void; (type: "*", handler: WildcardHandler<Record<EventType, unknown>>): void } = ...

Type declaration

    • <Key>(type: Key, handler?: Handler<Record<EventType, unknown>[Key]>): void
    • (type: "*", handler: WildcardHandler<Record<EventType, unknown>>): void
    • Type Parameters

      • Key extends EventType

      Parameters

      • type: Key
      • Optional handler: Handler<Record<EventType, unknown>[Key]>

      Returns void

    • Parameters

      • type: "*"
      • handler: WildcardHandler<Record<EventType, unknown>>

      Returns void

on: { <Key>(type: Key, handler: Handler<Record<EventType, unknown>[Key]>): void; (type: "*", handler: WildcardHandler<Record<EventType, unknown>>): void } = ...

Type declaration

    • <Key>(type: Key, handler: Handler<Record<EventType, unknown>[Key]>): void
    • (type: "*", handler: WildcardHandler<Record<EventType, unknown>>): void
    • Type Parameters

      • Key extends EventType

      Parameters

      • type: Key
      • handler: Handler<Record<EventType, unknown>[Key]>

      Returns void

    • Parameters

      • type: "*"
      • handler: WildcardHandler<Record<EventType, unknown>>

      Returns void

Methods

  • waitEvt(evt: string): Promise<any>

Generated using TypeDoc