1 min read · 19 words

Type Alias: Done

ts

type Done =
  | {
      complete: true;
      kind: "done";
    }
  | {
      atDepth: number;
      bound: "maxDepth";
      complete: false;
      kind: "done";
      omitted: "unexplored";
    }
  | {
      bound: "limit";
      complete: false;
      kind: "done";
      omitted: "over-limit";
      shown: number;
    };

Defined in: src/batteries/sandbox/types.ts:134

Terminal traversal protocol. Done is mandatory so end-of-stream cannot masquerade as completion.