Circle V2 API Docs
    Preparing search index...

    A Map<string, V> whose keys are trimmed on every access, so a lookup by a raw (possibly untrimmed or nullish) key still hits a value stored under its trimmed form, and stray whitespace can't create distinct entries for what is really the same key. keys/values/size/iteration are inherited from Map and operate on the (already trimmed) stored keys.

    Type Parameters

    • V

    Hierarchy

    • Map<string, V>
      • TrimmedKeyMap
    Index

    Constructors

    • Type Parameters

      • V

      Parameters

      • Optionalentries: readonly (readonly [string, V])[] | null

      Returns TrimmedKeyMap<V>

    • Type Parameters

      • V

      Parameters

      • Optionaliterable: Iterable<readonly [string, V], any, any> | null

      Returns TrimmedKeyMap<V>

    Properties

    "[toStringTag]": string
    size: number

    the number of elements in the Map.

    "[species]": MapConstructor

    Methods

    • Returns an iterable of entries in the map.

      Returns MapIterator<[string, V]>

    • Returns void

    • Parameters

      • key: string | null | undefined

      Returns boolean

      true if an element in the Map existed and has been removed, or false if the element does not exist.

    • Returns an iterable of key, value pairs for every entry in the map.

      Returns MapIterator<[string, V]>

    • Executes a provided function once per each key/value pair in the Map, in insertion order.

      Parameters

      • callbackfn: (value: V, key: string, map: Map<string, V>) => void
      • OptionalthisArg: any

      Returns void

    • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

      Parameters

      • key: string | null | undefined

      Returns V | undefined

      Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

    • Parameters

      • key: string | null | undefined

      Returns boolean

      boolean indicating whether an element with the specified key exists or not.

    • Returns an iterable of keys in the map

      Returns MapIterator<string>

    • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

      Parameters

      • key: string
      • value: V

      Returns this

    • Returns an iterable of values in the map

      Returns MapIterator<V>