Type Alias: NotationCheck

type NotationCheck = 
  | {
  ok: true;
  spec: RollSpec;
}
  | {
  ok: false;
  problem: NotationProblem;
  part: string;
  message: string;
};

Defined in: src/notation.ts:133

What checkNotation found: the spec, or the part it refused and why.

Union Members

Type Literal

{
  ok: true;
  spec: RollSpec;
}

---

Type Literal

{
  ok: false;
  problem: NotationProblem;
  part: string;
  message: string;
}

ok

ok: false;

problem

problem: NotationProblem;

part

part: string;

The piece of the text that was refused, as typed.

message

message: string;

The refusal in a plain English sentence.