Download API

The DownloadManager class manages the download queue, supporting progress display and batch downloads.

Import

import { const download: DownloadManagerdownload } from 'music-getter';

download is a singleton instance of DownloadManager that can be used directly.

Methods

add

Add a download task to the queue.

declare class class DownloadManagerDownloadManager {
  DownloadManager.add(url: string | (() => Promise<string>), output: string): voidadd(url: string | (() => Promise<string>)url: string | (() => interface Promise<T>Represents the completion of an asynchronous operationPromise<string>), output: stringoutput: string): void;
}

Parameter	Type	Description
`url`	`string \| (() => Promise<string>)`	Download URL, can be a string or an async function returning a string
`output`	`string`	Output file path

startAll

Execute all download tasks.

declare class class DownloadManagerDownloadManager {
  DownloadManager.startAll(): Promise<void>startAll(): interface Promise<T>Represents the completion of an asynchronous operationPromise<void>;
}

Real-time progress bars are displayed during the download process:

Downloading 1/3:
  File: Daylight-David Kushner.mp3
 ████████████████████ 100% | 3500000/3500000 bytes | ETA: 0s

Downloading 2/3:
  File: Blue and White Porcelain-Jay Chou.mp3
 ████████████████░░░░ 80% | 2800000/3500000 bytes | ETA: 2s

All downloads finished!

clear

Clear the download queue.

declare class class DownloadManagerDownloadManager {
  DownloadManager.clear(): voidclear(): void;
}

getCount

Get the number of tasks in the queue.

declare class class DownloadManagerDownloadManager {
  DownloadManager.getCount(): numbergetCount(): number;
}

Complete Examples

Download a Single Song

import { class MetingMeting, const download: DownloadManagerdownload } from 'music-getter';

const const meting: Metingmeting = new new Meting(server?: string): MetingMeting('netease');
const meting: Metingmeting.Meting.format(enable: boolean): Metingformat(true);

const const song: anysong = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.song(id: string | number): Promise<string>song('1372188635'));

const download: DownloadManagerdownload.DownloadManager.add(url: string | (() => Promise<string>), output: string): voidadd(const song: anysong[0].url_id, './Daylight.mp3');
await const download: DownloadManagerdownload.DownloadManager.startAll(): Promise<void>startAll();

Batch Download a Playlist

import { class MetingMeting, const download: DownloadManagerdownload } from 'music-getter';

const const meting: Metingmeting = new new Meting(server?: string): MetingMeting('netease');
const meting: Metingmeting.Meting.format(enable: boolean): Metingformat(true);

const const songs: anysongs = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.playlist(id: string | number): Promise<string>playlist('7697114803'));

for (const const song: anysong of const songs: anysongs) {
  const const filename: stringfilename = `${const song: anysong.name}-${const song: anysong.artist.join(',')}.mp3`;
  const download: DownloadManagerdownload.DownloadManager.add(url: string | (() => Promise<string>), output: string): voidadd(const song: anysong.url_id, `./downloads/${const filename: stringfilename}`);
}

var console: Consoleconsole.Console.log(...data: any[]): voidThe console.log() static method outputs a message to the console.
MDN Referencelog(`Preparing to download ${const download: DownloadManagerdownload.DownloadManager.getCount(): numbergetCount()} songs`);
await const download: DownloadManagerdownload.DownloadManager.startAll(): Promise<void>startAll();

Using Dynamic URLs

import { class MetingMeting, const download: DownloadManagerdownload } from 'music-getter';

const const meting: Metingmeting = new new Meting(server?: string): MetingMeting('netease');
const meting: Metingmeting.Meting.format(enable: boolean): Metingformat(true);

const const song: anysong = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.song(id: string | number): Promise<string>song('1372188635'));

// Use an async function to dynamically get the URL
const download: DownloadManagerdownload.DownloadManager.add(url: string | (() => Promise<string>), output: string): voidadd(async () => {
  const const urlData: anyurlData = var JSON: JSONAn intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.JSON.JSON.parse(text: string, reviver?: (this: any, key: string, value: any) => any): anyConverts a JavaScript Object Notation (JSON) string into an object.
@paramtext  A valid JSON string.@paramreviver  A function that transforms the results. This function is called for each member of the object.
If a member contains nested objects, the nested objects are transformed before the parent object is.@throws{SyntaxError} If text is not valid JSON.parse(await const meting: Metingmeting.Meting.url(id: string | number, bitrate?: number): Promise<string>url(const song: anysong[0].id, 320));
  return const urlData: anyurlData[0].url;
}, './Daylight.mp3');

await const download: DownloadManagerdownload.DownloadManager.startAll(): Promise<void>startAll();

Notes

Download tasks are executed sequentially in the order they were added
Illegal characters in filenames are automatically replaced with underscores
Output directories are created automatically if they don't exist
Progress bars are only displayed when the server returns a Content-Length header

#Download API

#Import

#Methods

#add

#startAll

#clear

#getCount

#Complete Examples

#Download a Single Song

#Batch Download a Playlist

#Using Dynamic URLs

#Notes