Type Alias ExplainArguments

ExplainArguments:
    | {
        positional: string[];
        queries: string[];
        read: true;
        tokens: ExplainArgumentToken[];
    }
    | { read: false; why: string }

What the statement-scope lexer decided about one command's arguments.

All-or-nothing by construction (src/explain/args.ts): the consumer is a REST rendering, and a partially-read argument list changes what the rendered command DOES. read: false carries the reason, which the transport basis then quotes rather than reporting a bare unknown.

Type Declaration

{
    positional: string[];
    queries: string[];
    read: true;
    tokens: ExplainArgumentToken[];
}
- positional: string[]
  Bare tokens, in order — an id (*1), a where, a find operand.
- queries: string[]
  ?-prefixed query words, in order.
- read: true
- tokens: ExplainArgumentToken[]
{ read: false; why: string }

Type Alias ExplainArguments

Type Declaration

positional: string[]

queries: string[]

read: true

tokens: ExplainArgumentToken[]

Settings