@struktoai/mirage-core/dist/core/box/search.d.ts

A Unified Virtual Filesystem For AI Agents

import type { BoxAccessor } from '../../accessor/box.ts';
import { type FileStat, type PathSpec } from '../../types.ts';
/**
 * The files under `under` Box content search returns. The scope is searched
 * with its folder id as `ancestor_folder_ids` and each hit keyed from its
 * `path_collection`. Null whenever the answer may miss a match: an API
 * failure, the 10,000-match ceiling, a scope that is not a folder, or no hit
 * at all, since Box indexes a write some time after it lands. `entry` is what
 * is at `under`.
 *
 * Box searches the text it extracted, not the bytes grep reads, so the
 * answer can leave out a file that holds the text: an office file, PDF or
 * archive, the end of a large file, a word Box splits differently
 * (`foo.bar`), or a recent write.
 *
 * Mirrors Python's `files_containing`.
 */
export declare function filesContaining(accessor: BoxAccessor, text: string, under: PathSpec, entry?: FileStat | null): Promise<PathSpec[] | null>;
//# sourceMappingURL=search.d.ts.map