charades-keywords v0.3.0

charades-keywords

Find a random keyword for the game of charades! (Polish only)

Install

npm install --save charades-keywords
# or
yarn add charades-keywords

Usage

import charadesKeywords from "charades-keywords";

// Returns an array of objects with all available keywords
charadesKeywords.all

// Returns a single random keyword object
charadesKeywords.random()

// Returns 3 random keyword objects
charadesKeywords.random(3)

// Returns 3 random keyword objects with a category of activity
charadesKeywords.random(3, { category: 'activity' })

// Returns 3 random keyword objects with a complexity of hard
charadesKeywords.random(3, { complexity: 'hard' })

// Returns 3 random keyword objects with a complexity of hard and category of activity
charadesKeywords.random(3, { complexity: 'hard', category: 'activity' })

Available categories

• person
• animal
• item
• proverb
• activity
• title
• other

Available complexities

• easy
• medium
• hard