Class Subscribe<T>

监听者模式

Example

new Subscribe<{
"foo": [arg1: number, arg2: string],
"bar": [arg: boolean],
}>()

Type Parameters

T extends SubscribeEventMap
预设的监听回调类型

Hierarchy (View Summary)

Index

Constructors

constructor

Methods

emit hasListener off on once waitUntil

Constructors

constructor

new Subscribe<T extends SubscribeEventMap>(): Subscribe<T>
Type Parameters
- T extends SubscribeEventMap
Returns Subscribe<T>

Methods

emit

emit<K extends string | number | symbol>(
name: K,
...data: Parameters<T[K]>,
): boolean
触发事件
Type Parameters
- K extends string | number | symbol
  预设的监听事件名称
Parameters
- name: K
  事件类型
- ...data: Parameters<T[K]>
  触发事件的数据
Returns boolean
canceled 是否被触发取消
- Defined in lib/five/utils/subscribe.ts:131

hasListener

hasListener(name: keyof T): boolean
判断是否注册了事件
Parameters
- name: keyof T
  事件类型
Returns boolean
- Defined in lib/five/utils/subscribe.ts:44

off

off<K extends string | number | symbol>(
name?: K,
callback?: (...args: Parameters<T[K]>) => ReturnType<T[K]>,
): void
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件
Type Parameters
- K extends string | number | symbol
  预设的监听事件名称
Parameters
- Optionalname: K
  事件类型
- Optionalcallback: (...args: Parameters<T[K]>) => ReturnType<T[K]>
  事件回调函数
Returns void
- Defined in lib/five/utils/subscribe.ts:97

on

on<K extends string | number | symbol>(
    name: K,
    callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>,
    once?: boolean,
): () => void
注册事件
Type Parameters
- K extends string | number | symbol
  预设的监听事件名称
Parameters
- name: K
  事件类型
- callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>
  事件回调函数
- Optionalonce: boolean
  是否只执行一次
Returns () => void
解除事件
- Defined in lib/five/utils/subscribe.ts:58

once

once<K extends string | number | symbol>(
name: K,
callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>,
): () => void
注册事件(是否只执行一次)
Type Parameters
- K extends string | number | symbol
  预设的监听事件名称
Parameters
- name: K
  事件类型
- callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>
  事件回调函数
Returns () => void
解除事件
- Defined in lib/five/utils/subscribe.ts:81

waitUntil

waitUntil<K extends string | number | symbol>(
name: K,
filter?: (...args: Parameters<T[K]>) => boolean | void,
): Promise<Parameters<T[K]>>
等待事件
Type Parameters
- K extends string | number | symbol
  预设的监听事件名称
Parameters
- name: K
  事件类型
- Optionalfilter: (...args: Parameters<T[K]>) => boolean | void
  事件类型
Returns Promise<Parameters<T[K]>>
触发事件的数据
- Defined in lib/five/utils/subscribe.ts:155

Class Subscribe<T>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns Subscribe<T>

Methods

emit

Type Parameters

Parameters

Returns boolean

hasListener

Parameters

Returns boolean

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

waitUntil

Type Parameters

Parameters

Returns Promise<Parameters<T[K]>>

Settings

On This Page