<Entries extends ReadonlyArray<readonly [any, any]>>(
...entries: Entries
): HashMap<
Entries[number] extends readonly [infer K, any] ? K : never,
Entries[number] extends readonly [any, infer V] ? V : never
>Constructs a new HashMap from an array of key/value pairs.
Example (Creating a HashMap from entries)
import { HashMap } from "effect"
const map = HashMap.make(["a", 1], ["b", 2], ["c", 3])
console.log(HashMap.size(map)) // 3
console.log(HashMap.get(map, "b")) // Option.some(2)constructors
Source effect/HashMap.ts:2646 lines
export const const make: <
Entries extends ReadonlyArray<
readonly [any, any]
>
>(
...entries: Entries
) => HashMap<
Entries[number] extends readonly [infer K, any]
? K
: never,
Entries[number] extends readonly [any, infer V]
? V
: never
>
Constructs a new HashMap from an array of key/value pairs.
Example (Creating a HashMap from entries)
import { HashMap } from "effect"
const map = HashMap.make(["a", 1], ["b", 2], ["c", 3])
console.log(HashMap.size(map)) // 3
console.log(HashMap.get(map, "b")) // Option.some(2)
make: <function (type parameter) Entries in <Entries extends ReadonlyArray<readonly [any, any]>>(...entries: Entries): HashMap<Entries[number] extends readonly [infer K, any] ? K : never, Entries[number] extends readonly [any, infer V] ? V : never>Entries extends interface ReadonlyArray<T>ReadonlyArray<readonly [any, any]>>(
...entries: Entries extends ReadonlyArray<readonly [any, any]>entries: function (type parameter) Entries in <Entries extends ReadonlyArray<readonly [any, any]>>(...entries: Entries): HashMap<Entries[number] extends readonly [infer K, any] ? K : never, Entries[number] extends readonly [any, infer V] ? V : never>Entries
) => interface HashMap<out Key, out Value>A HashMap is an immutable key-value data structure that provides efficient lookup,
insertion, and deletion operations. It uses a Hash Array Mapped Trie (HAMT) internally
for structural sharing and optimal performance.
Example (Using basic HashMap operations)
import { HashMap } from "effect"
// Create a HashMap
const map = HashMap.make(["a", 1], ["b", 2], ["c", 3])
// Access values
const valueA = HashMap.get(map, "a") // Option.some(1)
const valueD = HashMap.get(map, "d") // Option.none()
// Check if key exists
console.log(HashMap.has(map, "b")) // true
// Add/update values (returns new HashMap)
const updated = HashMap.set(map, "d", 4)
console.log(HashMap.size(updated)) // 4
The HashMap namespace contains type-level utilities and helper types
for working with HashMap instances.
Example (Extracting HashMap types)
import { HashMap } from "effect"
// Create a concrete HashMap for type extraction
const inventory = HashMap.make(
["laptop", { quantity: 5, price: 999 }],
["mouse", { quantity: 20, price: 29 }]
)
// Extract types for reuse
type ProductId = HashMap.HashMap.Key<typeof inventory> // string
type Product = HashMap.HashMap.Value<typeof inventory> // { quantity: number, price: number }
type InventoryEntry = HashMap.HashMap.Entry<typeof inventory> // [string, Product]
// Use extracted types in functions
const updateInventory = (id: ProductId, product: Product) =>
HashMap.set(inventory, id, product)
const processEntry = ([id, product]: InventoryEntry) =>
`${id}: ${product.quantity} @ $${product.price}`
// Example of extracted types in action
const newProduct: Product = { quantity: 10, price: 199 }
const updatedInventory = updateInventory("tablet", newProduct)
HashMap<
function (type parameter) Entries in <Entries extends ReadonlyArray<readonly [any, any]>>(...entries: Entries): HashMap<Entries[number] extends readonly [infer K, any] ? K : never, Entries[number] extends readonly [any, infer V] ? V : never>Entries[number] extends readonly [infer function (type parameter) KK, any] ? function (type parameter) KK : never,
function (type parameter) Entries in <Entries extends ReadonlyArray<readonly [any, any]>>(...entries: Entries): HashMap<Entries[number] extends readonly [infer K, any] ? K : never, Entries[number] extends readonly [any, infer V] ? V : never>Entries[number] extends readonly [any, infer function (type parameter) VV] ? function (type parameter) VV : never
> = import internalinternal.const make: <
Entries extends ReadonlyArray<
readonly [any, any]
>
>(
...entries: Entries
) => internal.HashMap<
Entries[number] extends readonly [infer K, any]
? K
: never,
Entries[number] extends readonly [any, infer V]
? V
: never
>
Referenced by 1 symbols