# open-critic-node

> A NodeJS Wrapper for the Open Critic API

Latest version **1.0.0** (published 2021-04-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install open-critic-node
pnpm add open-critic-node
yarn add open-critic-node
bun add open-critic-node
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-04-24 |
| First published | 2021-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 38.8 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | https://github.com/MorpheusZero/ |
| Maintainers | morpheuszero |
| Keywords | open critic api, video game api, video games |

## Links

- npm: https://www.npmjs.com/package/open-critic-node
- Repository: https://github.com/MorpheusZero/open-critic-node
- Homepage: https://github.com/MorpheusZero/open-critic-node#readme
- Issues: https://github.com/MorpheusZero/open-critic-node/issues
- npm.io page: https://npm.io/package/open-critic-node

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.21.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2021-04-24

## README

# open-critic-node
A NodeJS Wrapper for the Open Critic API

### Installation

```bash
npm -i open-critic-node
```

### Usage

First import the client:

Typescript
```typescript
import { OpenCriticClient } from "open-critic-node";
```

Javascript CommonJS
```javascript
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!
```typescript
// 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);
```

---
_Source: https://npm.io/package/open-critic-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._