Skip to the content

Toranpuトランプ

Use a deck, play eleven games with computers, solve a solitaire, or display cards in your own design.

Toranpu is Japanese for playing cards. About the name

Contents

Reference · Games and state

SavedGametype

A game as toJSON writes it.

Import it

import type { SavedGame } from "@johnmorrisdotca/toranpu";

Definition

type SavedGame<K extends CardGameKind = CardGameKind> = {
    format: typeof SAVE_FORMAT;
    generator: string;
    game: K;
    size: number;
    players: string[];
    computers: boolean[];
    seed: number;
    moves: MoveOf<K>[];
};

Members

NameTypeDescription
format1

The shape of this object: SAVE_FORMAT.

generatorstring

What wrote it, such as "toranpu 1.2.0". For people; nothing reads it back.

gameK

Which game: "hearts", "ginRummy"…

sizenumber

How long the game lasts, in its own terms (CARD_GAME_TABLES).

playersstring[]

One name a seat.

computersboolean[]

One a seat: true where a computer plays.

seednumber

The seed every deal is shuffled from.

movesMoveOf<K>[]

Every move so far, in order.

Examples

import { newGame, savedGame } from "@johnmorrisdotca/toranpu";
import type { SavedGame } from "@johnmorrisdotca/toranpu";

const game = newGame("hearts", { players: ["Aki", "Ben", "Cy", "Dev"], seed: 42 })!;
const value: SavedGame<"hearts"> = savedGame("hearts", game);
console.log(value.seed);
42

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/toranpu 2.15.0.