Type Alias RunOpts<ResultType>

RunOpts<ResultType>: {
    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.

      • (result): boolean

      • Parameters

        Returns boolean

  • 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.

      • (latest, sorted): boolean

      • Parameters

        • latest: ResultType | undefined

          Latest result

        • sorted: readonly ResultType[]

          Sorted list of current results, not including latest

        Returns boolean

Settings

Member Visibility