Class AtomMap

packages/store/src/lib/AtomMap.ts:9–416

 * @public
 */
export class AtomMap<K, V> implements Map<K, V> {
	private atoms: Atom<ImmutableMap<K, Atom<V | UNINITIALIZED>>>

	/**
	 * Creates a new AtomMap instance.
	 *
	 * name - A unique name for this map, used for atom identification
	 * entries - Optional initial entries to populate the map with
	 * @example
	 * ```ts
	 * // Create an empty map
	 * const map = new AtomMap('userMap')
	 *
	 * // Create a map with initial data
	 * const initialData: [string, number][] = [['a', 1], ['b', 2]]
	 * const mapWithData = new AtomMap('numbersMap', initialData)
	 * ```
	 */
	constructor(
		private readonly name: string,
		entries?: Iterable<readonly [K, V]>
	) {
		let atoms = emptyMap<K, Atom<V>>()
		if (entries) {
			atoms = atoms.withMutations((atoms) => {
				for (const [k, v] of entries) {
					atoms.set(k, atom(`${name}:${String(k)}`, v))
				}
			})
		}
		this.atoms = atom(`${name}:atoms`, atoms)
	}

	/**
	 * Retrieves the underlying atom for a given key.
	 *
	 * @param key - The key to retrieve the atom for
	 * @returns The atom containing the value, or undefined if the key doesn't exist
	 * @internal
	 */
	getAtom(key: K): Atom<V | UNINITIALIZED> | undefined {
		const valueAtom = this.atoms.__unsafe__getWithoutCapture().get(key)
		if (!valueAtom) {
			// if the value is missing, we want to track whether it's in the present keys set
			this.atoms.get()
			return undefined
		}
		return valueAtom
	}

	/**
	 * Gets the value associated with a key. Returns undefined if the key doesn't exist.
	 * This method is reactive and will cause reactive contexts to update when the value changes.
	 *
	 * @param key - The key to retrieve the value for
	 * @returns The value associated with the key, or undefined if not found
	 * @example
	 * ```ts