Interface ChildSet

Hierarchy

Properties

forEach map size values

Methods

asMutable first has toArray

Properties

Readonly forEach

forEach: ((sideEffect: ((value: string, key: string, iter: <internal>.OrderedSet<string>) => unknown), context?: unknown) => number)

Type declaration

    • (sideEffect: ((value: string, key: string, iter: <internal>.OrderedSet<string>) => unknown), context?: unknown): number

    • 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

      Returns number

Readonly map

map: (<M>(mapper: ((value: string, key: string, iter: <internal>.OrderedSet<string>) => M), context?: unknown) => <internal>.OrderedSet<M>)

Type declaration

Readonly size

size: number

Readonly values

values: (() => IterableIterator<string>)

Type declaration

    • (): IterableIterator<string>

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

Methods

asMutable

first

  • Returns string

has

  • Parameters

    • ref: string

    Returns boolean

toArray

  • Returns string[]

Settings

Member Visibility

Theme

Generated using TypeDoc