ixfx
    Preparing search index...

    Type Alias LazyChain<In, Out>

    Lazy execution of a chain

    type LazyChain<In, Out> = {
        asArray: (data?: GenOrData<In>) => Promise<Out[]>;
        asAsync: (data?: GenOrData<In>) => LazyChain<In, Out>;
        asGenerator: (data?: GenOrData<In>) => AsyncGenerator<Out>;
        average: () => LazyChain<any, number>;
        chunk: (size: number, returnRemainers?: boolean) => LazyChain<In, Out>;
        debounce: (duration: Interval) => LazyChain<In, Out>;
        delay: (options: DelayOptions) => LazyChain<In, Out>;
        drop: (predicate: (value: In) => boolean) => LazyChain<In, Out>;
        duration: (period: Interval) => LazyChain<In, Out>;
        filter: (predicate: (input: any) => boolean) => LazyChain<In, Out>;
        firstOutput: (data?: GenOrData<In>) => Promise<Out | undefined>;
        fromFunction: (callback: () => any) => LazyChain<any, any>;
        input: (data: GenOrData<In>) => LazyChain<In, Out>;
        lastOutput: (data?: GenOrData<In>) => Promise<Out | undefined>;
        max: () => LazyChain<any, number>;
        min: () => LazyChain<any, number>;
        rank: (
            r: RankFunction<In>,
            options: Partial<RankOptions>,
        ) => LazyChain<In, Out>;
        rankArray: (
            r: RankFunction<In>,
            options: Partial<RankArrayOptions>,
        ) => LazyChain<In, Out>;
        reduce: (reducer: (values: any[]) => any) => LazyChain<In, Out>;
        sum: () => LazyChain<In, number>;
        take: (limit: number) => LazyChain<In, Out>;
        tally: (countArrayItems: boolean) => LazyChain<In, number>;
        transform: (transformer: (v: any) => any) => LazyChain<In, Out>;
    }

    Type Parameters

    • In
    • Out
    Index

    Properties

    asArray asAsync asGenerator average chunk debounce delay drop duration filter firstOutput fromFunction input lastOutput max min rank rankArray reduce sum take tally transform

    Properties

    asArray: (data?: GenOrData<In>) => Promise<Out[]>

    Returns the results of the chain as an array. If data is not supplied, the last value given calling input(data) is used.

    Type declaration

    asAsync: (data?: GenOrData<In>) => LazyChain<In, Out>
    asGenerator: (data?: GenOrData<In>) => AsyncGenerator<Out>

    Return the results of the chain as a regular generator. If data is not supplied, the last value given calling input(data) is used.

    Type declaration

    average: () => LazyChain<any, number>

    Gets the average numerical value (if relevant)

    Type declaration

    chunk: (size: number, returnRemainers?: boolean) => LazyChain<In, Out>

    Chunk values into arrays

    Type declaration

      • (size: number, returnRemainers?: boolean): LazyChain<In, Out>

      • Parameters

        • size: number
        • OptionalreturnRemainers: boolean

        Returns LazyChain<In, Out>

    debounce: (duration: Interval) => LazyChain<In, Out>

    Debounce values

    Type declaration

    delay: (options: DelayOptions) => LazyChain<In, Out>

    Delay emitting values

    Type declaration

    drop: (predicate: (value: In) => boolean) => LazyChain<In, Out>

    Ignore values that match predicate (opposite of filter())

    Type declaration

    duration: (period: Interval) => LazyChain<In, Out>

    Emit values until period has elapsed

    Type declaration

    filter: (predicate: (input: any) => boolean) => LazyChain<In, Out>

    Only allow values that meet predicate to pass

    Type declaration

    firstOutput: (data?: GenOrData<In>) => Promise<Out | undefined>

    Gets the first output value from the chain. If data is not supplied, the last value given calling input(data) is used.

    Type declaration

    fromFunction: (callback: () => any) => LazyChain<any, any>

    Uses a function as a source of values

    Type declaration

      • (callback: () => any): LazyChain<any, any>

      • Parameters

        • callback: () => any

        Returns LazyChain<any, any>

    input: (data: GenOrData<In>) => LazyChain<In, Out>

    Sets data to be the data for the chain

    Type declaration

    lastOutput: (data?: GenOrData<In>) => Promise<Out | undefined>

    Gets the last output value from the chain. If data is not supplied, the last value given calling input(data) is used.

    Type declaration

    max: () => LazyChain<any, number>

    Gets the maximum numerical value (if relevant)

    Type declaration

    min: () => LazyChain<any, number>

    Gets the minimum numerical value (if relevant)

    Type declaration

    rank: (r: RankFunction<In>, options: Partial<RankOptions>) => LazyChain<In, Out>

    Only emit values that have ranked higher than previously seen

    rankArray: (
        r: RankFunction<In>,
        options: Partial<RankArrayOptions>,
    ) => LazyChain<In, Out>
    reduce: (reducer: (values: any[]) => any) => LazyChain<In, Out>

    Flatten values in an array into a single value

    Type declaration

    sum: () => LazyChain<In, number>

    Gets the total of numerical values

    Type declaration

    take: (limit: number) => LazyChain<In, Out>

    Take limit number of values from the chain before ending

    Type declaration

    tally: (countArrayItems: boolean) => LazyChain<In, number>

    Emits a running tally of how many values have been emitted

    Type declaration

      • (countArrayItems: boolean): LazyChain<In, number>

      • Parameters

        • countArrayItems: boolean

        Returns LazyChain<In, number>

    transform: (transformer: (v: any) => any) => LazyChain<In, Out>

    Transform an input value to an output

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties