Skip to content

tyneq


tyneq / createCachedTerminalOperator

Function: createCachedTerminalOperator()

createCachedTerminalOperator<TSource, TArgs, TResult>(config): void

Defined in: src/plugin/registration/createCachedTerminalOperator.ts:29

Registers a terminal operator available only on cached sequences.

The execute function receives the full CachedEnumerable as its first argument, giving access to cached-sequence members (refresh(), internal cache, etc.).

Type Parameters

Type Parameter
TSource
TArgs extends unknown[]
TResult

Parameters

ParameterTypeDescription
config{ name: string; execute: (source, ...args) => TResult; validate?: (...args) => void; source?: OperatorSource; }-
config.namestringMethod name to expose on cached sequences.
config.execute(source, ...args) => TResultFunction that consumes the cached source and returns a result.
config.validate?(...args) => voidOptional eager validation for user-supplied arguments.
config.source?OperatorSource-

Returns

void

Example

ts
createCachedTerminalOperator({
    name: "cacheSize",
    execute(source: CachedEnumerable<unknown>): number {
        return [...source].length;
    }
});