@loontail/minecraft-kit v0.8.14 / InstallRunOptions

Type alias: InstallRunOptions

type InstallRunOptions: OperationOptions & {
  actionCategories: ReadonlySet<DownloadAction["category"]>;
  pauseController: PauseController;
};

Options accepted by install.run (and install.runtime.run).

Example

import { PauseController, type InstallRunOptions } from "@loontail/minecraft-kit";

const pauseController = new PauseController();
const controller = new AbortController();
const options: InstallRunOptions = {
  pauseController,
  signal: controller.signal,
  onEvent: (e) => console.log(e.type),
};
await kit.install.run(plan, options);

Type declaration

Member	Type	Description
actionCategories	ReadonlySet<DownloadAction["category"]>	Filter the run to a subset of action categories. Useful for partial reinstalls (e.g. assets-only). When omitted, every action in the plan runs. Example import { DownloadCategories } from "@loontail/minecraft-kit"; await kit.install.run(plan, { actionCategories: new Set([ DownloadCategories.CLIENT_JAR, DownloadCategories.LIBRARY, DownloadCategories.ASSET_INDEX, DownloadCategories.ASSET, ]), });
pauseController	PauseController	Cooperative pause/resume primitive — see PauseController. The runner checks the pause state at every stage boundary and between download chunks.

Source

src/kit/install-aspect.ts:47