Type Alias LazyChain<In, Out>

Type declaration

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

  • • (data?): Promise<Out[]>

    • Parameters

      • Optionaldata: GenOrData<In>

      Returns Promise<Out[]>

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

  • • (data?): LazyChain<In, Out>

    • Parameters

      • Optionaldata: GenOrData<In>

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

  • • (data?): AsyncGenerator<Out>

    • Parameters

      • Optionaldata: GenOrData<In>

      Returns AsyncGenerator<Out>

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

  Gets the average numerical value (if relevant)

  • • (): LazyChain<any, number>

    • Returns LazyChain<any, number>

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

  Chunk values into arrays

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

    • Parameters

      • size: number
      • OptionalreturnRemainers: boolean

      Returns LazyChain<In, Out>

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

  Debounce values

  • • (duration): LazyChain<In, Out>

    • Parameters

      • duration: Interval

      Returns LazyChain<In, Out>

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

  Delay emitting values

  • • (options): LazyChain<In, Out>

    • Parameters

      • options: DelayOptions

      Returns LazyChain<In, Out>

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

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

  • • (predicate): LazyChain<In, Out>

    • Parameters

      • predicate: ((value: In) => boolean)
        • • (value): boolean

          • Parameters

            • value: In

            Returns boolean

      Returns LazyChain<In, Out>

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

  Emit values until period has elapsed

  • • (period): LazyChain<In, Out>

    • Parameters

      • period: Interval

      Returns LazyChain<In, Out>

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

  Only allow values that meet predicate to pass

  • • (predicate): LazyChain<In, Out>

    • Parameters

      • predicate: ((input: any) => boolean)
        • • (input): boolean

          • Parameters

            • input: any

            Returns boolean

      Returns LazyChain<In, Out>

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

  • • (data?): Promise<Out | undefined>

    • Parameters

      • Optionaldata: GenOrData<In>

      Returns Promise<Out | undefined>

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

  Uses a function as a source of values

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

    • Parameters

      • callback: (() => any)
        • • (): any

          • Returns any

      Returns LazyChain<any, any>

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

  Sets data to be the data for the chain

  • • (data): LazyChain<In, Out>

    • Parameters

      • data: GenOrData<In>

      Returns LazyChain<In, Out>

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

  • • (data?): Promise<Out | undefined>

    • Parameters

      • Optionaldata: GenOrData<In>

      Returns Promise<Out | undefined>

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

  Gets the maximum numerical value (if relevant)

  • • (): LazyChain<any, number>

    • Returns LazyChain<any, number>

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

  Gets the minimum numerical value (if relevant)

  • • (): LazyChain<any, number>

    • Returns LazyChain<any, number>

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

  Only emit values that have ranked higher than previously seen

  • • (r, options): LazyChain<In, Out>

    • Parameters

      • r: RankFunction<In>
      • options: Partial<RankOptions>

      Returns LazyChain<In, Out>

• rankArray: ((r: RankFunction<In>, options: Partial<RankArrayOptions>) => LazyChain<In, Out>)

  • • (r, options): LazyChain<In, Out>

    • Parameters

      • r: RankFunction<In>
      • options: Partial<RankArrayOptions>

      Returns LazyChain<In, Out>

• reduce: ((reducer: ((values: any[]) => any)) => LazyChain<In, Out>)

  Flatten values in an array into a single value

  • • (reducer): LazyChain<In, Out>

    • Parameters

      • reducer: ((values: any[]) => any)
        • • (values): any

          • Parameters

            • values: any[]

            Returns any

      Returns LazyChain<In, Out>

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

  Gets the total of numerical values

  • • (): LazyChain<In, number>

    • Returns LazyChain<In, number>

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

  Take limit number of values from the chain before ending

  • • (limit): LazyChain<In, Out>

    • Parameters

      • limit: number

      Returns LazyChain<In, Out>

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

  Emits a running tally of how many values have been emitted

  • • (countArrayItems): 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

  • • (transformer): LazyChain<In, Out>

    • Parameters

      • transformer: ((v: any) => any)
        • • (v): any

          • Parameters

            • v: any

            Returns any

      Returns LazyChain<In, Out>