Interface ReadonlyCharMap<T>

Readonly entryCount

Readonly isEmpty

Readonly size

copy

• copy(): CharMap<T>

• Returns a new map with all values mapped by the given function.

  If no function is given, the identity function is used.

  Returns CharMap<T>
• copy<U>(mapFn: ((value: T) => U)): CharMap<U>

• Type Parameters

  • U

  Parameters

  • mapFn: ((value: T) => U)

    • • (value: T): U

      • Parameters

        • value: T

        Returns U

  Returns CharMap<U>

entries

• entries(): Iterable<[CharRange, T]>

• Returns all key-value pairs in the map.

  Entries will be returned in the order of ascending ranges.

  Returns Iterable<[CharRange, T]>

forEach

• forEach(callback: ((value: T, chars: CharRange, map: ReadonlyCharMap<T>) => void)): void

• Invokes the given callback for every item of the character map.

  This method is implemented more efficiently than other iterator based methods, so chose forEach where every possible.

  Parameters

  • callback: ((value: T, chars: CharRange, map: ReadonlyCharMap<T>) => void)

    • • (value: T, chars: CharRange, map: ReadonlyCharMap<T>): void

      • Parameters

        • value: T

        • chars: CharRange

        • map: ReadonlyCharMap<T>

        Returns void

  Returns void

get

• get(char: Char): undefined | T

• Returns the value associated with the given character of undefined if the character is not key in the map.

  Parameters

  • char: Char

  Returns undefined | T

has

• has(char: Char): boolean

• Returns whether the given character is a key in the map.

  Parameters

  • char: Char

  Returns boolean

hasEvery

• hasEvery(chars: CharRange): boolean

• Returns whether every character in the given range is a key in the map.

  This is equivalent to: [...chars].every(char => this.has(char)).

  Parameters

  • chars: CharRange

  Returns boolean

hasSome

• hasSome(chars: CharRange): boolean

• Returns whether some character in the given range is a key in the map.

  This is equivalent to: [...chars].some(char => this.has(char)).

  Parameters

  • chars: CharRange

  Returns boolean

invert

• invert(maxCharacter: Char): Map<T, CharSet>

• Returns a mapping from the values of this map to its keys.

  Parameters

  • maxCharacter: Char

  Returns Map<T, CharSet>

keys

• keys(): Iterable<CharRange>

• Returns all ranges of characters that are keys in the map.

  Keys will be returned in the same order as this.entries().

  Returns Iterable<CharRange>

values

• values(): Iterable<T>

• Returns all values in the map. Values might not be unique if more than one range maps to the same value.

  Values will be returned in the same order as this.entries().

  Returns Iterable<T>