https://github.com/maisans-maid/animequiz

Generate random anime quiz
https://github.com/maisans-maid/animequiz

anime anime-quiz discord discordbot javascript quiz

Last synced: about 1 month ago
JSON representation

Generate random anime quiz

• Host: GitHub
• URL: https://github.com/maisans-maid/animequiz
• Owner: maisans-maid
• License: mit
• Created: 2020-12-30T13:52:20.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-01T01:17:43.000Z (almost 4 years ago)
• Last Synced: 2024-10-13T02:48:17.511Z (2 months ago)
• Topics: anime, anime-quiz, discord, discordbot, javascript, quiz
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/aniquiz
• Size: 24.4 KB
• Stars: 2
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Anime Quiz

#### Generate random anime quiz!

[![App Version](https://img.shields.io/npm/v/aniquiz)](https://www.npmjs.com/package/aniquiz)

[![Node](https://img.shields.io/node/v/aniquiz?color=green&logo=Node.js&logoColor=white)](https://nodejs.org/dist/latest-v14.x/)

[![License](https://img.shields.io/github/license/maisans-maid/Mai?color=blue&label=License)](https://github.com/maisans-maid/animequiz/blob/master/LICENSE)




[![](https://nodei.co/npm/aniquiz.png)](https://www.npmjs.com/package/aniquiz)

### Installation

```js

npm i aniquiz

```

### Usage

#### Generate random anime quiz

```js

const animequiz = require('aniquiz')

// Random quiz object

console.log(animequiz.getEntry())

// Quiz object with difficulty

console.log(animequiz.getEntry({ difficulty: 'easy' }))

// Quiz object with image

console.log(animequiz.getEntry({ image: true })

// Quiz object without image

console.log(animequiz.getEntry({ image: false }))

```

### Options

| property | type | default |

| --- | --- | --- |

| difficulty | string | none |

| image | boolean | none |

### Quiz object

| Property | type | description |

| --- | --- | --- |

| difficulty | string | The difficulty of the question

| time | number | The time in ms the question should be answered

| question | string | The question

| answers | array | The array of possible answers

| image | string | The image of the question, if applicable

| submittedBy | string | The one created the question

| id | string | The id of this question

| custom | boolean | Whether this quiz object was manually added

### Example response

Success

```js

{

  difficulty: 'Hard',

  time: 20000,

  question: 'The name of Junko Enoshima’s imposter at the beginning of Danganronpa: Trigger Happy Havoc is?',

  answers: [ 'mukuro ikusaba', 'ikusaba mukuro' ],

  image: null,

  submittedBy: 'Sakurajimai',

  id: '111'

}

```

Error

```js

{ error: 'error msg.' }

```

### Create instance

Creating a quiz instance allows you to prevent receiving the same question twice

```js

const { Quiz } = require('aniquiz');

// class parameters accepts options

const quiz = new Quiz({ difficulty: 'easy' })

// Quiz object

console.log(quiz.getEntry())

// Quiz entries

console.log(quiz.getEntries())

// Accepts options parameter as well

```

### Error

If instance runs out of quiz entry, you encounter the following error

```js

{ error: 'Exhausted entries.' }

```

You can reload entries by using 

```js

quiz.reload(options)

```

or add your own entries via 

```js

quiz.addEntries([])

```

Added entries will be appended with custom property which is set to true.

### Total Entries: 132