pokersolver

Server Usage (Node.js)

Import the Hand class using require:

var Hand = require('pokersolver').Hand;

Browser Usage

Include the script via a <script> tag, then access the Hand object globally:

<script src="/path/to/pokersolver.js"></script>
<script>
  var hand = Hand.solve(['...']);
  ...
</script>

To use pokersolver in your project, install it using npm:

npm install pokersolver

Use Hand.solve(cards, game, canDisqualify) to evaluate a hand of 3 to 7 cards.

Parameters:

• cards (Array): An array of card strings. Note that 10 must be represented as T (e.g., 'Th' for Ten of hearts).
• game (String, optional): The rule set to use. Defaults to 'standard'.
• canDisqualify (Boolean, optional): Whether the hand is subject to qualification rules. Defaults to false.

Example:

var hand = Hand.solve(['Ad', 'As', 'Jc', 'Th', '2d', 'Qs', 'Qd']);
console.log(hand.name); // Two Pair
console.log(hand.descr); // Two Pair, A's & Q's

Use Hand.winners(hands) to compare an array of solved hands and determine the winner(s). It can return multiple hands in the event of a tie.

Parameters:

• hands (Array): An array of hand objects previously returned by Hand.solve.

Example:

var hand1 = Hand.solve(['Ad', 'As', 'Jc', 'Th', '2d', '3c', 'Kd']);
var hand2 = Hand.solve(['Ad', 'As', 'Jc', 'Th', '2d', 'Qs', 'Qd']);
var winner = Hand.winners([hand1, hand2]); // hand2

When a hand is solved via Hand.solve(), the returned object contains the following properties:

• cardPool (Array): All cards passed into the hand.
• cards (Array): The specific cards involved in the identified hand type (maximum of 5).
• descr (String): A detailed description (e.g., 'Two Pair, A's & Q's').
• name (String): The name of the hand type (e.g., 'Two Pair').
• rank (Number): The ranking of the hand type (0 is lowest; varies by game).

You can also call .toString() on the solved hand to get a formatted string of the cards involved in the identified hand type.

The compare(a) method compares the current hand instance with another Hand instance a.

Returns:

• -1: If the current hand is higher rank than a (the current hand wins).
• 1: If the current hand is lower rank than a (the current hand loses).
• 0: If the hands are equal.

If ranks are equal, it performs a tie-break by comparing the individual card ranks in descending order.

const handA = Hand.solve(['Ad', 'Kd', 'Qd', 'Jd', '2d'], 'standard');
const handB = Hand.solve(['2c', '3c', '4c', '5c', '6c'], 'standard');

const result = handA.compare(handB);
if (result === -1) {
  console.log("Hand A wins");
}

The Game class defines the ruleset for evaluation. You can instantiate it with a predefined rule string to set parameters like cardsInHand, handValues, wildValue, and noKickers.

Supported rule identifiers:

• 'standard': 5 cards, standard hand rankings.
• 'jacksbetter': 5 cards, no kickers, specific lowest qualified hands.
• 'joker': 5 cards, uses 'O' as a wild value.
• 'deuceswild': 5 cards, uses '2' as a wild value.
• 'threecard': 3 cards.
• 'fourcard': 4 cards.
• 'paigowpokerfull': 7 cards, used for Pai Gow Poker.
• 'paigowpokerhi': 5 cards, used for the high hand in Pai Gow.
• 'paigowpokerlo': 2 cards, used for the low hand in Pai Gow.

const game = new Game('deuceswild');
console.log(game.cardsInHand); // 5
console.log(game.wildValue);   // '2'

Use Hand.winners(hands) to compare multiple Hand objects and return an array of the winning hands. This is useful for determining the outcome of a showdown between players or between a player and a dealer.

const winners = Hand.winners([playerHand, dealerHand]);
if (winners.length === 1 && winners[0] === playerHand) {
  console.log('Player wins!');
}