1.0.0 • Published 3 years ago

open-critic-node v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

open-critic-node

A NodeJS Wrapper for the Open Critic API

Installation

npm -i open-critic-node

Usage

First import the client:

Typescript

import { OpenCriticClient } from "open-critic-node";

Javascript CommonJS

const OpenCriticClient = require("open-critic-node").OpenCriticClient;

Method Examples

I'll just be showing examples in Typescript from here on out. The typings are included in the lib so check it out!

// Instantiate a new client.
const client = new OpenCriticClient();

// Get the first page of PS5 games (game summary only)
const games = await client.getGames({
    page: 0,
    platforms: [
        PlatformType.SONY_PLAYSTATION_5
    ],
});

// Get a game's details by its ID. (This example is the ID for Demon's Souls)
const game = await client.getGameById(10255);