Fork of ytmusic-api
Go to file
Zechariah 7f9e5b7d44 🔖 2.0.0 2022-05-31 01:41:55 +08:00
.github/workflows Added branches to publish-npm in hope that it won't trigger on every push 2022-03-31 00:31:12 +08:00
docs update docs 2022-05-31 01:41:02 +08:00
src 🔥 no more omitting "views" 2022-05-31 01:39:22 +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 Updated README 2022-03-30 23:27:07 +08:00
package.json 🔖 2.0.0 2022-05-31 01:41:55 +08:00
pnpm-lock.yaml update docs 2022-05-31 01:41:02 +08:00
tsconfig.json Updated project configuration 2022-02-05 15:43:54 +08:00

README.md

YTMusic API

License Languages Top Language Commit Activity Last commit

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

  • TypeScript
    • @types/mocha
    • @types/node
    • @types/tough-cookie
    • typescript
  • Axios
    • axios
  • Tough Cookie
    • tough-cookie
  • Mocha
    • mocha
    • mocha.parallel
    • ts-mocha
  • VuePress
    • @vuepress/plugin-search
    • vuepress
  • Miscellaneous
    • validate-any