@pumpkin-plugins/port-mapping API / task / Task

Class: Task<T>

Defined in: tools/port-mapping/src/task.ts:11

Runs Steps one step per poll.

Type Parameters

T

T

Constructors

Constructor

new Task<T>(steps): Task<T>

Defined in: tools/port-mapping/src/task.ts:15

Wraps the steps. Nothing runs until poll.

Parameters

steps

Steps<T>

Returns

Task<T>

Methods

cancel()

cancel(): void

Defined in: tools/port-mapping/src/task.ts:30

Stops the work and lets it clean up (its finally blocks run).

Returns

void

---

poll()

poll(): TaskState<T>

Defined in: tools/port-mapping/src/task.ts:18

Runs the work up to its next wait, and reports where it stands.

Returns

TaskState<T>