ixfx
    Preparing search index...

    Type Alias RunOpts<ResultType>

    RunOpts: {
        filter?: (result: ResultType) => boolean;
        rank?: Comparer<ResultType>;
        shuffle?: boolean;
        stop?: (
            latest: ResultType | undefined,
            sorted: readonly ResultType[],
        ) => boolean;
    }

    Type Parameters

    • ResultType

    Type declaration

    • Optional Readonlyfilter?: (result: ResultType) => boolean

      If provided, filters the set of results prior to returning.

    • Optional Readonlyrank?: Comparer<ResultType>

      Function to rank results. By default uses defaultComparer which orders by numeric value or alphabetical.

    • Optional Readonlyshuffle?: boolean

      If true, execution order is shuffled each time

    • Optional Readonlystop?: (latest: ResultType | undefined, sorted: readonly ResultType[]) => boolean

      If provided, stops execution if true is returned. Result(s) include most recent execution.