andrade-soulseek-downloader
Version:
Simple, safe Soulseek download library with built-in rate limiting to prevent bans
24 lines • 984 B
TypeScript
/**
* Simple API function for downloading tracks.
* @param artist - Artist name
* @param title - Track title
* @param folderName - Optional subfolder name within SOULSEEK_DOWNLOAD_DIR
* @param customFileName - Optional custom filename (without extension)
* @returns Path to downloaded file or null if failed
*
* @example
* ```typescript
* import { soulseekDownload } from 'andrader-soulseek-downloader';
*
* // Basic usage
* const filePath = await soulseekDownload('Daft Punk', 'One More Time');
*
* // With custom folder
* const filePath2 = await soulseekDownload('Daft Punk', 'One More Time', 'Electronic');
*
* // With custom folder and filename
* const filePath3 = await soulseekDownload('Daft Punk', 'One More Time', 'Electronic', 'daft_punk_one_more_time');
* ```
*/
export declare function soulseekDownload(artist: string, title: string, folderName?: string, customFileName?: string): Promise<string | null>;
//# sourceMappingURL=soulseek-download.d.ts.map