Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rn0x/downlib
A powerful library for downloading videos and files from various platforms.
https://github.com/rn0x/downlib
dailymotion download facebook instagram javascript library reddit soundcloud tiktok twitter youtube yt-dlp
Last synced: about 1 month ago
JSON representation
A powerful library for downloading videos and files from various platforms.
- Host: GitHub
- URL: https://github.com/rn0x/downlib
- Owner: rn0x
- License: mit
- Created: 2024-06-25T02:36:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-02T00:21:02.000Z (4 months ago)
- Last Synced: 2024-09-27T11:42:35.006Z (about 2 months ago)
- Topics: dailymotion, download, facebook, instagram, javascript, library, reddit, soundcloud, tiktok, twitter, youtube, yt-dlp
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/downlib
- Size: 50.5 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Downlib
Downlib is a Node.js class for downloading content from various popular websites such as YouTube, Instagram, and TikTok. It uses tools like `yt-dlp` for YouTube downloads and handles downloading media from Instagram and TikTok.
[](https://github.com/rn0x/downlib/blob/main/LICENSE)
[](https://badge.fury.io/js/downlib)
## Installation
To use Downlib, first install it via npm:
```bash
npm install downlib
```
## Usage
### Example Usage
```javascript
import Downlib from 'downlib';
// Initialize Downlib with optional configurations
const downlib = new Downlib({
ytDlpPath: '', // Optional: Specify the path for yt-dlp if needed
deleteAfterDownload: true,
});
// Example: Download a video from YouTube
const youtubeUrl = 'https://www.youtube.com/watch?v=yourvideoid';
const saveDir = './downloads';
downlib.downloadFromYouTube(youtubeUrl, saveDir, { audioOnly: false })
.then((result) => {
console.log('Downloaded video information:', result);
})
.catch((error) => {
console.error('Error downloading video:', error);
});
// Example: Download media from Instagram
const instagramUrl = 'https://www.instagram.com/p/yourpostid/';
downlib.downloadFromInstagram(instagramUrl, saveDir)
.then((result) => {
console.log('Downloaded Instagram media:', result);
})
.catch((error) => {
console.error('Error downloading Instagram media:', error);
});
// Example: Download video from TikTok
const tiktokUrl = 'https://www.tiktok.com/@username/video/123456789';
downlib.downloadFromTikTok(tiktokUrl, saveDir)
.then((result) => {
console.log('Downloaded TikTok video:', result);
})
.catch((error) => {
console.error('Error downloading TikTok video:', error);
});
// Example: Determine the type of a URL
const urlToCheck = 'https://www.reddit.com/r/javascript/';
const urlType = downlib.checkUrlType(urlToCheck);
console.log(`URL '${urlToCheck}' is of type '${urlType}'.`);
// Output: URL 'https://www.reddit.com/r/javascript/' is of type 'Reddit'.
// You can also explore more methods provided by Downlib for other functionalities.
```
#### `class Downlib`
##### Constructor
```javascript
/**
* Initialize Downlib with optional configurations.
* @param {object} options - Optional configurations.
*/
const downlib = new Downlib(options);
```
##### Methods
- `ensureDirectoryExists(dirPath)`: Ensures that a directory exists at the specified path. Creates the directory if it doesn't already exist.
- `deleteFile(filepath)`: Deletes a file from the filesystem.
- `downloadFromInstagram(url, saveDir)`: Downloads media (photos or videos) from Instagram using `instagramGetUrl` and Axios. It handles multiple media files if available.
- `downloadFromYouTube(url, saveDir, options)`: Downloads videos or playlists from YouTube using `yt-dlp`. Supports options like `audioOnly` to download only audio.
- `downloadFromTikTok(url, saveDir)`: Downloads videos from TikTok using a custom function (`tiktokdl`).
- `downloadFromTwitter(url, saveDir)`: Downloads videos from Twitter using `yt-dlp`.
- `downloadFromFacebook(url, saveDir, options)`: Downloads videos from Facebook using `yt-dlp`.
- `downloadFromTwitch(url, saveDir, options)`: Downloads videos from Twitch using `yt-dlp`.
- `downloadFromDailymotion(url, saveDir, options)`: Downloads videos from Dailymotion using `yt-dlp`.
- `downloadFromSoundCloud(url, saveDir)`: Downloads audio tracks from SoundCloud using `yt-dlp`.
- `downloadFromReddit(url, saveDir, options)`: Downloads videos from Reddit using `yt-dlp`.
- `checkUrlType(url)`: Checks the type of a URL and returns the corresponding social media platform or streaming service (YouTube, Instagram, TikTok, Pinterest, Facebook, Twitter, Reddit, SoundCloud, Dailymotion, Twitch). If the URL doesn't match any recognized patterns, it returns `'Unknown'`.
#### Example Code
See examples above for usage of each method.
### Configuration Options
You can pass optional configurations when initializing `Downlib`. These options include:
- `options.ytDlpPath`: Path to yt-dlp executable.
- `options.deleteAfterDownload`: Whether to delete the downloaded files after completion.
### Issues
If you encounter any issues or have suggestions, please open an issue [here](https://github.com/rn0x/downib/issues).
### License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.