@oazmi/kitchensink - v0.10.1
    Preparing search index...

    Interface InvertibleMapBase<K, V>

    an interface that's implemented by InvertibleMap.

    interface InvertibleMapBase<K, V> {
        rentries: () => MapIterator<[V, Set<K>]>;
        rkeys: () => MapIterator<V>;
        rvalues: () => MapIterator<Set<K>>;
        rforEach: (
            callbackfn: (value: Set, key: V, map: Map<V, Set<K>>) => void,
            thisArg?: any,
        ) => void;
        rdelete: (key: V) => boolean;
        rhas: (key: V) => boolean;
        rget: (key: V) => Set<K> | undefined;
        rsize: number;
        rset(key: V, value: Iterable<K>): InvertibleMapBase<K, V>;
        clear(): void;
        delete(key: K): boolean;
        forEach(
            callbackfn: (value: Set, key: K, map: Map<K, Set<V>>) => void,
            thisArg?: any,
        ): void;
        get(key: K): Set<V> | undefined;
        has(key: K): boolean;
        set(key: K, value: Set): this;
        size: number;
        "[iterator]"(): MapIterator<[K, Set<V>]>;
        entries(): MapIterator<[K, Set<V>]>;
        keys(): MapIterator<K>;
        values(): MapIterator<Set<V>>;
        "[toStringTag]": string;
    }

    Type Parameters

    • K
    • V

    Hierarchy

    • Map<K, Set<V>>
    • Omit<PrefixProps<Map<V, Set<K>>, "r">, "rclear" | "rset">
      • InvertibleMapBase

    Implemented by

    Index

    Properties

    rentries rkeys rvalues rforEach rdelete rhas rget rsize size [toStringTag]

    Methods

    rset clear delete forEach get has set [iterator] entries keys values

    Properties

    rentries: () => MapIterator<[V, Set<K>]>

    Type Declaration

      • (): MapIterator<[V, Set<K>]>

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

        Returns MapIterator<[V, Set<K>]>

    rkeys: () => MapIterator<V>

    Type Declaration

      • (): MapIterator<V>

      • Returns an iterable of keys in the map

        Returns MapIterator<V>

    rvalues: () => MapIterator<Set<K>>

    Type Declaration

      • (): MapIterator<Set<K>>

      • Returns an iterable of values in the map

        Returns MapIterator<Set<K>>

    rforEach: (
        callbackfn: (value: Set, key: V, map: Map<V, Set<K>>) => void,
        thisArg?: any,
    ) => void

    Type Declaration

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

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

        Parameters

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

        Returns void

    rdelete: (key: V) => boolean

    Type Declaration

      • (key: V): boolean

      • Parameters

        • key: V

        Returns boolean

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

    rhas: (key: V) => boolean

    Type Declaration

      • (key: V): boolean

      • Parameters

        • key: V

        Returns boolean

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

    rget: (key: V) => Set<K> | undefined

    Type Declaration

      • (key: V): Set<K> | undefined

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

        Returns Set<K> | undefined

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

    rsize: number
    size: number

    the number of elements in the Map.

    "[toStringTag]": string

    Methods

    • Returns void

    • 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.

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

      Parameters

      • callbackfn: (value: Set, key: K, map: Map<K, Set<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 Set<V> | undefined

      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.

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

      Returns this

    • Returns an iterable of entries in the map.

      Returns MapIterator<[K, Set<V>]>

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

      Returns MapIterator<[K, Set<V>]>

    • Returns an iterable of keys in the map

      Returns MapIterator<K>

    • Returns an iterable of values in the map

      Returns MapIterator<Set<V>>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods