blagues-api v2.1.1

BlaguesAPI

Ce paquet Npm fourni une interface pour intéragir avec Blagues-API

Installation

Vous pouvez simplement installer la dépendance à votre projet depuis Yarn ou Npm :

$ yarn add blagues-api # npm install blagues-api

Mise en place

Importation

// ES6 (includes typings)
import BlaguesAPI from 'blagues-api';

// CommonJS
const BlaguesAPI = require('blagues-api');

// Browser
<script src="https://unpkg.com/blagues-api@2.1.0/dist/blagues-api.umd.js"></script>;

Initialisation

Pour utiliser l'API, vous avez besoin d'un token d'authentification que vous pouvez obtenir en vous connectant sur Blagues-API avec votre compte Discord:

const blagues = new BlaguesAPI('VOTRE_TOKEN_ICI');

Utilisation

Blague aléatoire

const blague = await blagues.random();

A cette méthode, vous pouvez spécifier certains types que vous ne souhaitez pas recevoir.

const blague = await blagues.random({
  disallow: [blagues.categories.DARK, blagues.categories.LIMIT]
  // disallow: ['dark', 'limit']
});

Blague aléatoire d'une catégorie

const blague = await blagues.randomCategorized(blagues.categories.DEV);
// const blague = await blagues.randomCategorized('dev');

Blague à partir de son ID

Les blagues sont identifiées par un ID que vous recevez en même tant que chaque blague.

Spécifiez cet identifiant en paramètre et vous l'obtiendez à nouveau.

const blague = await blagues.fromId(50);

Valeur retournée

// console.log(blague);

{
  id: 1,
  type: 'dark',
  joke: 'Question',
  answer: 'Response'
}

Catégories

Certaines méthodes requiert en paramètre une catégorie.

blagues.categories.GLOBAL; // Blague tout publique
blagues.categories.DEV; // Blague de développeur
blagues.categories.DARK; // Blague d'humour noir
blagues.categories.LIMIT; // Blague 18+
blagues.categories.BEAUF; // Blague beauf
blagues.categories.BLONDES; // Blague de blondes

Nombres de blagues

const jokeCount = await blagues.count();

Valeur retournée

// console.log(jokeCount);

{
  count: 1
}