0.2.0 • Published 4 years ago

triviadb v0.2.0

Weekly downloads
29
License
ISC
Repository
-
Last release
4 years ago

triviaDB

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

Installation

npm i triviadb

Notes

DB info: https://opentdb.com/ The API appends a "Response Code" to each API Call to help tell developers what the API is doing.

  • Code 0: Success Returned results successfully.
  • 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.)
  • Code 2: Invalid Parameter Contains an invalid parameter. Arguements passed in aren't valid. (Ex. Amount = Five)
  • Code 3: Token Not Found Session Token does not exist.
  • Code 4: Token Empty Session Token has returned all possible questions for the specified query. Resetting the Token is necessary.

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

Example Usage

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.
})()
0.2.0

4 years ago

0.1.0

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago

1.0.0

4 years ago