Class XWeakMap<K, V>

XWeakMap is like WeakMap, except that it supports automatically creating missing entries with with sGet according to a default value getter function.

Type Parameters

  • K extends WeakKey

    The type of the keys the map holds.

  • V

    The type of the values the map holds.

Hierarchy (View Summary)

Constructors

constructor

Properties

newXWeakMapGetter delete get has prune set sGet

Constructors

constructor

Properties

Static ReadonlynewXWeakMapGetter

newXWeakMapGetter: {} = newXWeakMapGetter

Returns a function that when called returns a new XWeakMap.

You can pass this to the constructor of an XMap or an XWeakMap, whose values are XWeakMaps.

Readonlydelete

delete: (key: K) => void

Deletes a value at the given key in the XMap or XWeakMap.

Readonlyget

get: (key: K) => undefined | V

Returns the value at the given key in the XMap or XWeakMap.

Readonlyhas

has: (key: K) => boolean

Returns true if the XMap or XWeakMap contains the given key.

Readonlyprune

prune: (sk: K, ...rest: unknown[]) => void

Deletes empty keys in the XMap or XWeakMap starting at the final nested path and checking the level above after deletion.

A key is considered empty if it's value is undefined or it's an empty Map, Set, Array, etc (anything with size or length property equal to 0).

Readonlyset

set: (key: K, value: V) => void

Sets a value at the given key in the XMap or XWeakMap.

ReadonlysGet

sGet: (key: K) => V

Like get except that if the key is not found in the map, then it will set and return a default value by calling getDefaultV passed to the constructor.

Settings

Member Visibility

On This Page

Constructors
Properties