Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "operators/generators"

Index

Type aliases

Functions

Type aliases

AsyncGenerator

AsyncGenerator: function

An AsyncGenerator is a function that creates an AsyncIterable

Type declaration

    • (onUnsubscribe: function, ...args: any[]): AsyncIterable<T>

    • Parameters

      • onUnsubscribe: function
          • (callback: Function): void

          • Parameters

            • callback: Function

            Returns void

      • Rest ...args: any[]

      Returns AsyncIterable<T>

Functions

create

  • create<T>(onUnsubscribe: function, emitter: Emitter<T>): AsyncIterable<T>

  • Creates an async iterable from a callback using a BufferedObserver.

    Type parameters

    • T

    Parameters

    • onUnsubscribe: function
        • (callback: Function): void

        • Parameters

          • callback: Function

          Returns void

    • emitter: Emitter<T>

    Returns AsyncIterable<T>

fibonacci

  • fibonacci(onUnsubscribe: function, n?: undefined | number): AsyncIterable<number>

  • Creates an async iterable that generates the fibonacci sequence.

    Parameters

    • onUnsubscribe: function
        • (callback: Function): void

        • Parameters

          • callback: Function

          Returns void

    • Optional n: undefined | number

      Number of iterations, if supposed to end.

    Returns AsyncIterable<number>

interval

  • interval(onUnsubscribe: function, ms: number, max: number): AsyncIterable<number>

  • Creates an AsyncIterable that yields increments every given milliseconds for the given times

    Parameters

    • onUnsubscribe: function
        • (callback: Function): void

        • Parameters

          • callback: Function

          Returns void

    • ms: number

      Interval

    • max: number

      Count

    Returns AsyncIterable<number>

of

  • of<T>(onUnsubscribe: function, ...values: (T | Promise<T>)[]): AsyncIterable<T>

  • Creates an async iterable that emits the given arguments and awaits them in case they're promises.

    Type parameters

    • T

    Parameters

    • onUnsubscribe: function
        • (callback: Function): void

        • Parameters

          • callback: Function

          Returns void

    • Rest ...values: (T | Promise<T>)[]

    Returns AsyncIterable<T>

random

  • random(onUnsubscribe: function, min?: number, max?: number, count?: number): AsyncIterable<number>

  • Creates an async iterable that generates random numbers between min (inclusive) and max (exclusive). If count is not provided, it will endlessly generate numbers, otherwise stop at count.

    Parameters

    • onUnsubscribe: function
        • (callback: Function): void

        • Parameters

          • callback: Function

          Returns void

    • Default value min: number = 0

      Minimum value, inclusive. 0 by default.

    • Default value max: number = 1

      Maximum value, exclusive. 1 by default.

    • Default value count: number = Infinity

      The amount of random numbers to yield, if not provided, infinite.

    Returns AsyncIterable<number>

range

  • range(onUnsubscribe: function, from: number, to: number, step?: number): AsyncIterable<number>

  • Creates an async iterable that acts like a for-loop.

    Parameters

    • onUnsubscribe: function
        • (callback: Function): void

        • Parameters

          • callback: Function

          Returns void

    • from: number

      Startnumber

    • to: number

      Endnumber

    • Default value step: number = 1

      Stepsize

    Returns AsyncIterable<number>

Const sleep

  • sleep(ms: number): Promise<Object>

Generated using TypeDoc