@embra/reactivity - v0.0.3
    Preparing search index...

    Interface OwnedReactiveMap<K, V>

    interface OwnedReactiveMap<K, V> {
        "[toStringTag]": string;
        onDisposeValue: <V>(
            this: { onDisposeValue_?: null | OnDisposeValue<V> },
            fn: (value: V) => void,
        ) => RemoveListener;
        size: number;
        get $(): Readable<ReadonlyReactiveMap<K, V>>;
        "[iterator]"(): MapIterator<[K, V]>;
        clear(): void;
        delete(key: K): boolean;
        dispose(): void;
        entries(): MapIterator<[K, V]>;
        forEach(
            callbackfn: (value: V, key: K, map: Map<K, V>) => void,
            thisArg?: any,
        ): void;
        get(key: K): undefined | V;
        has(key: K): boolean;
        keys(): MapIterator<K>;
        onChanged(fn: (changed: ReactiveMapChanged<K, V>) => void): RemoveListener;
        rename(key: K, newKey: K): void;
        set(key: K, value: V): this;
        values(): MapIterator<V>;
    }

    Type Parameters

    • K
    • V

    Hierarchy

    • Map<K, V>
      • OwnedReactiveMap

    Implements

    Index

    Properties

    [toStringTag] onDisposeValue size

    Accessors

    $

    Methods

    [iterator] clear delete dispose entries forEach get has keys onChanged rename set values

    Properties
    "[toStringTag]": string
    onDisposeValue: <V>(
        this: { onDisposeValue_?: null | OnDisposeValue<V> },
        fn: (value: V) => void,
    ) => RemoveListener = onDisposeValue

    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.

    Type declaration

      • <V>(
            this: { onDisposeValue_?: null | OnDisposeValue<V> },
            fn: (value: V) => void,
        ): RemoveListener

      • Type Parameters

        • V

        Parameters

        • this: { onDisposeValue_?: null | OnDisposeValue<V> }
        • fn: (value: V) => void

          The function to call when a value is needed to be disposed.

        Returns RemoveListener

        A disposer function to unsubscribe from the event.

    size: number

    the number of elements in the Map.

    Accessors

    $

    Methods

    • Returns an iterable of entries in the map.

      Returns MapIterator<[K, V]>

    • Parameters

      • key: K

      Returns boolean

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

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

      Returns MapIterator<[K, V]>

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

      Parameters

      • callbackfn: (value: V, key: K, map: Map<K, V>) => void
      • OptionalthisArg: any

      Returns void

    • 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: K

      Returns undefined | V

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

    • Parameters

      • key: K

      Returns boolean

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

    • Returns an iterable of keys in the map

      Returns MapIterator<K>

    • 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: K
      • value: V

      Returns this

    • Returns an iterable of values in the map

      Returns MapIterator<V>

    Settings

    On This Page
    Properties
    Accessors
    Methods