`checkNotation`関数

リファレンスの説明と例は英語です。見出しと目次は日本語です。

A spec from notation, or which part of the text was refused and why. Never a roll of something else.

インポート

import { checkNotation } from "@johnmorrisdotca/korokoro";

定義

function checkNotation(text: string, options?: NotationOptions): NotationCheck

名前	型	説明
`text`	`string`	Text to parse, validate or format.
`options` (省略可)	`NotationOptions`	Options for this call; omitted fields keep their documented defaults.

NotationCheck

A spec from notation, or which part of the text was refused and why. Never a roll of something else.

import { checkNotation } from "@johnmorrisdotca/korokoro";
console.log(checkNotation("not dice"));

{
  ok: false,
  problem: 'shape',
  part: 'not dice',
  message: '“not dice”: this is not dice notation'
}

出力（このページを作ったときに実行した結果）

ソースを見る GitHub で編集@johnmorrisdotca/korokoro 1.16.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。