TypeScript SDK for Jellyfin
Go to file
2021-09-16 17:14:03 -04:00
docs Update documentation 2021-09-16 17:14:03 -04:00
scripts Fix openapi schema 2021-08-30 00:36:18 -04:00
src Update api constructor parameters 2021-09-16 17:12:32 -04:00
.eslintignore Initial commit 2021-08-29 01:00:52 -04:00
.eslintrc.js Add test linting 2021-09-16 13:12:53 -04:00
.gitattributes Initial commit 2021-08-29 01:00:52 -04:00
.gitignore Add test coverage 2021-09-16 16:27:30 -04:00
jest.config.js Add test coverage 2021-09-16 16:27:30 -04:00
LICENSE Update license 2021-09-14 01:10:15 -04:00
openapi.json Update openapi spec to 10.7.7 2021-09-16 00:33:29 -04:00
openapitools.json Initial commit 2021-08-29 01:00:52 -04:00
package-lock.json Add test linting 2021-09-16 13:12:53 -04:00
package.json Add lint script 2021-09-16 16:27:43 -04:00
README.md Update api constructor parameters 2021-09-16 17:12:32 -04:00
tsconfig.json Remove models entry point for docs 2021-09-16 11:36:56 -04:00

jellyfin-sdk-typescript

A TypeScript SDK for Jellyfin.

Warning: This project is under active development and is not ready for production use. API changes will occur.

Usage

// Create a new instance of the SDK
const jellyfin = new Jellyfin();
const api = jellyfin.createApi('https://demo.jellyfin.org/stable');

// Each API endpoint is exposed via a getter on the SDK instance using
// a shared Configuration and Axios instance. For example the /System APIs
// are available as api.systemApi.

// Fetch the public system info
const info = await api.systemApi.getPublicSystemInfo();
console.log('Info =>', info.data);

// Fetch the list of public users
const users = await api.userApi.getPublicUsers();
console.log('Users =>', users.data);

// A helper method for authentication has been added to the SDK because
// the default method exposed in the generated Axios client is rather
// cumbersome to use.
const auth = await api.authenticateUserByName({ Username: 'demo', Pw: '' });
console.log('Auth =>', auth.data);