d4d6fa1662
use bunjs instead of pnpm remove mocha and use bun test import my latest eslint config |
||
|---|---|---|
| .github/workflows | ||
| docs | ||
| src | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitignore | ||
| .npmignore | ||
| .prettierrc | ||
| LICENSE | ||
| README.md | ||
| bun.lockb | ||
| package.json | ||
| tsconfig.json | ||
README.md
YTMusic API
YouTube Music API (Unofficial) is a YouTube Music data scraper. It comes with TypeScript support API for return types. The NPM package can be found here
Full documentation is available here.
Motivation
I used to use youtube-music-api as my youtube music api data scraper. I liked looking into the source code of how it works but it never made sense to me. I also didn't like that there were no TypeScript annotations for the return types of methods. Because of this, I decided to build my own version of a youtube music api with TypeScript annotations, testing and written in a way I can understand.
Features
- TypeScript Support for data return types
- Data from YouTube can be inconsistent but YTMusic API has been tested and the data matches the TypeScript types 95% of the time
- Scrape information directly from YouTube Music API
- Search Suggestions
- Songs
- Videos
- Artists
- Albums
- Playlists
Credits
A lot of the credit should go to youtube-music-api. I build this package as a refactored and tested version of youtube-music-api with TypeScript annotations
Testing
YTMusic API's data return types are tested with Mocha. To run the tests, run the command
$ npm run test
Built with
- NodeJS
- TypeScript
- Mocha
- VuePress
- ESLint
- Miscellaneous
- TypeScript
