Type Alias SearchCallbackResult

Extra utilities that do not belong in the core.

type SearchCallbackResult = {
    found?: boolean;
    offset?: number;
    stop?: boolean;
}

Properties

found?: boolean

true = emit this term as a found result

offset?: number

≥0 = cache at gen+offset; negative = discard; omitted = auto-compute

stop?: boolean

true = stop the search (after yielding if found is also true)