Skip to content

@loontail/minecraft-kit / createInstallProgressTracker

Function: createInstallProgressTracker()

ts
function createInstallProgressTracker(plan, options?): InstallProgressTracker;

Defined in: src/install/progress-tracker.ts:179

Aggregate ProgressEvents from one install/repair run into throttled UI snapshots.

Parameters

ParameterType
planPick<InstallPlan, "actions">
optionsProgressTrackerOptions

Returns

InstallProgressTracker

Example

ts
import { createInstallProgressTracker, MinecraftKit } from "@loontail/minecraft-kit";

const tracker = createInstallProgressTracker(plan, { throttleMs: 100 });
tracker.subscribe(({ stage, stagePercent }) => console.log(stage, stagePercent));
await kit.install.run(plan, { onEvent: tracker.onEvent });
tracker.finish();

MIT License