@loontail/minecraft-kit / InstallAspect

Type Alias: InstallAspect

type InstallAspect = {
  runtime: {
     plan: Promise<InstallPlan>;
     planStandalone: Promise<InstallPlan>;
     run: Promise<InstallReport>;
  };
  plan: Promise<InstallPlan>;
  run: Promise<InstallReport>;
};

Defined in: src/kit/install-aspect.ts:85

Shape of kit.install. Consumers usually access this through kit.install; the alias is exported so the facade documentation can show the concrete surface.

Properties

Property	Modifier	Type	Defined in
runtime	readonly	{ plan: Promise<InstallPlan>; planStandalone: Promise<InstallPlan>; run: Promise<InstallReport>; }	src/kit/install-aspect.ts:99
runtime.plan	public	Promise<InstallPlan>	src/kit/install-aspect.ts:100
runtime.planStandalone	public	Promise<InstallPlan>	src/kit/install-aspect.ts:102
runtime.run	public	Promise<InstallReport>	src/kit/install-aspect.ts:101

Methods

plan()

plan(target, options?): Promise<InstallPlan>;

Defined in: src/kit/install-aspect.ts:97

Build the install plan for a target. Side-effect-free for vanilla and Fabric.

Forge is the exception: planning materialises the Forge installer JAR and extracts its embedded Maven artifacts to libraries/, because the per-library and processor actions can only be enumerated after reading the installer's install_profile.json from disk. Do not treat plan(forgeTarget) as a pure dry-run — it requires disk, and network on the first call for a given Forge version. Repeat calls reuse the installer already on disk and skip the Maven flush, so plan is cheap to call again; the installer is never emitted as a plan action, so run never re-downloads it.

Parameters

Parameter	Type
target	Target
options?	OperationOptions

Returns

Promise<InstallPlan>

---

run()

run(plan, options?): Promise<InstallReport>;

Defined in: src/kit/install-aspect.ts:98

Parameters

Parameter	Type
plan	InstallPlan
options?	InstallRunOptions

Returns

Promise<InstallReport>