AtomMap • tldraw Docs

Table of contents

A drop-in replacement for Map that stores values in atoms and can be used in reactive contexts.

class AtomMap<K, V> implements Map<K, V> {}

Constructs a new instance of the AtomMap class

Name	Description
`name`	`string`
`entries`	`Iterable<[K, V]>`

Properties

[Symbol.toStringTag]: string

readonly

get size(): number

[Symbol.iterator](): Generator<[K, V], undefined, unknown>

clear(): void

delete(key: K): boolean

Name	Description
`key`	`K`

boolean

deleteMany(keys: Iterable<K>): [K, V][]

Name	Description
`keys`	`Iterable<K>`

[K, V][]

entries(): Generator<[K, V], undefined, unknown>

forEach(
  callbackfn: (value: V, key: K, map: AtomMap<K, V>) => void,
  thisArg?: any
): void

Name	Description
`callbackfn`	`( value: V, key: K, map: AtomMap<K, V> ) => void`
`thisArg`	`any`

void

get(key: K): undefined | V

Name	Description
`key`	`K`

undefined | V

has(key: K): boolean

Name	Description
`key`	`K`

boolean

keys(): Generator<K, undefined, unknown>

set(key: K, value: V): this

Name	Description
`key`	`K`
`value`	`V`

this

update(key: K, updater: (value: V) => V): void

Name	Description
`key`	`K`
`updater`	`(value: V) => V`

void

values(): Generator<V, undefined, unknown>