https://github.com/dofy/youtube-caption-fox
A simple Node.js library for fetching YouTube video captions with ease.
https://github.com/dofy/youtube-caption-fox
captions subtitles typescript video youtube
Last synced: 6 months ago
JSON representation
A simple Node.js library for fetching YouTube video captions with ease.
- Host: GitHub
- URL: https://github.com/dofy/youtube-caption-fox
- Owner: dofy
- License: mit
- Created: 2024-08-14T18:21:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-29T10:00:15.000Z (about 1 year ago)
- Last Synced: 2024-11-13T03:51:52.075Z (11 months ago)
- Topics: captions, subtitles, typescript, video, youtube
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@dofy/youtube-caption-fox
- Size: 909 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @dofy/youtube-caption-fox
`@dofy/youtube-caption-fox` is a simple Node.js library for fetching YouTube video captions with ease. Whether you need to extract subtitles for processing, analysis, or translation, this package provides a straightforward API to retrieve captions in different languages.
## Features
- Fetch captions from YouTube videos by video ID
- Support for multiple languages
- Simple and easy-to-use API
- Handles proxy configuration for restricted environments
## Installation
You can install the package using npm:
```bash
npm install @dofy/youtube-caption-fox
```
## Usage
### Basic Usage
Here's an example of how to use `@dofy/youtube-caption-fox` to fetch captions for a YouTube video:
```javascript
import { getCaptions } from '@dofy/youtube-caption-fox'
const videoId = 'your-video-id'
getCaptions(videoId)
.then(({ captions }) => {
console.log('Captions:', captions)
})
.catch((error) => {
console.error('Error fetching captions:', error)
})
```
### Proxy Support
If you are behind a proxy, you can configure the library to use it:
```javascript
import { getCaptions } from '@dofy/youtube-caption-fox'
const videoId = 'your-video-id'
const options = {
proxy: {
host: 'proxy-server-address',
port: 8080,
protocol: 'http',
auth: {
username: 'your-username',
password: 'your-password',
},
},
}
getCaptions(videoId, options)
.then(({ captions }) => {
console.log('Captions:', captions)
})
.catch((error) => {
console.error('Error fetching captions:', error)
})
```
## API
### `getCaptions(videoId, [options])`
- **videoId** (String) - The ID of the YouTube video for which to fetch captions.
- **options** (Object) - Optional. Configuration options, such as proxy settings.
Returns a promise that resolves with the captions data or rejects with an error.
## Example
```javascript
import { getCaptions } from '@dofy/youtube-caption-fox'
const videoId = 'your-video-id'
getCaptions(videoId)
.then(({ captions }) => {
console.log(captions) // Captions data in JSON format
})
.catch((error) => {
console.error(error)
})
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please submit a pull request or open an issue to discuss potential changes.
## Issues
If you encounter any issues or have feature requests, please feel free to [open an issue](https://github.com/dofy/youtube-caption-fox/issues) on GitHub.