arcana

a tarot deck generator

Scripts

test – run the tests

npm run test

coverage – generate and view code coverage as HTML

npm run coverage

lint – lint the codebase

npm run lint

readme – generate the README

npm run readme

deck

• deck
  • module.exports ⏏
    • new module.exports([deck])

module.exports ⏏

Class representing a deck

Kind: Exported class

new module.exports([deck])

Create a deck

Param	Type	Description
[deck]	Object	the deck description
deck.majorArcana	Object	the major arcana description
deck.majorArcana.symbols	Array.<string>	the major arcana symbols
deck.minorArcana	Object	the minor arcana description
deck.majorArcana.suits	Array.<string>	the minor arcana suits
deck.majorArcana.orders	Array.<string>	the minor arcana orders

License

MIT @ Flip