Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWorker

关于工作器的接口。

interface
version

1.0.0

Hierarchy

Implemented by

Index

Events

Properties

Methods

Events

STATE_CHANGED

STATE_CHANGED: string

表示当工作器状态改变后产生的事件。

Properties

canPauseAndContinue

canPauseAndContinue: boolean

获取工作器是否允许暂停和继续。

property

disabled

disabled: boolean

获取或设置是否禁用工作器。

property

name

name: string

获取当前工作器的名称。

property

state

state: WorkerState

获取当前工作器的状态。

property

Methods

addListener

  • addListener(type: string, listener: Function, scope?: any, once?: boolean): void

  • 为指定的事件类型注册一个侦听器，以使侦听器能够接收事件通知。

    summary

    如果不再需要某个事件侦听器，可调用 removeListener() 删除它，否则会产生内存问题。 由于垃圾回收器不会删除仍包含引用的对象，因此不会从内存中自动删除使用已注册事件侦听器的对象。

    Parameters

    • type: string

      事件类型。

    • listener: Function
    • Optional scope: any

      侦听函数绑定的 this 对象。

    • Optional once: boolean

      是否添加仅回调一次的事件侦听器，如果此参数设为 true 则在第一次回调时就自动移除监听。

    Returns void

    void

dispatchEvent

  • dispatchEvent(type: string, data?: any): void
  • dispatchEvent(args: EventArgs): void

hasListener

  • hasListener(type: string): boolean

  • 检查是否为特定事件类型注册了侦听器。

    Parameters

    • type: string

      事件类型。

    Returns boolean

    boolean 如果指定类型的侦听器已注册，则值为 true；否则，值为 false。

pause

  • pause(): Promise<void>

removeListener

  • removeListener(type: string, listener: Function, scope?: any): void

  • 移除侦听器。如果没有注册任何匹配的侦听器，则对此方法的调用没有任何效果。

    Parameters

    • type: string

      事件类型。

    • listener: Function

      处理事件的侦听器函数。

    • Optional scope: any

      侦听函数绑定的 this 对象。

    Returns void

    void

resume

  • resume(): Promise<void>

start

  • start(...args: Array<string>): Promise<void>

  • 启动工作器。

    async

    Parameters

    • Rest ...args: Array<string>

      启动的参数。

    Returns Promise<void>

    void

stop

  • stop(...args: Array<string>): Promise<void>

  • 停止工作器。

    async

    Parameters

    • Rest ...args: Array<string>

      停止的参数。

    Returns Promise<void>

    void

Generated using TypeDoc