toJSON関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
Rolls as JSON, two spaces deep, with the format's number first. stats: true adds statsOf the rolls. fromJSON reads it back.
インポート
import { toJSON } from "@johnmorrisdotca/korokoro";定義
function toJSON(rolls: readonly Roll[], options?: { stats?: boolean; }): string引数
| 名前 | 型 | 説明 |
|---|---|---|
rolls | readonly Roll[] | Completed rolls, or the number of attempts where this parameter is numeric. |
options (省略可) | { stats?: boolean; } | Options for this call; omitted fields keep their documented defaults. |
戻り値
string
Rolls as JSON, two spaces deep, with the format's number first. stats: true adds statsOf the rolls. fromJSON reads it back.
例
import { toJSON } from "@johnmorrisdotca/korokoro";
import { normalizeSpec, rollFrom } from "@johnmorrisdotca/korokoro";
const spec = normalizeSpec({ count: 2, sides: 6 });
const sample = rollFrom(spec, [2, 5], "saved", 0, null)!;
console.log(toJSON([sample]));{
"format": 1,
"generator": "korokoro 1.16.0",
"rolls": [
{
"id": "saved",
"notation": "2d6",
"spec": {
"count": 2,
"sides": 6,
"modifier": 0,
"keep": "all"
},
"faces": [
2,
5
],
"kept": [
true,
true
],
"total": 7,
"at": 0,
"time": "1970-01-01T00:00:00.000Z",
"seed": null,
"dice": [
{
"face": 2,
"status": "kept",
"exploded": false,
"die": 0
},
{
"face": 5,
"status": "kept",
"exploded": false,
"die": 1
}
]
}
]
}出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。