Axios client and TypeScript typings for Jellyfin, the free media server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
jellyfin-bot d39a8b6037 Update unstable OpenAPI client 5 months ago
.github Merge pull request #125 from jellyfin/dependabot/github_actions/actions/checkout-2.4.0 12 months ago
scripts Remove allOf objects before generating client 1 year ago
stable Update stable OpenAPI client 5 months ago
unstable Update unstable OpenAPI client 5 months ago
.gitignore Remove allOf objects before generating client 1 year ago
EXAMPLES.md Moved examples to their own file 1 year ago
LICENSE chore: create repository and workflows 2 years ago
README.md Moved examples to their own file 1 year ago

README.md

Jellyfin API Client for Axios

Part of the Jellyfin Project


Logo Banner

stable npm unstable npm MIT License Donate Feature Requests Chat on Matrix Join our Subreddit

WARNING: The current 10.7.8 package for this project is the one matching the 10.7.7 server API due to a bug in our deployment. New versions should be fixed and follow the server versioning.

This library is meant to help clients written in JavaScript or TypeScript interact with Jellyfin's REST API. It's generated automatically using OpenAPITools generator and it's fully typed for TypeScript

Compatibility

This library depends on Axios.

TypeScript typings

You can also use this library as a development dependency just for the TypeScript typings. Types are located under the models subfolder:

import type TYPE_NAME from "@jellyfin/client-axios/models";

Usage

Usage examples can be found here.

Build Process

This API client is built automatically every midnight for the stable and unstable API releases. You can build it yourself using Docker:

Stable API (>= Jellyfin Server 10.7.0)

docker run --rm openapitools/openapi-generator-cli generate -i https://api.jellyfin.org/openapi/jellyfin-openapi-stable.json
-g typescript-axios --additional-properties=npmName=@jellyfin/client-axios
--additional-properties=supportsES6=true
--additional-properties=useSingleRequestParameter=true
--additional-properties=withSeparateModelsAndApi=true
--additional-properties=modelPackage=models
--additional-properties=apiPackage=api
--enable-post-process-file
-o /output/dir

Unstable API (current Jellyfin Server master branch)

docker run --rm openapitools/openapi-generator-cli generate -i https://api.jellyfin.org/openapi/jellyfin-openapi-unstable.json
-g typescript-axios --additional-properties=npmName=@jellyfin/client-axios
--additional-properties=supportsES6=true
--additional-properties=useSingleRequestParameter=true
--additional-properties=withSeparateModelsAndApi=true
--additional-properties=modelPackage=models
--additional-properties=apiPackage=api
--enable-post-process-file
-o /output/dir

If you want to compile the TypeScript sources to JavaScript, check the README of the generated output, as it will contain up to date instructions of how to do it yourself.

Examples

We use this API client at Jellyfin Vue and Jellyfin Chromecast