Github Link
      ⚠️ Internal: This API is not publically exported by the package.

      Class Stream<T>

      Wrapper around IterableIterator interface offering a set of helpers to deal with iterations in a simple way

      Remarks

      Since 0.0.7

      Type Parameters

      • T

      Implements

      • IterableIterator<T>

      Constructors

      constructor

      Methods

      [iterator] drop dropWhile every filter flatMap getNthOrLast has join map next take takeWhile nil of

      Constructors

      constructor

      • new Stream<T>(g): Stream<T>

      • Create a Stream based on g

        Type Parameters

        • T

        Parameters

        • g: IterableIterator<T>

          Underlying data of the Stream

        Returns Stream<T>

      Methods

      [iterator]

      • [iterator](): IterableIterator<T>

      • Returns IterableIterator<T>

      drop

      • drop(n): Stream<T>

      • Drop n first elements of the Stream

        WARNING: It closes the current stream

        Parameters

        • n: number

          Number of elements to drop

        Returns Stream<T>

        Remarks

        Since 0.0.1

      dropWhile

      • dropWhile(f): Stream<T>

      • Drop elements from the Stream while f(element) === true

        WARNING: It closes the current stream

        Parameters

        • f: ((v) => boolean)

          Drop condition

            • (v): boolean

            • Parameters

              • v: T

              Returns boolean

        Returns Stream<T>

        Remarks

        Since 0.0.1

      every

      • every(f): boolean

      • Check whether all elements of the Stream are successful for f

        WARNING: It closes the current stream

        Parameters

        • f: ((v) => boolean)

          Condition to check

            • (v): boolean

            • Parameters

              • v: T

              Returns boolean

        Returns boolean

        Remarks

        Since 0.0.1

      filter

      • filter<U>(f): Stream<U>

      • Filter elements of the Stream

        WARNING: It closes the current stream

        Type Parameters

        • U

        Parameters

        • f: ((v) => v is U)

          Elements to keep

            • (v): v is U

            • Parameters

              • v: T

              Returns v is U

        Returns Stream<U>

        Remarks

        Since 1.23.0

      • filter(f): Stream<T>

      • Filter elements of the Stream

        WARNING: It closes the current stream

        Parameters

        • f: ((v) => boolean)

          Elements to keep

            • (v): boolean

            • Parameters

              • v: T

              Returns boolean

        Returns Stream<T>

        Remarks

        Since 0.0.1

      flatMap

      • flatMap<U>(f): Stream<U>

      • Flat map all elements of the Stream using f

        WARNING: It closes the current stream

        Type Parameters

        • U

        Parameters

        • f: ((v) => IterableIterator<U>)

          Mapper function

            • (v): IterableIterator<U>

            • Parameters

              • v: T

              Returns IterableIterator<U>

        Returns Stream<U>

        Remarks

        Since 0.0.1

      getNthOrLast

      • getNthOrLast(nth): T

      • Take the nth element of the Stream of the last (if it does not exist)

        WARNING: It closes the current stream

        Parameters

        • nth: number

          Position of the element to extract

        Returns T

        Remarks

        Since 0.0.12

      has

      • has(f): [boolean, T]

      • Check whether one of the elements of the Stream is successful for f

        WARNING: It closes the current stream

        Parameters

        • f: ((v) => boolean)

          Condition to check

            • (v): boolean

            • Parameters

              • v: T

              Returns boolean

        Returns [boolean, T]

        Remarks

        Since 0.0.1

      join

      • join(...others): Stream<T>

      • Join others Stream to the current Stream

        WARNING: It closes the current stream and the other ones (as soon as it iterates over them)

        Parameters

        • Rest ...others: IterableIterator<T>[]

          Streams to join to the current Stream

        Returns Stream<T>

        Remarks

        Since 0.0.1

      map

      • map<U>(f): Stream<U>

      • Map all elements of the Stream using f

        WARNING: It closes the current stream

        Type Parameters

        • U

        Parameters

        • f: ((v) => U)

          Mapper function

            • (v): U

            • Parameters

              • v: T

              Returns U

        Returns Stream<U>

        Remarks

        Since 0.0.1

      next

      • next(): IteratorResult<T, any>

      • Returns IteratorResult<T, any>

      take

      • take(n): Stream<T>

      • Take n first elements of the Stream

        WARNING: It closes the current stream

        Parameters

        • n: number

          Number of elements to take

        Returns Stream<T>

        Remarks

        Since 0.0.1

      takeWhile

      • takeWhile(f): Stream<T>

      • Take elements from the Stream while f(element) === true

        WARNING: It closes the current stream

        Parameters

        • f: ((v) => boolean)

          Take condition

            • (v): boolean

            • Parameters

              • v: T

              Returns boolean

        Returns Stream<T>

        Remarks

        Since 0.0.1

      Static nil

      • nil<T>(): Stream<T>

      • Create an empty stream of T

        Type Parameters

        • T

        Returns Stream<T>

        Remarks

        Since 0.0.1

      Static of

      • of<T>(...elements): Stream<T>

      • Create a stream of T from a variable number of elements

        Type Parameters

        • T

        Parameters

        • Rest ...elements: T[]

          Elements used to create the Stream

        Returns Stream<T>

        Remarks

        Since 2.12.0

      Settings

      Member Visibility

      Theme

      On This Page