Type Alias SearchCallbackResult<T>

Extra utilities that do not belong in the core.

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

Properties

found?: T

if not undefined, this means the term is of interest and will appear in the result

offset?: number

0 = keep the term to compute further terms (the default); n<0 = discard the term; n>0 = keep the term, but delay its use by n generations

stop?: boolean

true = stop the search immediately