---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxSearch.md
description: 'Search capability; every result is lazy, complete, and terminal-framed.'
---

# Interface: SandboxSearch

Defined in: [src/batteries/sandbox/contracts/search.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260824.1/src/src/batteries/sandbox/contracts/search.ts#L6)

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

## Methods

### findPaths()

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

Defined in: [src/batteries/sandbox/contracts/search.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260824.1/src/src/batteries/sandbox/contracts/search.ts#L15)

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`](../type-aliases/PathFrame.md)>

***

### searchContent()

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

Defined in: [src/batteries/sandbox/contracts/search.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260824.1/src/src/batteries/sandbox/contracts/search.ts#L8)

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`](../type-aliases/HitFrame.md)>