Skip to main content

namespace OrderedMap

A type-invariant immutable Ordered Map of key type K, and value type V. In the Map, each key has exactly one value, and the Map cannot contain duplicate keys. See the Map documentation and the OrderedMap API documentation

Companion interface: OrderedMap<K,V>

Interfaces

NameDescription
OrderedMap.Builder<K,V>A mutable OrderedMap builder used to efficiently create new immutable instances. See the Map documentation and the OrderedMap.Builder API documentation
OrderedMap.Context<UK>A context instance for an OrderedMap that acts as a factory for every instance of this type of collection.
OrderedMap.NonEmpty<K,V>A non-empty type-invariant immutable Ordered Map of key type K, and value type V. In the Map, each key has exactly one value, and the Map cannot contain duplicate keys. See the Map documentation and the OrderedMap API documentation
OrderedMap.TypesUtility interface that provides higher-kinded types for this collection.

Static Methods

createContext

Returns a new OrderedMap context instance based on the given options.

Definition

createContext<UK>(options: {
    listContext?: List.Context;
    mapContext: RMap.Context<UK>;
  }): OrderedMap.Context<UK>;

Type parameters

NameDescription
UKthe upper key type for which the context can create instances

Parameters

NameTypeDescription
options{
    listContext?: List.Context;
    mapContext: RMap.Context<UK>;
  }
an object containing the following properties:
- listContext - the list context to use for key ordering
- mapContext - the map context to use for key value mapping