Skip to main content
Module

x/rimbu/mod.ts>HashMap.NonEmpty

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.
rimbu-org/rimbu
Go to Latest
interface HashMap.NonEmpty
implements [RMapBase.NonEmpty]<K, V, HashMap.Types>, Omit<HashMap<K, V>, keyof RMapBase.NonEmpty<any, any, any>>, [Streamable.NonEmpty]<readonly [K, V]>
import { type HashMap } from "https://deno.land/x/rimbu@0.13.1/mod.ts";
const { NonEmpty } = HashMap;

A non-empty type-invariant immutable 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.

  • The HashMap uses the context's hasher instance to hash keys for performance.
  • The HashMap uses the context's eq function to determine equivalence between keys.

See the Map documentation and the HashMap API documentation

Examples

Example 1

const m1 = HashMap.empty<number, string>()
const m2 = HashMap.of([1, 'a'], [2, 'b'])

Methods

stream(): Stream.NonEmpty<readonly [K, V]>