Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.32 KB

README.md

File metadata and controls

73 lines (53 loc) · 2.32 KB
Raw

Jellyfin API Client for JavaScript

Part of the Jellyfin Project

Logo Banner

MIT License Donate Feature Requests Chat on Matrix Join our Subreddit

Warning

This library is deprecated. It is recommended to use the TypeScript SDK instead. No future releases are planned and no new features will be supported.

This library is meant to help clients written in JavaScript 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

  • npm 6

Getting Started

  1. Clone or download this repository

    git clone https://github.com/jellyfin/jellyfin-apiclient-javascript.git
cd jellyfin-apiclient-javascript

  2. Install build dependencies in the project directory

    npm install

  3. Build the library for production

    npm run build

  4. Build the library for development

    npm run dev

Building Documentation

This library is documented using JSDoc style comments. Documentation can be generated in HTML format by running npm run docs and viewing the files in any modern browser. The resulting documentation will be saved in the docs directory.