Class Event<T>

Type Parameters

  • T

Implements

  • PrivateEventInterface<T>

Properties

add asPromise once 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?, disposer?) => Promise<T>)

イベントが起きた時に Promise が resolve される

Type declaration

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

    • Parameters

      • Optional timeLimit: number

        ms

      • Optional disposer: PrivateEventDisposerInterface

      Returns Promise<T>

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

watch

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

イベントが起きた時に実行される boolean を返す関数を登録する。 登録した関数が true を返した時に Promise が resolve される

Type declaration

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

    • Parameters

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

          • Parameters

            • arg: T

            Returns undefined | null | boolean

      • Optional timeLimit: number
      • Optional disposer: PrivateEventDisposerInterface

      Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

addasPromiseoncewatch