Skip to content

Commit e1d3a96

Browse files
committed
docs: update the webdoc
1 parent bc38b6e commit e1d3a96

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/site/definitions.js

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1340,6 +1340,7 @@ export interface Version {
13401340
* The forge version (without minecraft version)
13411341
*/
13421342
version: string;
1343+
type?: "buggy" | "recommended" | "common" | "latest";
13431344
}
13441345
export declare const DEFAULT_FORGE_MAVEN = "http://files.minecraftforge.net";
13451346
export interface InstallProfile {
@@ -1440,15 +1441,9 @@ import * as LiteLoaderInstaller from "./liteloader";
14401441
import * as ForgeInstaller from "./forge";
14411442
import * as Installer from "./minecraft";
14421443
import * as Diagnosis from "./diagnose";
1444+
export { JavaExecutor } from "./util";
14431445
export { Installer, ForgeInstaller, LiteLoaderInstaller, FabricInstaller, Diagnosis };
14441446
`;
1445-
module.exports['@xmcl/installer/java.d.ts'] = `/// <reference types="node" />
1446-
import { ExecOptions } from "child_process";
1447-
export declare type JavaExecutor = (args: string[], option?: ExecOptions) => Promise<any>;
1448-
export declare namespace JavaExecutor {
1449-
function createSimple(javaPath: string, defaultOptions?: ExecOptions): JavaExecutor;
1450-
}
1451-
`;
14521447
module.exports['@xmcl/installer/liteloader.d.ts'] = `import { MinecraftLocation } from "@xmcl/core";
14531448
import { Task } from "@xmcl/task";
14541449
import { UpdatedObject } from "./util";
@@ -1638,7 +1633,9 @@ export interface JarOption extends DownloaderOption {
16381633
}
16391634
export declare type Option = AssetsOption & JarOption & LibraryOption;
16401635
/**
1641-
* Install the Minecraft game to a location by version metadata
1636+
* Install the Minecraft game to a location by version metadata.
1637+
*
1638+
* This will install version json, version jar, and all dependencies (assets, libraries)
16421639
*
16431640
* @param type The type of game, client or server
16441641
* @param versionMeta The version metadata
@@ -1649,6 +1646,8 @@ export declare function install(type: "server" | "client", versionMeta: Version,
16491646
/**
16501647
* Install the Minecraft game to a location by version metadata
16511648
*
1649+
* This will install version json, version jar, and all dependencies (assets, libraries)
1650+
*
16521651
* Tasks emmitted:
16531652
* - install
16541653
* - installVersion
@@ -1668,7 +1667,7 @@ export declare function install(type: "server" | "client", versionMeta: Version,
16681667
*/
16691668
export declare function installTask(type: "server" | "client", versionMeta: Version, minecraft: MinecraftLocation, option?: Option): Task<ResolvedVersion>;
16701669
/**
1671-
* Only install the json/jar. Do not check dependencies;
1670+
* Only install the json/jar. Do not install dependencies.
16721671
*
16731672
* @param type client or server
16741673
* @param versionMeta the version metadata; get from updateVersionMeta
@@ -1689,7 +1688,7 @@ export declare function installVersion(type: "client" | "server", versionMeta: V
16891688
*/
16901689
export declare function installVersionTask(type: "client" | "server", versionMeta: Version, minecraft: MinecraftLocation, option?: JarOption): Task<ResolvedVersion>;
16911690
/**
1692-
* Install the completeness of the Minecraft game assets and libraries.
1691+
* Install the completeness of the Minecraft game assets and libraries on a existed version.
16931692
*
16941693
* @param version The resolved version produced by Version.parse
16951694
* @param minecraft The minecraft location

0 commit comments

Comments
 (0)