@loontail/minecraft-kit / MinecraftVersionsApi

Class: MinecraftVersionsApi

Defined in: src/versions/minecraft.ts:78

Public Minecraft versions API surface.

Available off a kit instance as kit.versions.minecraft.

Example

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

const kit = new MinecraftKit();
const latest = await kit.versions.minecraft.latest();
const resolved = await kit.versions.minecraft.resolve({ version: latest.id });

Constructors

Constructor

new MinecraftVersionsApi(ctx): MinecraftVersionsApi;

Defined in: src/versions/minecraft.ts:79

Parameters

Parameter	Type
ctx	ResolverContext

Returns

MinecraftVersionsApi

Methods

get()

get(input): Promise<MinecraftVersionSummary>;

Defined in: src/versions/minecraft.ts:103

Return a single version summary or throw MANIFEST_NOT_FOUND.

Parameters

Parameter	Type
input	MinecraftGetInput

Returns

Promise<MinecraftVersionSummary>

---

latest()

latest(input?): Promise<MinecraftVersionSummary>;

Defined in: src/versions/minecraft.ts:89

Return the latest version on the given channel (defaults to RELEASE).

Parameters

Parameter	Type
input	MinecraftLatestInput

Returns

Promise<MinecraftVersionSummary>

---

list()

list(input?): Promise<readonly MinecraftVersionSummary[]>;

Defined in: src/versions/minecraft.ts:82

List all Minecraft versions, optionally filtered by channel.

Parameters

Parameter	Type
input	MinecraftListInput

Returns

Promise<readonly MinecraftVersionSummary[]>

---

resolve()

resolve(input): Promise<ResolvedMinecraft>;

Defined in: src/versions/minecraft.ts:117

Fetch and parse the per-version manifest in addition to the summary.

Parameters

Parameter	Type
input	MinecraftGetInput

Returns

Promise<ResolvedMinecraft>