Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

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

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

Type declaration

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

Type declaration

    • 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

  • Returns MutableChildSet

  • first(): string
  • Returns string

  • has(ref: string): boolean
  • Parameters

    • ref: string

    Returns boolean

  • toArray(): string[]
  • Returns string[]

Generated using TypeDoc