Interface OrphanCrawlOptions

interface OrphanCrawlOptions {
    expectedFileNames: ReadonlySet<string>;
    maxOrphans: number;
    maxExamined: number;
    shouldStop: () => boolean;
    onOrphan: (orphan: OrphanFile) => Promise<void>;
}

Properties

expectedFileNames: ReadonlySet<string>

File names the index listed when the crawl began.

maxOrphans: number

Most orphans handed to onOrphan this crawl (the per-session budget).

maxExamined: number

Most file names examined this crawl, orphan or not.

shouldStop: () => boolean

Re-polled between awaits; true halts the crawl (dispose / clear / breaker).

onOrphan: (orphan: OrphanFile) => Promise<void>

Decide and act on one orphan. Must not throw (errors are swallowed).