Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ChildSet

Index

Properties

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

Type declaration

    • (sideEffect: (value?: string, key?: string, iter?: <internal>.Iterable<string, string>) => any, context?: any): number
    • The sideEffect is executed for every entry in the Iterable.

      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?: string, key?: string, iter?: <internal>.Iterable<string, string>) => any
          • Parameters

            • Optional value: string
            • Optional key: string
            • Optional iter: <internal>.Iterable<string, string>

            Returns any

      • Optional context: any

      Returns number

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

Type declaration

    • Returns a new Iterable of the same type with values passed through a mapper function.

      Seq({ a: 1, b: 2 }).map(x => 10 * x)
      // Seq { a: 10, b: 20 }

      Type parameters

      • M

      Parameters

      • mapper: (value?: string, key?: string, iter?: <internal>.Iterable<string, string>) => M
          • Parameters

            • Optional value: string
            • Optional key: string
            • Optional iter: <internal>.Iterable<string, string>

            Returns M

      • Optional context: any

      Returns <internal>.Iterable<string, M>

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

Type declaration

    • (): Iterator<string>
    • An iterator of this Iterable'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 Iterator<string>

Methods

  • first(): string
  • Returns string

  • has(ref: string): boolean
  • Parameters

    • ref: string

    Returns boolean

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

Generated using TypeDoc