Reference · Cards, hands and piles
readHandfunction
A hand written as text, as its cards: the two-letter ids separated by spaces
or commas ("AS KH 10D TC RJ", with 10 for ten as well as T), or the
deck's one-letter codes run together ("pvOZ"). The extras by their ids or
their words: JOKER (each the next of red and black), RULES, BLANK.
null for anything else, or for more extras than one pack holds.
Import it
import { readHand } from "@johnmorrisdotca/toranpu/element";Also exported from: @johnmorrisdotca/toranpu/element/define
Definition
function readHand(text: string | null | undefined): string[] | nullParameters
| Name | Type | Description |
|---|---|---|
text | string | null | undefined | The notation, encoded state or saved text to read. |
Returns
string[] | null
A hand written as text, as its cards: the two-letter ids separated by spaces or commas ("AS KH 10D TC RJ", with 10 for ten as well as T), or the deck's one-letter codes run together ("pvOZ"). The extras by their ids or their words: JOKER (each the next of red and black), RULES, BLANK. null for anything else, or for more extras than one pack holds.
Examples
import { readHand } from "@johnmorrisdotca/toranpu/element";
console.log(readHand("AS KH 10D"));[ 'AS', 'KH', 'TD' ]What it prints (run when this page was built)