Fork of ytmusic-api

Go to file

zS1L3NT be872ecf5b 🐛 forgot to include index.ts		2022-12-28 03:27:14 +08:00
.github/workflows	🔥 remove deploying to github pages	2022-12-25 02:16:55 +08:00
docs	🚨 fix spelling lint errors	2022-06-28 00:32:59 +08:00
src	🐛 forgot to include index.ts	2022-12-28 03:27:14 +08:00
.editorconfig	Initial Commit - Searching works	2021-12-23 01:01:37 +08:00
.gitignore	Migrated to using vuepress@2.0.0-beta	2022-03-29 16:45:00 +08:00
.npmignore	Updated .npmignore and package version	2022-03-31 00:19:33 +08:00
.npmrc	Added linebreak at the end of .npmrc	2022-03-30 23:39:31 +08:00
.prettierrc	Initial Commit - Searching works	2021-12-23 01:01:37 +08:00
LICENSE	Updated LICENSE	2022-03-28 03:31:43 +08:00
README.md	📝 update readme.md	2022-12-26 03:53:00 +08:00
package.json	🐛 forgot to include index.ts	2022-12-28 03:27:14 +08:00
pnpm-lock.yaml	✨ new version of ytmusic-api abandoning validate-any	2022-12-25 01:53:42 +08:00
tsconfig.json	Updated project configuration	2022-02-05 15:43:54 +08:00

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
- Miscellaneous