@dvcol/trakt-http-client

Simple fetch based http client for trakt.tv API with full typescript support (request and response).

Prerequisites

• pnpm >=9.0.0
• node >=20.0.0

Install

pnpm install

Usage

pnpm add @dvcol/trakt-http-client

Modular endpoint bundling

Trakt-http-client is designed to be modular and flexible. Although it uses static classes, endpoints are instantiated at runtime and can be easily omitted, extended or overridden. If your bundler does not support tree-shaking, you can omit unused endpoints by only importing the ones you need.

By default we provide a full api object with all supported endpoints, as well as a minimal api object with only the essential authentication endpoints. You can also import any endpoint by common scope.

import { TraktClient } from '@dvcol/trakt-http-client';
import { calendars } from '@dvcol/trakt-http-client/api/calendar';
import { episodes } from '@dvcol/trakt-http-client/api/episodes';
import { minimalTraktApi } from '@dvcol/trakt-http-client/api/minimal';
 
import { Config } from '@dvcol/trakt-http-client/config';

import type { TraktClientSettings } from '@dvcol/trakt-http-client/models';


const traktUsedApi = {
  ...minimalTraktApi,
  calendars,
  episodes,
};

const traktClientSettings: TraktClientSettings = {
  client_id: '<Your trakt ID>',
  client_secret: '<Your trakt secret>',
  redirect_uri: '<Your trakt redirect uri>',
  endpoint: Config.endpoint.Production,

  useragent: '<Your user Agent>',
  corsProxy: '<Optional cors Proxy>',
  corsPrefix: '<Optional cors Proxy prefix>',
};

const initAuthentication = {}


const traktClient = new TraktClient(traktClientSettings, initAuthentication, traktUsedApi);

Features

• Built-in cache support (per client, endpoint, or query)
• Extensible cache store (in-memory, local storage, etc.)
• Event observer (request, query, auth)
• Built-in cancellation support
• Code polling authentication
• Code redirect authentication
• Token refresh

Documentation

See Trakt API documentation for more information.

Author

• Github: @dvcol

📝 License

This project is MIT licensed.