@rimbu/bimultimap/src/custom/interface/generic.mts

A bidirectional immutable MultiMap of keys and values for TypeScript

import type { BiMultiMap } from '@rimbu/bimultimap';

import type { MultiMap } from '@rimbu/multimap';

export namespace BiMultiMapGeneric {
  export interface Creators {
    /**
     * Returns a new BiMultiMap context instance based on the given `options`.
     * @typeparam UK - the upper key type for which the context can create instances
     * @typeparam UV - the upper value type for which the context can create instances
     * @param options - an object containing the following properties:<br/>
     * - keyValueMultiMapContext: the map context to use for key value multimaps<br/>
     * - valueKeyMultiMapContext: the set context to use for value key multimaps
     */
    createContext<UK, UV>(options: {
      keyValueMultiMapContext: MultiMap.Context<UK, UV>;
      valueKeyMultiMapContext: MultiMap.Context<UV, UK>;
    }): BiMultiMap.Context<UK, UV>;
  }
}