Jellyfin API Client for JavaScript
---
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
1. Clone or download this repository
```sh
git clone https://github.com/jellyfin/jellyfin-apiclient-javascript.git
cd jellyfin-apiclient-javascript
```
2. Install build dependencies in the project directory
```sh
yarn install
```
3. Build the library for production
```sh
yarn build
```
4. Build the library for development
```sh
yarn dev
```
## Building Documentation
This library is documented using [JSDoc](https://jsdoc.app/) 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.