README
arcana
a tarot deck generator
Scripts
– run the tests test
npm run test
– generate and view code coverage as HTML coverage
npm run coverage
– lint the codebase lint
npm run lint
– generate the README readme
npm run readme
deck
module.exports ⏏
Class representing a deck
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