# triviadb

> A JavaScript Library for the Open Trivia Database

Latest version **0.2.0** (published 2021-01-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install triviadb
pnpm add triviadb
yarn add triviadb
bun add triviadb
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-01-24 |
| First published | 2020-08-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.6 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | Gautham Anant |
| Maintainers | gpsanant |
| Keywords | trivia, questions, database, general knowledge |

## Links

- npm: https://www.npmjs.com/package/triviadb
- npm.io page: https://npm.io/package/triviadb

## Dependencies (1)

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

## Recent versions

- 0.2.0 (latest) — 2021-01-24
- 0.1.0 — 2020-08-21
- 0.0.2 — 2020-08-21
- 0.0.1 — 2020-08-21
- 1.0.0 — 2020-08-21

## README

# triviaDB
A JavaScript Library for the Open Trivia Database, a databse of over 10,000 trivia questions from more than 20 categories.
<br>
For questions, contact me at gpsanant@gmail.com

# Installation
```npm i triviadb```

# Notes
DB info: https://opentdb.com/<br>
The API appends a "Response Code" to each API Call to help tell developers what the API is doing.
<br><br>
* Code 0: Success Returned results successfully.<br>
* Code 1: No Results Could not return results. The API doesn't have enough questions for your query. (Ex. Asking for 50 Questions in a Category that only has 20.)<br>
* Code 2: Invalid Parameter Contains an invalid parameter. Arguements passed in aren't valid. (Ex. Amount = Five)<br>
* Code 3: Token Not Found Session Token does not exist.<br>
* Code 4: Token Empty Session Token has returned all possible questions for the specified query. Resetting the Token is necessary.<br><br>

The API supports Base64 Encoding, URL Encoding (RFC 3986), Legacy URL encoding, and defaults to HTML Character Entities (http://www.amp-what.com/).
<br>
For Base64 Encoding, pass in "base64" as the encoding parameter. <br>
For URL Encoding, pass in "url3986" as the encoding parameter. <br>
For Legacy URL Encoding, pass in "urlLegacy" as the encoding parameter.<br>


# Example Usage
```js script
const triviaDB = require('triviadb');

(async() => {
    console.log(await triviaDB.getCategories())
    //works with either the id of the category or name
    console.log(await triviaDB.getCategoryInfo(17))
    console.log(await triviaDB.getCategoryInfo("History"))
    console.log(await triviaDB.getToken())
    console.log(await triviaDB.getGlobalQuestionsInfo())
    console.log(await triviaDB.getQuestions({ amount: 3, difficulty: "easy"})) //3 easy questions.
})()
```

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