Class Trigger<T>

constructor

• new Trigger<T>(): Trigger<T>

• Type Parameters

  • T = void

  Returns Trigger<T>

length

add

• add(func, owner?): void

• このTriggerにハンドラを追加する。

  Parameters

  • func: HandlerFunction<T>

    ハンドラの関数
  • Optionalowner: unknown

    ハンドラのオーナー。 func を呼び出す時に this として用いられる値

  Returns void
• add(params): void

• このTriggerにハンドラを追加する。

  Parameters

  • params: TriggerAddParameters<T>

    登録するハンドラの情報

  Returns void

addOnce

• addOnce(func, owner?): void

• このTriggerにハンドラを追加する。 本メソッドにより追加されたハンドラは実行後に破棄される。

  Parameters

  • func: HandlerFunction<T>

    ハンドラの関数
  • Optionalowner: unknown

    ハンドラのオーナー。 func を呼び出す時に this として用いられる値

  Returns void
• addOnce(params): void

• このTriggerにハンドラを追加する。 本メソッドにより追加されたハンドラは実行後に破棄される。

  Parameters

  • params: TriggerAddParameters<T>

    登録するハンドラの情報

  Returns void

contains

• contains(func, owner?): boolean

• 指定した条件に一致したハンドラが登録されているかを返す。 指定されなかった条件は、条件として無視される(登録時の値に関わらず一致するとみなされる)。

  Parameters

  • func: null | HandlerFunction<T>

    条件として用いるハンドラの関数
  • Optionalowner: unknown

    条件として用いるハンドラのオーナー

  Returns boolean
• contains(params): boolean

• 指定した条件に一致したハンドラが登録されているかを返す。 指定されなかった条件は、条件として無視される(登録時の値に関わらず一致するとみなされる)。

  Parameters

  • params: TriggerSearchConditions<T>

    検索の条件

  Returns boolean

destroy

• destroy(): void

• このTriggerを破棄する。

  Returns void

destroyed

• destroyed(): boolean

• このTriggerが破棄されているかを返す。

  Returns boolean

fire

• fire(arg): void

• このTriggerを発火する。

  登録された全ハンドラの関数を、引数 arg を与えて呼び出す。 呼び出し後、次のいずれかの条件を満たす全ハンドラの登録は解除される。

  • ハンドラが addOnce() で登録されていた場合
  • ハンドラが add() で登録される際に once: true オプションが与えられていた場合
  • ハンドラが Promise 以外の truthy な値を返した場合

  Parameters

  • arg: T

    ハンドラに与えられる引数

  Returns void

handle

• handle(owner, func?, name?): void

• このTriggerにハンドラを追加する。

  Parameters

  • owner: any
  • Optionalfunc: HandlerFunction<T>
  • Optionalname: string

  Returns void

  Deprecated

  互換性のために残されている。代わりに add() を利用すべきである。

remove

• remove(func, owner?): void

• 関数が func であり、かつオーナーが owner であるハンドラを削除する。 同じ組み合わせで複数登録されている場合、index が最も小さいハンドラのみ削除する。

  Parameters

  • func: HandlerFunction<T>

    削除条件として用いるハンドラの関数
  • Optionalowner: unknown

    削除条件として用いるハンドラのオーナー。省略した場合、 undefined

  Returns void
• remove(params): void

• 指定した条件に完全一致するハンドラを削除する。 同じ組み合わせで複数登録されている場合、index が最も小さいハンドラのみ削除する。

  Parameters

  • params: TriggerRemoveConditions<T>

    削除するハンドラの条件

  Returns void

removeAll

• removeAll(params?): void

• 指定した条件に部分一致するイベントハンドラを削除する。

  本メソッドは引数に与えた条件に一致したイベントハンドラを全て削除する。 引数の条件を一部省略した場合、その値の内容が登録時と異なっていても対象のイベントハンドラは削除される。 引数に与えた条件と完全に一致したイベントハンドラのみを削除したい場合は this.remove() を用いる。 引数を省略した場合は全てのイベントハンドラを削除する。

  Parameters

  • Optionalparams: TriggerRemoveConditions<T>

    削除するイベントハンドラの条件

  Returns void