Interface AssetsOptions

Change the host url of assets download

🏷️ Properties

assetsDownloadConcurrency optional

assetsDownloadConcurrency: number

Control how many assets download task should run at the same time. It will override the maxConcurrencyOption if this is presented.

This will be ignored if you have your own downloader assigned.

Defined in: packages/installer/minecraft.ts:135

assetsHost optional

assetsHost: string | string[]

The alternative assets host to download asset. It will try to use these host from the [0] to the [assetsHost.length - 1]

Defined in: packages/installer/minecraft.ts:128

assetsIndexUrl optional

assetsIndexUrl: string | string[] | (version: ResolvedVersion) => string | string[]

The assets index download or url replacement

Defined in: packages/installer/minecraft.ts:143

checkpointHandler optional

checkpointHandler: CheckpointHandler

The checkpoint handler to save & restore the download progress Inherited from: DownloadBaseOptions.checkpointHandler

Defined in: packages/file-transfer/download.ts:52

checksumValidatorResolver optional

checksumValidatorResolver: (checksum: ChecksumValidatorOptions) => Validator

Defined in: packages/installer/minecraft.ts:147

dispatcher optional

dispatcher: Dispatcher

The undici dispatcher Inherited from: DownloadBaseOptions.dispatcher

Defined in: packages/file-transfer/download.ts:48

fetch optional

fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Defined in: packages/installer/minecraft.ts:145

headers optional

headers: Record<string, any>

The header of the request Inherited from: DownloadBaseOptions.headers

Defined in: packages/file-transfer/download.ts:40

prevalidSizeOnly optional

prevalidSizeOnly: boolean

Only precheck the size of the assets. Do not check the hash.

Defined in: packages/installer/minecraft.ts:151

rangePolicy optional

rangePolicy: RangePolicy

The range policy to compute the ranges to download Inherited from: DownloadBaseOptions.rangePolicy

Defined in: packages/file-transfer/download.ts:44

skipHead optional

skipHead: boolean

Inherited from: DownloadBaseOptions.skipHead

Defined in: packages/file-transfer/download.ts:54

skipPrevalidate optional

skipPrevalidate: boolean

Inherited from: DownloadBaseOptions.skipPrevalidate

Defined in: packages/file-transfer/download.ts:58

skipRevalidate optional

skipRevalidate: boolean

Inherited from: DownloadBaseOptions.skipRevalidate

Defined in: packages/file-transfer/download.ts:56

throwErrorImmediately optional

throwErrorImmediately: boolean

Inherited from: ParallelTaskOptions.throwErrorImmediately

Defined in: packages/installer/utils.ts:97

useHashForAssetsIndex optional

useHashForAssetsIndex: boolean

Use hash as the assets index file name. Default is false

Defined in: packages/installer/minecraft.ts:139