Interface EventInterface<T>

interface EventInterface<T> {
    add: ((callback) => {
        disposer: ((disposer) => void);
        removeListener: (() => void);
    });
    asPromise: ((timeLimit?) => Promise<T>);
    emit: ((arg) => void);
    once: ((callback) => {
        disposer: ((disposer) => void);
        removeListener: (() => void);
    });
    removeAllListeners: (() => void);
    watch: ((callback, timeLimit?) => Promise<T>);
}

Type Parameters

  • T extends any

Implemented by

Properties

add asPromise emit once removeAllListeners watch

Properties

add

add: ((callback) => {
    disposer: ((disposer) => void);
    removeListener: (() => void);
})

Type declaration

    • (callback): {
          disposer: ((disposer) => void);
          removeListener: (() => void);
      }

    • Parameters

      • callback: ((args) => void)
          • (args): void

          • Parameters

            • args: T

            Returns void

      Returns {
          disposer: ((disposer) => void);
          removeListener: (() => void);
      }

      • disposer: ((disposer) => void)
          • (disposer): void

          • Parameters

            • disposer: EventDisposerInterface

            Returns void

      • removeListener: (() => void)
          • (): void

          • Returns void

asPromise

asPromise: ((timeLimit?) => Promise<T>)

Type declaration

    • (timeLimit?): Promise<T>

    • Parameters

      • Optional timeLimit: number

      Returns Promise<T>

emit

emit: ((arg) => void)

Type declaration

    • (arg): void

    • Parameters

      • arg: T

      Returns void

once

once: ((callback) => {
    disposer: ((disposer) => void);
    removeListener: (() => void);
})

Type declaration

    • (callback): {
          disposer: ((disposer) => void);
          removeListener: (() => void);
      }

    • Parameters

      • callback: ((arg) => void)
          • (arg): void

          • Parameters

            • arg: T

            Returns void

      Returns {
          disposer: ((disposer) => void);
          removeListener: (() => void);
      }

      • disposer: ((disposer) => void)
          • (disposer): void

          • Parameters

            • disposer: EventDisposerInterface

            Returns void

      • removeListener: (() => void)
          • (): void

          • Returns void

removeAllListeners

removeAllListeners: (() => void)

Type declaration

    • (): void

    • Returns void

watch

watch: ((callback, timeLimit?) => Promise<T>)

Type declaration

    • (callback, timeLimit?): Promise<T>

    • Parameters

      • callback: ((arg) => undefined | null | boolean)
          • (arg): undefined | null | boolean

          • Parameters

            • arg: T

            Returns undefined | null | boolean

      • Optional timeLimit: number

      Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

addasPromiseemitonceremoveAllListenerswatch