mirror of
https://github.com/informaticker/discord-jellyfin-bot.git
synced 2024-11-23 18:21:55 +01:00
.. | ||
dist | ||
CONTRIBUTORS.md | ||
jest.setup.js | ||
LICENSE.md | ||
package.json | ||
README.md |
Jellyfin API Client for JavaScript
Part of the Jellyfin Project
This library is meant to help clients written in JavaScript or TypeScript interact with Jellyfin's REST API.
Compatibility
This library depends on the Fetch and Promise APIs. These will be expected to be polyfilled if used in a browser that doesn't support them.
Build Process
Dependencies
- Yarn
Getting Started
-
Clone or download this repository
git clone https://github.com/jellyfin/jellyfin-apiclient-javascript.git cd jellyfin-apiclient-javascript
-
Install build dependencies in the project directory
yarn install
-
Build the library for production
yarn build
-
Build the library for development
yarn dev
Building Documentation
This library is documented using JSDoc style comments. Documentation can be generated in HTML format by running yarn docs
and viewing the files in any modern browser. The resulting documentation will be saved in the docs
directory.