Interface: SandboxSearch

Defined in: src/batteries/sandbox/contracts/search.ts:6

Search capability; every result is lazy, complete, and terminal-framed.

Methods

findPaths()

findPaths(o: {
  glob: string;
  maxDepth: number;
  root: string;
  signal?: AbortSignal;
}): AsyncIterable<PathFrame>;

Defined in: src/batteries/sandbox/contracts/search.ts:15

Lazily yield every matching path, then one done frame.

Parameters

Parameter	Type
o	{ glob: string; maxDepth: number; root: string; signal?: AbortSignal; }
o.glob	string
o.maxDepth	number
o.root	string
o.signal?	AbortSignal

Returns

AsyncIterable<PathFrame>

---

searchContent()

searchContent(o: {
  maxDepth: number;
  pattern: string;
  root: string;
  signal?: AbortSignal;
}): AsyncIterable<HitFrame>;

Defined in: src/batteries/sandbox/contracts/search.ts:8

Lazily yield every whole matching line, then one done frame.

Parameters

Parameter	Type
o	{ maxDepth: number; pattern: string; root: string; signal?: AbortSignal; }
o.maxDepth	number
o.pattern	string
o.root	string
o.signal?	AbortSignal

Returns

AsyncIterable<HitFrame>