KC's Workspace
    Preparing search index...

    Interface Seq<K, V>

    The interface to fulfill to qualify as a Value Object.

    interface Seq<K, V> {
        size: number | undefined;
        "[iterator]"(): IterableIterator<unknown>;
        butLast(): this;
        cacheResult(): this;
        concat(...valuesOrCollections: unknown[]): Seq<unknown, unknown>;
        contains(value: V): boolean;
        count(): number;
        count(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): number;
        countBy<G>(
            grouper: (value: V, key: K, iter: this) => G,
            context?: unknown,
        ): Map<G, number>;
        entries(): IterableIterator<[K, V]>;
        entrySeq(): Indexed<[K, V]>;
        equals(other: unknown): boolean;
        every(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): boolean;
        filter<F>(
            predicate: (value: V, key: K, iter: this) => value is F,
            context?: unknown,
        ): Seq<K, F>;
        filter(
            predicate: (value: V, key: K, iter: this) => unknown,
            context?: unknown,
        ): this;
        filterNot(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): this;
        find(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
            notSetValue?: V,
        ): V | undefined;
        findEntry(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
            notSetValue?: V,
        ): [K, V] | undefined;
        findKey(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): K | undefined;
        findLast(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
            notSetValue?: V,
        ): V | undefined;
        findLastEntry(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
            notSetValue?: V,
        ): [K, V] | undefined;
        findLastKey(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): K | undefined;
        first<NSV>(notSetValue: NSV): V | NSV;
        first(): V | undefined;
        flatMap<M>(
            mapper: (value: V, key: K, iter: this) => Iterable<M>,
            context?: unknown,
        ): Seq<K, M>;
        flatMap<M>(
            mapper: (value: V, key: K, iter: this) => Iterable<M>,
            context?: unknown,
        ): Seq<M, M>;
        flatten(depth?: number): Collection<unknown, unknown>;
        flatten(shallow?: boolean): Collection<unknown, unknown>;
        forEach(
            sideEffect: (value: V, key: K, iter: this) => unknown,
            context?: unknown,
        ): number;
        get<NSV>(key: K, notSetValue: NSV): V | NSV;
        get(key: K): V | undefined;
        getIn(searchKeyPath: Iterable<unknown>, notSetValue?: unknown): unknown;
        groupBy<G>(
            grouper: (value: V, key: K, iter: this) => G,
            context?: unknown,
        ): Map<G, Seq<K, V>>;
        has(key: K): boolean;
        hashCode(): number;
        hasIn(searchKeyPath: Iterable<unknown>): boolean;
        includes(value: V): boolean;
        isEmpty(): boolean;
        isSubset(iter: Iterable<V>): boolean;
        isSuperset(iter: Iterable<V>): boolean;
        join(separator?: string): string;
        keyOf(searchValue: V): K | undefined;
        keys(): IterableIterator<K>;
        keySeq(): Indexed<K>;
        last<NSV>(notSetValue: NSV): V | NSV;
        last(): V | undefined;
        lastKeyOf(searchValue: V): K | undefined;
        map<M>(
            mapper: (value: V, key: K, iter: this) => M,
            context?: unknown,
        ): Seq<K, M>;
        map<M>(
            mapper: (value: V, key: K, iter: this) => M,
            context?: unknown,
        ): Seq<M, M>;
        max(comparator?: Comparator<V>): V | undefined;
        maxBy<C>(
            comparatorValueMapper: (value: V, key: K, iter: this) => C,
            comparator?: Comparator<C>,
        ): V | undefined;
        min(comparator?: Comparator<V>): V | undefined;
        minBy<C>(
            comparatorValueMapper: (value: V, key: K, iter: this) => C,
            comparator?: Comparator<C>,
        ): V | undefined;
        partition<F, C>(
            predicate: (this: C, value: V, key: K, iter: this) => value is F,
            context?: C,
        ): [Seq<K, V>, Seq<K, F>];
        partition<C>(
            predicate: (this: C, value: V, key: K, iter: this) => unknown,
            context?: C,
        ): [Seq<K, V>, Seq<K, V>];
        reduce(reducer: (reduction: V, value: V, key: K, iter: this) => V): V;
        reduce<R>(
            reducer: (reduction: R, value: V, key: K, iter: this) => R,
            initialReduction: R,
            context?: unknown,
        ): R;
        reduce<R>(
            reducer: (reduction: V | R, value: V, key: K, iter: this) => R,
        ): R;
        reduceRight(reducer: (reduction: V, value: V, key: K, iter: this) => V): V;
        reduceRight<R>(
            reducer: (reduction: R, value: V, key: K, iter: this) => R,
            initialReduction: R,
            context?: unknown,
        ): R;
        reduceRight<R>(
            reducer: (reduction: V | R, value: V, key: K, iter: this) => R,
        ): R;
        rest(): this;
        reverse(): this;
        skip(amount: number): this;
        skipLast(amount: number): this;
        skipUntil(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): this;
        skipWhile(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): this;
        slice(begin?: number, end?: number): this;
        some(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): boolean;
        sort(comparator?: Comparator<V>): this;
        sortBy<C>(
            comparatorValueMapper: (value: V, key: K, iter: this) => C,
            comparator?: Comparator<C>,
        ): this;
        take(amount: number): this;
        takeLast(amount: number): this;
        takeUntil(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): this;
        takeWhile(
            predicate: (value: V, key: K, iter: this) => boolean,
            context?: unknown,
        ): this;
        toArray(): V[] | [K, V][];
        toIndexedSeq(): Indexed<V>;
        toJS(): | DeepCopy<V>[]
        | {
            [key: string]: DeepCopy<V>;
            [key: number]: DeepCopy<V>;
            [key: symbol]: DeepCopy<V>;
        };
        toJSON(): V[] | { [key: string]: V; [key: number]: V; [key: symbol]: V };
        toKeyedSeq(): Keyed<K, V>;
        toList(): List<V>;
        toMap(): Map<K, V>;
        toObject(): { [key: string]: V };
        toOrderedMap(): OrderedMap<K, V>;
        toOrderedSet(): OrderedSet<V>;
        toSeq(): Seq<K, V>;
        toSet(): Set<V>;
        toSetSeq(): Set<V>;
        toStack(): Stack<V>;
        update<R>(updater: (value: this) => R): R;
        values(): IterableIterator<V>;
        valueSeq(): Indexed<V>;
    }

    Type Parameters

    • K
    • V

    Hierarchy (View Summary)

    Index
    size
    [iterator] butLast cacheResult concat contains count countBy entries entrySeq equals every filter filterNot find findEntry findKey findLast findLastEntry findLastKey first flatMap flatten forEach get getIn groupBy has hashCode hasIn includes isEmpty isSubset isSuperset join keyOf keys keySeq last lastKeyOf map max maxBy min minBy partition reduce reduceRight rest reverse skip skipLast skipUntil skipWhile slice some sort sortBy take takeLast takeUntil takeWhile toArray toIndexedSeq toJS toJSON toKeyedSeq toList toMap toObject toOrderedMap toOrderedSet toSeq toSet toSetSeq toStack update values valueSeq
    size: number | undefined

    Some Seqs can describe their size lazily. When this is the case, size will be an integer. Otherwise it will be undefined.

    For example, Seqs returned from map() or reverse() preserve the size of the original Seq while filter() does not.

    Note: Range, Repeat and Seqs made from Arrays and Objects will always have a size.

    • Returns a new Collection of the same type containing all entries except the last.

      Returns this

    • Because Sequences are lazy and designed to be chained together, they do not cache their results. For example, this map function is called a total of 6 times, as each join iterates the Seq of three values.

      var squares = Seq([ 1, 2, 3 ]).map(x => x * x)
squares.join() + squares.join()

      If you know a Seq will be used multiple times, it may be more efficient to first cache it in memory. Here, the map function is called only 3 times.

      var squares = Seq([ 1, 2, 3 ]).map(x => x * x).cacheResult()
squares.join() + squares.join()

      Use this method judiciously, as it must fully evaluate a Seq which can be a burden on memory and possibly performance.

      Note: after calling cacheResult, a Seq will always have a size.

      Returns this

    • Returns a new Sequence of the same type with other values and collection-like concatenated to this one.

      All entries will be present in the resulting Seq, even if they have the same key.

      Parameters

      • ...valuesOrCollections: unknown[]

      Returns Seq<unknown, unknown>

    • Parameters

      • value: V

      Returns boolean

    • Returns the size of this Collection.

      Regardless of if this Collection can describe its size lazily (some Seqs cannot), this method will always return the correct size. E.g. it evaluates a lazy Seq if necessary.

      If predicate is provided, then this returns the count of entries in the Collection for which the predicate returns true.

      Returns number

    • Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns number

    • Returns a Seq.Keyed of counts, grouped by the return value of the grouper function.

      Note: This is not a lazy operation.

      Type Parameters

      • G

      Parameters

      • grouper: (value: V, key: K, iter: this) => G
      • Optionalcontext: unknown

      Returns Map<G, number>

    • An iterator of this Collection's entries as [ key, value ] tuples.

      Note: this will return an ES6 iterator which does not support Immutable.js sequence algorithms. Use entrySeq instead, if this is what you want.

      Returns IterableIterator<[K, V]>

    • True if this and the other Collection have value equality, as defined by Immutable.is().

      Note: This is equivalent to Immutable.is(this, other), but provided to allow for chained expressions.

      Parameters

      • other: unknown

      Returns boolean

    • True if predicate returns true for all entries in the Collection.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns boolean

    • Returns a new Seq with only the values for which the predicate function returns true.

      Note: filter() always returns a new instance, even if it results in not filtering out any values.

      Type Parameters

      • F

      Parameters

      • predicate: (value: V, key: K, iter: this) => value is F
      • Optionalcontext: unknown

      Returns Seq<K, F>

    • Returns a new Collection of the same type with only the entries for which the predicate function returns true.

      Note: filter() always returns a new instance, even if it results in not filtering out any values.

      Parameters

      • predicate: (value: V, key: K, iter: this) => unknown
      • Optionalcontext: unknown

      Returns this

    • Returns a new Collection of the same type with only the entries for which the predicate function returns false.

      Note: filterNot() always returns a new instance, even if it results in not filtering out any values.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns this

    • Returns the first value for which the predicate returns true.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown
      • OptionalnotSetValue: V

      Returns V | undefined

    • Returns the first [key, value] entry for which the predicate returns true.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown
      • OptionalnotSetValue: V

      Returns [K, V] | undefined

    • Returns the key for which the predicate returns true.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns K | undefined

    • Returns the last value for which the predicate returns true.

      Note: predicate will be called for each entry in reverse.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown
      • OptionalnotSetValue: V

      Returns V | undefined

    • Returns the last [key, value] entry for which the predicate returns true.

      Note: predicate will be called for each entry in reverse.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown
      • OptionalnotSetValue: V

      Returns [K, V] | undefined

    • Returns the last key for which the predicate returns true.

      Note: predicate will be called for each entry in reverse.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns K | undefined

    • In case the Collection is not empty returns the first element of the Collection. In case the Collection is empty returns the optional default value if provided, if no default value is provided returns undefined.

      Type Parameters

      • NSV

      Parameters

      • notSetValue: NSV

      Returns V | NSV

    • Returns V | undefined

    • Flat-maps the Seq, returning a Seq of the same type.

      Similar to seq.map(...).flatten(true).

      Type Parameters

      • M

      Parameters

      • mapper: (value: V, key: K, iter: this) => Iterable<M>
      • Optionalcontext: unknown

      Returns Seq<K, M>

    • Flat-maps the Seq, returning a Seq of the same type.

      Similar to seq.map(...).flatten(true). Note: Used only for sets.

      Type Parameters

      • M

      Parameters

      • mapper: (value: V, key: K, iter: this) => Iterable<M>
      • Optionalcontext: unknown

      Returns Seq<M, M>

    • Flattens nested Collections.

      Will deeply flatten the Collection by default, returning a Collection of the same type, but a depth can be provided in the form of a number or boolean (where true means to shallowly flatten one level). A depth of 0 (or shallow: false) will deeply flatten.

      Flattens only others Collection, not Arrays or Objects.

      Note: flatten(true) operates on Collection<unknown, Collection<K, V>> and returns Collection<K, V>

      Parameters

      • Optionaldepth: number

      Returns Collection<unknown, unknown>

    • Parameters

      • Optionalshallow: boolean

      Returns Collection<unknown, unknown>

    • The sideEffect is executed for every entry in the Collection.

      Unlike Array#forEach, if any call of sideEffect returns false, the iteration will stop. Returns the number of entries iterated (including the last iteration which returned false).

      Parameters

      • sideEffect: (value: V, key: K, iter: this) => unknown
      • Optionalcontext: unknown

      Returns number

    • Returns the value associated with the provided key, or notSetValue if the Collection does not contain this key.

      Note: it is possible a key may be associated with an undefined value, so if notSetValue is not provided and this method returns undefined, that does not guarantee the key was not found.

      Type Parameters

      • NSV

      Parameters

      • key: K
      • notSetValue: NSV

      Returns V | NSV

    • Parameters

      • key: K

      Returns V | undefined

    • Returns the value found by following a path of keys or indices through nested Collections.

      Plain JavaScript Object or Arrays may be nested within an Immutable.js Collection, and getIn() can access those values as well:

      Parameters

      • searchKeyPath: Iterable<unknown>
      • OptionalnotSetValue: unknown

      Returns unknown

    • Returns a Map of Collection, grouped by the return value of the grouper function.

      Note: This is always an eager operation.

      Type Parameters

      • G

      Parameters

      • grouper: (value: V, key: K, iter: this) => G
      • Optionalcontext: unknown

      Returns Map<G, Seq<K, V>>

    • True if a key exists within this Collection, using Immutable.is to determine equality

      Parameters

      • key: K

      Returns boolean

    • Computes and returns the hashed identity for this Collection.

      The hashCode of a Collection is used to determine potential equality, and is used when adding this to a Set or as a key in a Map, enabling lookup via a different instance.

      If two values have the same hashCode, they are not guaranteed to be equal. If two values have different hashCodes, they must not be equal.

      Returns number

    • True if the result of following a path of keys or indices through nested Collections results in a set value.

      Parameters

      Returns boolean

    • True if a value exists within this Collection, using Immutable.is to determine equality

      Parameters

      • value: V

      Returns boolean

      contains

    • Returns true if this Collection includes no values.

      For some lazy Seq, isEmpty might need to iterate to determine emptiness. At most one iteration will occur.

      Returns boolean

    • Joins values together as a string, inserting a separator between each. The default separator is ",".

      Parameters

      • Optionalseparator: string

      Returns string

    • Returns the key associated with the search value, or undefined.

      Parameters

      • searchValue: V

      Returns K | undefined

    • An iterator of this Collection's keys.

      Note: this will return an ES6 iterator which does not support Immutable.js sequence algorithms. Use keySeq instead, if this is what you want.

      Returns IterableIterator<K>

    • In case the Collection is not empty returns the last element of the Collection. In case the Collection is empty returns the optional default value if provided, if no default value is provided returns undefined.

      Type Parameters

      • NSV

      Parameters

      • notSetValue: NSV

      Returns V | NSV

    • Returns V | undefined

    • Returns the last key associated with the search value, or undefined.

      Parameters

      • searchValue: V

      Returns K | undefined

    • Returns a new Seq with values passed through a mapper function.

      import { Seq } from 'immutable'
      Seq([ 1, 2 ]).map(x => 10 * x)
      // Seq [ 10, 20 ]

      Note: map() always returns a new instance, even if it produced the same value at every step.

      Type Parameters

      • M

      Parameters

      • mapper: (value: V, key: K, iter: this) => M
      • Optionalcontext: unknown

      Returns Seq<K, M>

    • Returns a new Seq with values passed through a mapper function.

      import { Seq } from 'immutable'
      Seq([ 1, 2 ]).map(x => 10 * x)
      // Seq [ 10, 20 ]

      Note: map() always returns a new instance, even if it produced the same value at every step. Note: used only for sets.

      Type Parameters

      • M

      Parameters

      • mapper: (value: V, key: K, iter: this) => M
      • Optionalcontext: unknown

      Returns Seq<M, M>

    • Returns the maximum value in this collection. If any values are comparatively equivalent, the first one found will be returned.

      The comparator is used in the same way as Collection#sort. If it is not provided, the default comparator is >.

      When two values are considered equivalent, the first encountered will be returned. Otherwise, max will operate independent of the order of input as long as the comparator is commutative. The default comparator > is commutative only when types do not differ.

      If comparator returns 0 and either value is NaN, undefined, or null, that value will be returned.

      Parameters

      • Optionalcomparator: Comparator<V>

      Returns V | undefined

    • Like max, but also accepts a comparatorValueMapper which allows for comparing by more sophisticated means:

      Type Parameters

      • C

      Parameters

      • comparatorValueMapper: (value: V, key: K, iter: this) => C
      • Optionalcomparator: Comparator<C>

      Returns V | undefined

    • Returns the minimum value in this collection. If any values are comparatively equivalent, the first one found will be returned.

      The comparator is used in the same way as Collection#sort. If it is not provided, the default comparator is <.

      When two values are considered equivalent, the first encountered will be returned. Otherwise, min will operate independent of the order of input as long as the comparator is commutative. The default comparator < is commutative only when types do not differ.

      If comparator returns 0 and either value is NaN, undefined, or null, that value will be returned.

      Parameters

      • Optionalcomparator: Comparator<V>

      Returns V | undefined

    • Like min, but also accepts a comparatorValueMapper which allows for comparing by more sophisticated means:

      Type Parameters

      • C

      Parameters

      • comparatorValueMapper: (value: V, key: K, iter: this) => C
      • Optionalcomparator: Comparator<C>

      Returns V | undefined

    • Returns a new Seq with the values for which the predicate function returns false and another for which is returns true.

      Type Parameters

      • F
      • C

      Parameters

      • predicate: (this: C, value: V, key: K, iter: this) => value is F
      • Optionalcontext: C

      Returns [Seq<K, V>, Seq<K, F>]

    • Returns a new Collection with the values for which the predicate function returns false and another for which is returns true.

      Type Parameters

      • C

      Parameters

      • predicate: (this: C, value: V, key: K, iter: this) => unknown
      • Optionalcontext: C

      Returns [Seq<K, V>, Seq<K, V>]

    • Reduces the Collection to a value by calling the reducer for every entry in the Collection and passing along the reduced value.

      If initialReduction is not provided, the first item in the Collection will be used.

      Parameters

      • reducer: (reduction: V, value: V, key: K, iter: this) => V

      Returns V

      Array#reduce.

    • Type Parameters

      • R

      Parameters

      • reducer: (reduction: R, value: V, key: K, iter: this) => R
      • initialReduction: R
      • Optionalcontext: unknown

      Returns R

    • Type Parameters

      • R

      Parameters

      • reducer: (reduction: V | R, value: V, key: K, iter: this) => R

      Returns R

    • Reduces the Collection in reverse (from the right side).

      Note: Similar to this.reverse().reduce(), and provided for parity with Array#reduceRight.

      Parameters

      • reducer: (reduction: V, value: V, key: K, iter: this) => V

      Returns V

    • Type Parameters

      • R

      Parameters

      • reducer: (reduction: R, value: V, key: K, iter: this) => R
      • initialReduction: R
      • Optionalcontext: unknown

      Returns R

    • Type Parameters

      • R

      Parameters

      • reducer: (reduction: V | R, value: V, key: K, iter: this) => R

      Returns R

    • Returns a new Collection of the same type containing all entries except the first.

      Returns this

    • Returns a new Collection of the same type in reverse order.

      Returns this

    • Returns a new Collection of the same type which excludes the first amount entries from this Collection.

      Parameters

      • amount: number

      Returns this

    • Returns a new Collection of the same type which excludes the last amount entries from this Collection.

      Parameters

      • amount: number

      Returns this

    • Returns a new Collection of the same type which includes entries starting from when predicate first returns true.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns this

    • Returns a new Collection of the same type which includes entries starting from when predicate first returns false.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns this

    • Returns a new Collection of the same type representing a portion of this Collection from start up to but not including end.

      If begin is negative, it is offset from the end of the Collection. e.g. slice(-2) returns a Collection of the last two entries. If it is not provided the new Collection will begin at the beginning of this Collection.

      If end is negative, it is offset from the end of the Collection. e.g. slice(0, -1) returns a Collection of everything but the last entry. If it is not provided, the new Collection will continue through the end of this Collection.

      If the requested slice is equivalent to the current Collection, then it will return itself.

      Parameters

      • Optionalbegin: number
      • Optionalend: number

      Returns this

    • True if predicate returns true for any entry in the Collection.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns boolean

    • Returns a new Collection of the same type which includes the same entries, stably sorted by using a comparator.

      If a comparator is not provided, a default comparator uses < and >.

      comparator(valueA, valueB):

      • Returns 0 if the elements should not be swapped.
      • Returns -1 (or any negative number) if valueA comes before valueB
      • Returns 1 (or any positive number) if valueA comes after valueB
      • Alternatively, can return a value of the PairSorting enum type
      • Is pure, i.e. it must always return the same value for the same pair of values.

      When sorting collections which have no defined order, their ordered equivalents will be returned. e.g. map.sort() returns OrderedMap.

      Note: sort() Always returns a new instance, even if the original was already sorted.

      Note: This is always an eager operation.

      Parameters

      • Optionalcomparator: Comparator<V>

      Returns this

    • Like sort, but also accepts a comparatorValueMapper which allows for sorting by more sophisticated means:

      Note: sortBy() Always returns a new instance, even if the original was already sorted.

      Note: This is always an eager operation.

      Type Parameters

      • C

      Parameters

      • comparatorValueMapper: (value: V, key: K, iter: this) => C
      • Optionalcomparator: Comparator<C>

      Returns this

    • Returns a new Collection of the same type which includes the first amount entries from this Collection.

      Parameters

      • amount: number

      Returns this

    • Returns a new Collection of the same type which includes the last amount entries from this Collection.

      Parameters

      • amount: number

      Returns this

    • Returns a new Collection of the same type which includes entries from this Collection as long as the predicate returns false.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns this

    • Returns a new Collection of the same type which includes entries from this Collection as long as the predicate returns true.

      Parameters

      • predicate: (value: V, key: K, iter: this) => boolean
      • Optionalcontext: unknown

      Returns this

    • Shallowly converts this collection to an Array.

      Collection.Indexed, and Collection.Set produce an Array of values. Collection.Keyed produce an Array of [key, value] tuples.

      Returns V[] | [K, V][]

    • Deeply converts this Collection to equivalent native JavaScript Array or Object.

      Collection.Indexed, and Collection.Set become Array, while Collection.Keyed become Object, converting keys to Strings.

      Returns
          | DeepCopy<V>[]
          | {
              [key: string]: DeepCopy<V>;
              [key: number]: DeepCopy<V>;
              [key: symbol]: DeepCopy<V>;
          }

    • Shallowly converts this Collection to equivalent native JavaScript Array or Object.

      Collection.Indexed, and Collection.Set become Array, while Collection.Keyed become Object, converting keys to Strings.

      Returns V[] | { [key: string]: V; [key: number]: V; [key: symbol]: V }

    • Returns a Seq.Keyed from this Collection where indices are treated as keys.

      This is useful if you want to operate on an Collection.Indexed and preserve the [index, value] pairs.

      The returned Seq will have identical iteration order as this Collection.

      Returns Keyed<K, V>

    • Converts this Collection to a List, discarding keys.

      This is similar to List(collection), but provided to allow for chained expressions. However, when called on Map or other keyed collections, collection.toList() discards the keys and creates a list of only the values, whereas List(collection) creates a list of entry tuples.

      Returns List<V>

    • Converts this Collection to a Map, Throws if keys are not hashable.

      Note: This is equivalent to Map(this.toKeyedSeq()), but provided for convenience and to allow for chained expressions.

      Returns Map<K, V>

    • Shallowly converts this Collection to an Object.

      Converts keys to Strings.

      Returns { [key: string]: V }

    • Converts this Collection to a Map, maintaining the order of iteration.

      Note: This is equivalent to OrderedMap(this.toKeyedSeq()), but provided for convenience and to allow for chained expressions.

      Returns OrderedMap<K, V>

    • Converts this Collection to a Set, maintaining the order of iteration and discarding keys.

      Note: This is equivalent to OrderedSet(this.valueSeq()), but provided for convenience and to allow for chained expressions.

      Returns OrderedSet<V>

    • Converts this Collection to a Seq of the same kind (indexed, keyed, or set).

      Returns Seq<K, V>

    • Converts this Collection to a Set, discarding keys. Throws if values are not hashable.

      Note: This is equivalent to Set(this), but provided to allow for chained expressions.

      Returns Set<V>

    • Returns a Seq.Set of the values of this Collection, discarding keys.

      Returns Set<V>

    • Converts this Collection to a Stack, discarding keys. Throws if values are not hashable.

      Note: This is equivalent to Stack(this), but provided to allow for chained expressions.

      Returns Stack<V>

    • This can be very useful as a way to "chain" a normal function into a sequence of methods. RxJS calls this "let" and lodash calls it "thru".

      For example, to sum a Seq after mapping and filtering:

      Type Parameters

      • R

      Parameters

      • updater: (value: this) => R

      Returns R

    • An iterator of this Collection's values.

      Note: this will return an ES6 iterator which does not support Immutable.js sequence algorithms. Use valueSeq instead, if this is what you want.

      Returns IterableIterator<V>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods