carriedFromfunction
Which card of a column a carry to to would take: the one face-up card whose
run fits there, or null. A column's face-up cards are a single run, so only
one card in it can be one below the target's top, and only its foot can be a King.
Import it
import { carriedFrom } from "@johnmorrisdotca/toranpu/klondike";
Definition
function carriedFrom(table: KlondikeTable, column: number, to: KlondikePile): number | null
Parameters
| Name | Type | Description |
|---|---|---|
table | KlondikeTable | The native solitaire table; move helpers leave the input unchanged. |
column | number | The zero-based tableau column. |
to | KlondikePile | The destination position or state specified by this API. |
Returns
number | null
Which card of a column a carry to to would take: the one face-up card whose run fits there, or null. A column's face-up cards are a single run, so only one card in it can be one below the target's top, and only its foot can be a King.
Examples
import { carriedFrom, dealKlondike, dealOfSeed, deckOf } from "@johnmorrisdotca/toranpu/klondike";
const table = dealKlondike(deckOf(dealOfSeed(42))!, { draw: 3, passes: 3 });
console.log(carriedFrom(table, 0, "2"));nullWhat it prints (run when this page was built)