Class Task<ResultState, UpdateState>

Type Parameters

ResultState extends State
UpdateState extends State

Hierarchy

EventEmitter
- Task

Index

Constructors

constructor

new Task<ResultState, UpdateState>(promise: Promise<ResultState>, state?: UpdateState): Task<ResultState, UpdateState>
Type Parameters
- ResultState extends State
- UpdateState extends State
Parameters
- promise: Promise<ResultState>
- Optional state: UpdateState
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.constructor
- Defined in packages/task/src/task.ts:12

Properties

complete

complete: Promise<boolean>

completed

completed: boolean

promise

promise: Promise<void | ResultState>

`Optional` result

result?: ResultState

state

state: UpdateState

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): Task<ResultState, UpdateState>
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns Task<ResultState, UpdateState>
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:45

emit

emit<T>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:20

off

off(event: "update", listener: ((state: UpdateState) => void)): Task<ResultState, UpdateState>
Parameters
- event: "update"
- listener: ((state: UpdateState) => void)
  - - (state: UpdateState): void
    - Parameters
      
      state: UpdateState
      
      Returns void
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.off
- Defined in packages/task/src/task.ts:73
off(event: "complete", listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)): Task<ResultState, UpdateState>
Parameters
- event: "complete"
- listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)
  - - <T>(success: T, result: T extends true ? ResultState : any): void
    - Type Parameters
      
      T extends boolean
      
      Parameters
      
      success: T
      
      result: T extends true ? ResultState : any
      
      Returns void
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.off
- Defined in packages/task/src/task.ts:74

on

on(event: "update", listener: ((state: UpdateState) => void)): Task<ResultState, UpdateState>
Parameters
- event: "update"
- listener: ((state: UpdateState) => void)
  - - (state: UpdateState): void
    - Parameters
      
      state: UpdateState
      
      Returns void
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.on
- Defined in packages/task/src/task.ts:49
on(event: "complete", listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)): Task<ResultState, UpdateState>
Parameters
- event: "complete"
- listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)
  - - <T>(success: T, result: T extends true ? ResultState : any): void
    - Type Parameters
      
      T extends boolean
      
      Parameters
      
      success: T
      
      result: T extends true ? ResultState : any
      
      Returns void
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.on
- Defined in packages/task/src/task.ts:50

once

once(event: "update", listener: ((state: UpdateState) => void)): Task<ResultState, UpdateState>
Parameters
- event: "update"
- listener: ((state: UpdateState) => void)
  - - (state: UpdateState): void
    - Parameters
      
      state: UpdateState
      
      Returns void
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.once
- Defined in packages/task/src/task.ts:61
once(event: "complete", listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)): Task<ResultState, UpdateState>
Parameters
- event: "complete"
- listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)
  - - <T>(success: T, result: T extends true ? ResultState : any): void
    - Type Parameters
      
      T extends boolean
      
      Parameters
      
      success: T
      
      result: T extends true ? ResultState : any
      
      Returns void
Returns Task<ResultState, UpdateState>
Overrides EventEmitter.once
- Defined in packages/task/src/task.ts:62

removeAllListeners

removeAllListeners(event?: string | symbol): Task<ResultState, UpdateState>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns Task<ResultState, UpdateState>
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): Task<ResultState, UpdateState>
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Task<ResultState, UpdateState>
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:63

update

update(trans: UpdateState | Promise<UpdateState> | ((state: UpdateState) => UpdateState | Promise<UpdateState>)): Promise<void>
Parameters
- trans: UpdateState | Promise<UpdateState> | ((state: UpdateState) => UpdateState | Promise<UpdateState>)
Returns Promise<void>
- Defined in packages/task/src/task.ts:35

Class Task<ResultState, UpdateState>

Type Parameters

ResultState extends State

UpdateState extends State

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

ResultState extends State

UpdateState extends State

Parameters

promise: Promise<ResultState>

Optional state: UpdateState

Returns Task<ResultState, UpdateState>

Properties

complete

completed

promise

Optional result

state

Static prefixed

Methods

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns Task<ResultState, UpdateState>

emit

Type Parameters

T extends string | symbol

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Type Parameters

T extends string | symbol

Parameters

event: T

Returns ((...args: any[]) => void)[]

off

Parameters

event: "update"

listener: ((state: UpdateState) => void)

Parameters

state: UpdateState

Returns void

Returns Task<ResultState, UpdateState>

Parameters

event: "complete"

listener: (<T>(success: T, result: T extends true ? ResultState : any) => void)

Type Parameters

T extends boolean

Parameters

success: T

result: T extends true ? ResultState : any

Returns void

Returns Task<ResultState, UpdateState>

on

Parameters

event: "update"

listener: ((state: UpdateState) => void)

Parameters

state: UpdateState

`Optional` state: UpdateState

`Optional` result

`Static` prefixed

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` event: string | symbol

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean