Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkerBase

关于工作器的抽象类。 实现子类应当重写 onStart onStop 这两个方法。

abstract
class
version

1.0.0 jason

Hierarchy

Implements

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

Protected constructor

Events

STATE_CHANGED

STATE_CHANGED: string = "stateChanged"

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

Properties

Private _canPauseAndContinue

_canPauseAndContinue: boolean

Private _disabled

_disabled: boolean

Private _name

_name: string

Private _state

_state: WorkerState

Accessors

canPauseAndContinue

  • get canPauseAndContinue(): boolean
  • set canPauseAndContinue(value: boolean): void

disabled

  • get disabled(): boolean
  • set disabled(value: boolean): void

name

  • get name(): string

state

Methods

addListener

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

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

    summary

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

    Parameters

    • type: string

      事件类型。

    • listener: Function
    • Default value scope: any = this

      侦听函数绑定的 this 对象。

    • Default value once: boolean = false

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

    Returns void

    void

dispatchEvent

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

hasListener

  • hasListener(type: string): boolean

Protected onPause

  • onPause(): Promise<void>

Protected onResume

  • onResume(): Promise<void>

Protected Abstract onStart

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

  • 当工作器启动时调用。

    abstract
    async

    Parameters

    • Rest ...args: Array<string>

    Returns Promise<void>

    void

Protected onStateChanged

Protected Abstract onStop

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

  • 当工作器停止时调用。

    abstract
    async

    Parameters

    • Rest ...args: Array<string>

    Returns Promise<void>

    void

pause

  • pause(): Promise<void>

removeListener

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

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

    Parameters

    • type: string

      事件类型。

    • listener: Function

      处理事件的侦听器函数。

    • Default value scope: any = this

      侦听函数绑定的 this 对象。

    Returns void

    void

resume

  • resume(): Promise<void>

start

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

stop

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

Generated using TypeDoc