Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | 57x 21x 15x 13x 13x 13x 13x 13x 13x 2x 51x 51x 51x 9x 17x 10x 8x 6x 2x 8x 3x 3x 4x 3x 2x 2x 2x 8x 75x 15x 15x 7x 7x 7x 7x 60x 60x 60x 75x 26x 23x 23x 11x 11x 23x 5x 5x 5x 23x 23x 26x 3x 2x 2x 1x 1x 1x 2x 1x 1x 1x 1x 2x 2x 2x 4x 3x 3x 3x 3x 3x 10x 10x 10x 15x 15x 10x 23x 8x 10x 10x 10x 67x 67x 14x 14x 14x 67x 67x 92x 3x 3x 2x 92x 18x 51x | import { batchFlush, batchStart, type BatchTask, batchTasks } from "../batch";
import { context } from "../context";
import { type EventObject, on, type RemoveListener, send, size } from "../event";
import { type ReadableProvider, type OwnedWritable, type Readable } from "../interface";
import { writable } from "../readable";
import { strictEqual } from "../utils";
import { onDisposeValue, type OnDisposeValue } from "./utils";
export interface ReactiveMapChanged<K, V> {
readonly upsert: readonly [K, V][];
readonly delete: readonly K[];
}
interface OnChanged<K, V> extends BatchTask<EventObject<ReactiveMapChanged<K, V>>> {
readonly upsert_: Map<K, V>;
readonly delete_: Set<K>;
}
/**
* OwnedReactiveMap extends the standard Map interface with reactive capabilities.
*
* @category ReactiveMap
*/
export class OwnedReactiveMap<K, V> extends Map<K, V> implements ReadableProvider<ReadonlyReactiveMap<K, V>> {
/**
* A Readable that emits the Map itself whenever it changes.
*
* @group Readable
*/
public get $(): Readable<ReadonlyReactiveMap<K, V>> {
return (this._$ ??= writable(this, { equal: false }));
}
/**
* Subscribe to changes in the map.
*
* @group Events
* @param fn - The function to call when the map is changed.
* @returns A disposer function to unsubscribe from the event.
*
* @example
* ```ts
* import { reactiveMap } from "@embra/reactivity";
*
* const map = reactiveMap<number, string>();
* const disposer = map.onChanged((changed) => {
* console.log("Map changed:", changed);
* });
* ```
*/
public onChanged(fn: (changed: ReactiveMapChanged<K, V>) => void): RemoveListener {
return on(
(this._onChanged_ ??= {
delete_: new Set<K>(),
upsert_: new Map<K, V>(),
batchTask_: () => {
if (this._onChanged_ && size(this._onChanged_)) {
const { upsert_, delete_ } = this._onChanged_;
/** c8 ignore else -- @preserve */
if (upsert_.size > 0 || delete_.size > 0) {
const changedData = {
upsert: [...upsert_],
delete: [...delete_],
};
upsert_.clear();
delete_.clear();
send(this._onChanged_, changedData);
}
} else {
this._onChanged_ = null;
}
},
}),
fn,
);
}
/**
* Subscribe to events when a value is needed to be disposed.
*
* A value is considered for disposal when:
* - it is deleted from the map.
* - it is replaced by another value (the old value is removed).
* - it is cleared from the map.
* - the map is disposed.
*
* Note that for performance reasons, it does not handle the case where multiple keys map to the same value.
*
* @function
* @group Events
* @param fn - The function to call when a value is needed to be disposed.
* @returns A disposer function to unsubscribe from the event.
*
* @example
* ```ts
* import { reactiveMap } from "@embra/reactivity";
*
* const map = reactiveMap<number, string>();
* const disposer = map.onDisposeValue((value) => {
* console.log("Value disposed:", value);
* });
* ```
*/
public readonly onDisposeValue = onDisposeValue;
public constructor(entries?: Iterable<readonly [K, V]> | null) {
super();
if (entries) {
for (const [key, value] of entries) {
super.set(key, value);
}
}
}
public dispose(): void {
if (this._disposed_) return;
if (process.env.NODE_ENV !== "production") {
this._disposed_ = new Error("[embra] ReactiveMap disposed at:");
} else {
this._disposed_ = true;
}
if (this.onDisposeValue_) {
const { delete_ } = this.onDisposeValue_;
for (const value of this.values()) {
delete_.add(value);
}
if (delete_.size) {
const isBatchTop = batchStart();
batchTasks.add(this.onDisposeValue_);
isBatchTop && batchFlush();
}
}
this._$ = this._onChanged_ = this.onDisposeValue_ = null;
}
public override set(key: K, value: V): this {
if (this.has(key)) {
const oldValue = this.get(key)!;
if (!strictEqual(oldValue, value)) {
const isBatchTop = batchStart();
// task added in this._upsert_
this.onDisposeValue_?.delete_.add(oldValue);
this._upsert_(key, value);
isBatchTop && batchFlush();
}
} else {
const isBatchTop = batchStart();
this._upsert_(key, value);
isBatchTop && batchFlush();
}
return this;
}
public override delete(key: K): boolean {
if (this.has(key)) {
const isBatchTop = batchStart();
if (this.onDisposeValue_) {
this.onDisposeValue_.delete_.add(this.get(key)!);
batchTasks.add(this.onDisposeValue_);
}
if (this._onChanged_) {
this._onChanged_.delete_.add(key);
this._onChanged_.upsert_.delete(key);
batchTasks.add(this._onChanged_);
}
this._notify_();
isBatchTop && batchFlush();
}
return super.delete(key);
}
public override clear(): void {
if (this.size) {
const isBatchTop = batchStart();
if (this.onDisposeValue_) {
for (const value of this.values()) {
this.onDisposeValue_.delete_.add(value);
batchTasks.add(this.onDisposeValue_);
}
}
if (this._onChanged_) {
for (const key of this.keys()) {
this._onChanged_.delete_.add(key);
this._onChanged_.upsert_.delete(key);
batchTasks.add(this._onChanged_);
}
}
super.clear();
this._notify_();
isBatchTop && batchFlush();
}
}
public rename(key: K, newKey: K): void {
if (this.has(key)) {
const isBatchTop = batchStart();
const value = this.get(key)!;
this.delete(key);
this.set(newKey, value);
isBatchTop && batchFlush();
}
}
/**
* Replace the contents of the map with the given entries.
* @param entries - The new entries to replace the map with.
* @returns The map itself.
*/
public replace(entries: Iterable<readonly [K, V]>): this {
const isBatchTop = batchStart();
const newKeys: Set<K> = (context.replaceMarkers_ ??= new Set());
for (const [key, value] of entries) {
newKeys.add(key);
this.set(key, value);
}
for (const key of this.keys()) {
if (!newKeys.has(key)) {
this.delete(key);
}
}
newKeys.clear();
isBatchTop && batchFlush();
return this;
}
/** @internal */
private _disposed_?: Error | true;
/** @internal */
private _$?: OwnedWritable<this> | null;
/** @internal */
private _onChanged_?: null | OnChanged<K, V>;
/** @internal */
public onDisposeValue_?: null | OnDisposeValue<V>;
/** @internal */
private _upsert_(key: K, value: V): void {
this.onDisposeValue_?.delete_.delete(value);
if (this._onChanged_) {
this._onChanged_.upsert_.set(key, value);
this._onChanged_.delete_.delete(key);
batchTasks.add(this._onChanged_);
}
super.set(key, value);
this._notify_();
}
/** @internal */
private _notify_() {
if (this._disposed_) {
console.error(this, new Error("disposed"));
if (process.env.NODE_ENV !== "production") {
console.error(this._disposed_);
}
}
this._$?.set(this);
}
}
/**
* ReactiveMap is {@link OwnedReactiveMap} without the `dispose` method.
*
* @category ReactiveMap
*/
export type ReactiveMap<K, V> = Omit<OwnedReactiveMap<K, V>, "dispose">;
/**
* ReadonlyReactiveMap is a readonly interface for {@link ReactiveMap}.
*
* @category ReactiveMap
*/
export interface ReadonlyReactiveMap<K, V> extends ReadonlyMap<K, V> {
/**
* A Readable that emits the Map itself whenever it changes.
*
* @group Readable
*/
readonly $: Readable<ReadonlyMap<K, V>>;
/**
* Subscribe to changes in the map.
*
* @group Events
* @param fn - The function to call when the map is changed.
* @returns A disposer function to unsubscribe from the event.
*
* @example
* ```ts
* import { reactiveMap } from "@embra/reactivity";
*
* const map = reactiveMap<number, string>();
* const disposer = map.onChanged((changed) => {
* console.log("Map changed:", changed);
* });
* ```
*/
onChanged(fn: (changed: ReactiveMapChanged<K, V>) => void): RemoveListener;
/**
* Subscribe to events when a value is needed to be disposed.
*
* A value is considered for disposal when:
* - it is deleted from the map.
* - it is replaced by another value (the old value is removed).
* - it is cleared from the map.
* - the map is disposed.
*
* Note that for performance reasons, it does not handle the case where multiple keys map to the same value.
*
* @function
* @group Events
* @param fn - The function to call when a value is needed to be disposed.
* @returns A disposer function to unsubscribe from the event.
*
* @example
* ```ts
* import { reactiveMap } from "@embra/reactivity";
*
* const map = reactiveMap<number, string>();
* const disposer = map.onDisposeValue((value) => {
* console.log("Value disposed:", value);
* });
* ```
*/
readonly onDisposeValue: (fn: (value: V) => void) => RemoveListener;
}
/**
* Creates a new {@link OwnedReactiveMap}.
*
* @category ReactiveMap
* @param entries - Initial entries for the reactive map.
* @returns A new instance of {@link OwnedReactiveMap}.
*
* @example
* ```ts
* import { reactiveMap } from "@embra/reactivity";
*
* const map$ = reactiveMap([["key", "value"]]);
* ```
*/
export const reactiveMap = <K, V>(entries?: Iterable<readonly [K, V]> | null): OwnedReactiveMap<K, V> =>
new OwnedReactiveMap(entries);
|