@loontail/minecraft-kit v0.8.14 / PauseController

Class: PauseController

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 — in-flight downloads finish; queued actions wait for resume():
pauseController.resume();

await runPromise;

Constructors

new PauseController()

new PauseController(): PauseController

Returns

PauseController

Accessors

paused

get paused(): boolean

Returns

boolean

Source

src/core/pause-controller.ts:24

Methods

pause()

pause(): void

Returns

void

Source

src/core/pause-controller.ts:28

---

resume()

resume(): void

Returns

void

Source

src/core/pause-controller.ts:32

---

waitWhilePaused()

waitWhilePaused(): Promise<void>

Returns

Promise<void>

Source

src/core/pause-controller.ts:39