UNPKG

spottydl

Version:

NodeJS Spotify Downloader without any API Keys or Authentication

github.com/thanatoslayer6/spottydl

thanatoslayer6/spottydl

33 lines (32 loc) • 2.26 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
import { Album, Track, Playlist, Results } from './index'; /** * Download the Spotify Track, need a <Track> type for first param, the second param is optional * @param {Track} obj An object of type <Track>, contains Track details and info * @param {string} outputPath - String type, (optional) if not specified the output will be on the current dir * @returns {Results[]} <Results[]> if successful, `string` if failed */ export declare const downloadTrack: (obj: Track, outputPath?: string) => Promise<Results[] | string>; /** * Download the Spotify Album, need a <Album> type for first param, the second param is optional, * function will return an array of <Results> * @param {Album} obj An object of type <Album>, contains Album details and info * @param {string} outputPath - String type, (optional) if not specified the output will be on the current dir * @param {boolean} sync - Boolean type, (optional) can be `true` or `false`. Default (true) is safer/less errors, for slower bandwidths * @returns {Results[]} <Results[]> if successful, `string` if failed */ export declare const downloadAlbum: (obj: Album, outputPath?: string, sync?: boolean) => Promise<Results[] | string>; /** * Download the Spotify Playlist, need a <Playlist> type for first param, the second param is optional, * function will return an array of <Results> * @param {Playlist} obj An object of type <Playlist>, contains Playlist details and info * @param {string} outputPath - String type, (optional) if not specified the output will be on the current dir * @returns {Results[]} <Results[]> if successful, `string` if failed */ export declare const downloadPlaylist: (obj: Playlist, outputPath?: string) => Promise<Results[] | string>; /** * Retries the download process if there are errors. Only use this after `downloadTrack()` or `downloadAlbum()` methods * checks for failed downloads then tries again, returns <Results[]> object array * @param {Results[]} Info An object of type <Results[]>, contains an array of results * @returns {Results[]} <Results[]> array if the download process is successful, `true` if there are no errors and `false` if an error happened. */ export declare const retryDownload: (Info: Results[]) => Promise<Results[] | boolean>;