@loontail/minecraft-kit / PauseController

Class: PauseController

Defined in: src/core/pause-controller.ts:21

Cooperative pause primitive. Consumers call waitWhilePaused at safe checkpoints. Independent from AbortSignal — abort wins at the next signal check.

Example

const pauseController = new PauseController();
const runPromise = kit.install.run(plan, { pauseController });

// Pause from a UI button click:
pauseController.pause();

// Resume later — the transfer continues from the chunk it parked on. There is no HTTP range
// resume: if the idle connection was dropped while paused, the file restarts from byte 0.
pauseController.resume();

await runPromise;

Constructors

Constructor

new PauseController(): PauseController;

Returns

PauseController

Accessors

paused

Get Signature

get paused(): boolean;

Defined in: src/core/pause-controller.ts:25

Returns

boolean

Methods

pause()

pause(): void;

Defined in: src/core/pause-controller.ts:29

Returns

void

---

resume()

resume(): void;

Defined in: src/core/pause-controller.ts:33

Returns

void

---

waitWhilePaused()

waitWhilePaused(): Promise<void>;

Defined in: src/core/pause-controller.ts:40

Returns

Promise<void>