Skip to content

A Node.js wrapper to the TvMaze API written in TypeScript

License

Notifications You must be signed in to change notification settings

kguzek/tvmaze-wrapper-ts

 
 

Repository files navigation

TVmaze Wrapper (TypeScript)

A wrapper to the TVmaze API written in TypeScript using Node.js.

Why fork?

This repository is forked from JohnDeved/node-tvnode-api-ts, which at the time of writing hasn't been updated in 5 years.

The reason I (@kguzek) created it is because of an unpleasant developer experience while consuming the original library as well as a confusing project structure.

My approach rewrote the API from an object-oriented approach into a functional approach, since the classes didn't really make sense -- they were all used as singletons anyway.

License change

As a side note, the original package was released under the ISC as per its package.json, but included no license notices or license file. This project is released under the AGPL-3.0, and the license file is available at /LICENSE.

Usage

Install the package from NPM:

npm i tvmaze-wrapper-ts

And import it directly using modern ES6 syntax:

import { searchShow, findShowById } from "tvmaze-wrapper-ts";

const show = await searchShow("the rookie");
const details = await findShowById(show.id);

// Your code...

Docs

The original README.md is preserved at README.original.md. It lists all available API functions and methods. This package has renamed all of these to be more logical and consistent, but the same functions are implemented.

The only exception is the episode trailer scraper which has been removed as it introduced an additional dependency and is not strictly related to the TVmaze API. This package therefore has absolutely no dependencies, since all requests are made using the native fetch API.

Credits

Original package was written by Johann Berger.

Contributions to the original package by Josh Thompson.

Improvements and rewrite by Konrad Guzek.

Copyright

SPDX-License-Identifier: AGPL-3.0-only

TVmaze Wrapper (TypeScript)

Copyright © 2025 Konrad Guzek

This file is part of "TVmaze Wrapper (TypeScript)". It is an adaptation of node-tvmaze-api-ts, released under the ISC license. This project, "TVmaze Wrapper (TypeScript)", is released under the GNU Affero General Public License, Version 3.

Usage of TVmaze API

(copied from tvmaze.com)

Use of the TVmaze API is licensed by CC BY-SA. This means the data can freely be used for any purpose, as long as TVmaze is properly credited as source and your application complies with the ShareAlike provision. You can satisfy the attribution requirement by linking back to TVmaze from within your application or website, for example using the URLs available in the API.

About

A Node.js wrapper to the TvMaze API written in TypeScript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.5%
  • JavaScript 1.5%