Class Map<V>

constructor

• new Map<V>(entries?): mongoose.Types.Map<V>

• Type Parameters

  • V

  Parameters

  • Optional entries: readonly (readonly [string, V])[]

    Optional

  Returns mongoose.Types.Map<V>

• new Map<V>(iterable?): mongoose.Types.Map<V>

• Type Parameters

  • V

  Parameters

  • Optional iterable: Iterable<readonly [string, V]>

    Optional

  Returns mongoose.Types.Map<V>

Readonly [toStringTag]

Readonly size

Static Readonly [species]

[iterator]

• [iterator](): IterableIterator<[string, V]>

• Returns an iterable of entries in the map.

  Returns IterableIterator<[string, V]>

clear

• clear(): void

• Returns void

delete

• delete(key): boolean

• Parameters

  • key: string

  Returns boolean

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

entries

• entries(): IterableIterator<[string, V]>

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

  Returns IterableIterator<[string, V]>

forEach

• forEach(callbackfn, thisArg?): void

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

  Parameters

  • callbackfn: ((value, key, map) => void)

    • • (value, key, map): void

      • Parameters

        • value: V

        • key: string

        • map: Map<string, V>

        Returns void

  • Optional thisArg: any

    Optional

  Returns void

get

• get(key): V

• 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

  Returns V

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

has

• has(key): boolean

• Parameters

  • key: string

  Returns boolean

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

keys

• keys(): IterableIterator<string>

• Returns an iterable of keys in the map

  Returns IterableIterator<string>

set

• set(key, value): mongoose.Types.Map<V>

• 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 mongoose.Types.Map<V>

values

• values(): IterableIterator<V>

• Returns an iterable of values in the map

  Returns IterableIterator<V>