# deckofcards

> a standard deck of playing cards

Latest version **1.2.2** (published 2021-05-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install deckofcards
pnpm add deckofcards
yarn add deckofcards
bun add deckofcards
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2021-05-05 |
| First published | 2016-05-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Thomas Cort |
| Maintainers | tcort |
| Keywords | deck, cards, 52 |

## Links

- npm: https://www.npmjs.com/package/deckofcards
- Repository: https://github.com/tcort/deckofcards
- Homepage: https://github.com/tcort/deckofcards#readme
- Issues: https://github.com/tcort/deckofcards/issues
- npm.io page: https://npm.io/package/deckofcards

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21

## Recent versions

- 1.2.2 (latest) — 2021-05-05
- 1.2.1 — 2018-08-18
- 1.2.0 — 2016-05-18
- 1.1.0 — 2016-05-17
- 1.0.0 — 2016-05-16

## README

# deckofcards

A simple implementation of a deck of playing cards.

## API

### Card

Cards are a combination of a rank (`2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`,
`T` (Ten), `J` (Jack), `Q` (Queen), `K` (King), `A` (Ace)) and a suit
(`S` (Spades), `C` (Clubs), `H` (Hearts), `D` (Diamonds)).

#### constructor(rank, suit)

Accepts a rank (e.g. `4`) and a suit (e.g. `C`). Will throw on invalid input.

#### constructor(rankAndSuit)

Accepts a rank and a suit string (e.g. `4C`). Will throw on invalid input.

#### constructor(Card)

Copy constructor. Accepts a Card. Will throw on invalid input.

#### static parse(s)

Parses a card string (e.g. `4C`) and returns a new `Card`.

#### static stringify(c)

Returns a string representation of the card (e.g. `KH`).

#### toString()

Returns a string representation of the card (e.g. `KH`).

#### valueOf()

Returns a string representation of the card (e.g. `KH`).

#### inspect()

Returns a string representation of the card (e.g. `KH`).

#### ranks[]

An array of valid ranks.

#### suits[]

An array of valid suits.

### Deck

A Deck is just a set of 52 unique cards made by combining all legal suits and
ranks.

#### constructor()

Initializes a new shuffled deck of cards.

#### shuffle()

Randomizes the order of the cards.

#### draw()

Returns the next card from the deck.

#### reset()

Puts the dealt cards back in the deck and performs a shuffle.

#### toString()

Returns a string representation of the deck.

## Testing

    npm test

## License

See [LICENSE.md](https://github.com/tcort/deckofcards/blob/master/LICENSE.md)

---
_Source: https://npm.io/package/deckofcards · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._