https://github.com/invidjs/invidjs

An attempt to bring Invidious support to Node.js.
https://github.com/invidjs/invidjs

invidious invidious-api javascript node-js typescript

Last synced: 3 months ago
JSON representation

An attempt to bring Invidious support to Node.js.

• Host: GitHub
• URL: https://github.com/invidjs/invidjs
• Owner: InvidJS
• License: agpl-3.0
• Created: 2023-02-26T18:21:49.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-14T20:08:23.000Z (9 months ago)
• Last Synced: 2024-10-29T10:45:33.946Z (8 months ago)
• Topics: invidious, invidious-api, javascript, node-js, typescript
• Language: TypeScript
• Homepage: https://invidjs.js.org/
• Size: 1.85 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# InvidJS

## :warning:  NO LONGER MAINTAINED. THANKS FOR HELPING PROTECT OUR COMMUNITY.

[![npm version](https://badge.fury.io/js/@invidjs%2Finvid-js.svg)](https://badge.fury.io/js/@invidjs%2Finvid-js)

![npm](https://img.shields.io/npm/dt/%40invidjs/invid-js)

An attempt to bring Invidious support to Node.js.

# Installation and usage

Your Node.js version must be 16.9.0 or greater.

You can check your version by typing `node -v` in the terminal.

To install InvidJS, type `npm install @invidjs/invid-js` in your terminal.

After installing, insert the following in your code:

```js

import * as InvidJS from "@invidjs/invid-js"

```

# Changes from the stock Invidious API

- Useless or broken endpoints are not carried over. Previously working endpoints are marked as deprecated.

- Only the most important data is fetched for big objects.

- Some data is filled in for you and/or made humanly-readable where possible.

- Minimal and basic versions of objects are available to be consistent with different outputs.

- Limit options are provided where they're not normally supported by the API.

- Some objects and outputs are combined, for example:

  - Video and Audio formats are a single object. 

  - formatStreams and adaptiveFormats are a single array.

  - Playlists and mixes are the same object, and fetched via the same function.

# Building from source

To build the package, clone this repository and execute `npm run build` in your terminal.

[Documentation](https://invidjs.js.org/)