@loontail/minecraft-kit v0.5.0 / TargetsApi

Class: TargetsApi

Public Targets API surface.

Constructors

new TargetsApi()

new TargetsApi(ctx): TargetsApi

Parameters

Parameter	Type
ctx	TargetsApiContext

Returns

TargetsApi

Source

src/targets/index.ts:70

Accessors

system

get system(): RuntimeSystem

The detected host system used by resolve() when no system is supplied.

Returns

RuntimeSystem

Source

src/targets/index.ts:73

Methods

create()

create(input): Target

Build a Target from already-resolved components.

Parameters

Parameter	Type
input	TargetCreateInput

Returns

Target

Source

src/targets/index.ts:78

---

list()

list(input): Promise<readonly DiscoveredTarget[]>

Scan a root directory for Minecraft installations. Returns only what is on disk.

Parameters

Parameter	Type
input	TargetListInput

Returns

Promise<readonly DiscoveredTarget[]>

Source

src/targets/index.ts:159

---

resolve()

resolve(input): Promise<Target>

Sugar API: resolve every component then assemble a target.

Parameters

Parameter	Type
input	TargetResolveInput

Returns

Promise<Target>

Source

src/targets/index.ts:107