Skip to content

MattPua/isthereanydeal-nodejs

Repository files navigation

IsThereAnyDeal Node.js Library (Unofficial)

npm version npm downloads License: MIT Contributions welcome

An unofficial Node.js library for the IsThereAnyDeal API written in TypeScript. This library is built with Bun and Zod.

Based on documentation from IsThereAnyDeal.

This SDK provides a simple way to interact with different parts of the IsThereAnyDeal API.

This library is not affiliated with IsThereAnyDeal. All trademarks are property of their respective owners in the US and other countries.

Installation

bun add isthereanydeal-nodejs

Documentation

For full information on the API, please see the documentation.

Setup

An API key is required to use the library. You can get one by signing up for a free account.

import { IsThereAnyDealClient } from 'isthereanydeal-nodejs';

const client = new IsThereAnyDealClient('your-api-key');

const results = client.games.searchForGame({
	title: 'The Witcher 3',
	results: 5,
});

console.log(results);

Features

Currently all methods that do not require OAuth authentication are available. Please see the documentation for more information.

Developing Locally

This project requires the following dependencies to be installed:

To install the dependencies, run the following command:

bun install

Testing

Please create a .env.test.local file with the following content:

IS_THERE_ANY_DEAL_API_KEY=your-api-key

After which, you can run the tests with the following command:

bun test

Contributing

Please see CONTRIBUTING.md for contribution guidelines.

License

MIT

Disclaimer

This project is not affiliated with IsThereAnyDeal. All trademarks are property of their respective owners in the US and other countries.