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 · Sound controls

CardSoundsOptionstype

How a table's sounds are made. Every field may be left out.

Import it

import type { CardSoundsOptions } from "@johnmorrisdotca/toranpu/card-sounds";

Definition

type CardSoundsOptions = {
    muted?: boolean;
    volume?: number;
    load?: () => Promise<{
        CARD_SOUND_DATA: CardSoundData;
    }>;
    window?: CardSoundWindow | null;
};

Members

NameTypeDescription
muted (optional)boolean | undefined

Start muted: nothing plays, and nothing is fetched, until setMuted(false). Unless said, not muted.

volume (optional)number | undefined

How loud, from 0 to 1. Unless said, 0.6.

load (optional)(() => Promise<{ CARD_SOUND_DATA: CardSoundData; }>) | undefined

Where the recordings come from: the package's own module unless another is handed in.

window (optional)CardSoundWindow | null | undefined

The window to make sound in: the page's own unless another is handed in (a test's, or none for silence).

Examples

import type { CardSoundsOptions } from "@johnmorrisdotca/toranpu/card-sounds";

const value: CardSoundsOptions = { muted: true, volume: 0.5, window: null };
console.log(value.volume);
0.5

What it prints (run when this page was built)

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