ixfx
    Preparing search index...

    Type Alias RunOpts<ResultType>

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

    Type Parameters

    • ResultType
    Index

    Properties

    filter? rank? shuffle? stop?

    Properties

    filter?: (result: ResultType) => boolean

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

    Type declaration

    rank?: Comparer<ResultType>

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

    shuffle?: boolean

    If true, execution order is shuffled each time

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

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

    Type declaration

      • (latest: ResultType | undefined, sorted: readonly ResultType[]): boolean

      • Parameters

        • latest: ResultType | undefined

          Latest result

        • sorted: readonly ResultType[]

          Sorted list of current results, not including latest

        Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties