<K1 extends K, K>(key: K1, hash: number): <V>(
self: HashMap<K, V>
) => boolean
<K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanChecks whether the specified key has an entry in the HashMap using a custom
hash.
Example (Checking keys with a hash)
import { Hash, HashMap } from "effect"
// Create a map with case-sensitive keys
const userMap = HashMap.make(
["Admin", { role: "administrator" }],
["User", { role: "standard" }]
)
// Check with exact hash
const exactHash = Hash.string("Admin")
console.log(HashMap.hasHash(userMap, "Admin", exactHash)) // true
// A matching hash does not override key equality
console.log(HashMap.hasHash(userMap, "admin", exactHash)) // false
// A different hash also cannot find the existing key
const lowercaseHash = Hash.string("admin")
console.log(HashMap.hasHash(userMap, "Admin", lowercaseHash)) // falseexport const const hasHash: {
<K1 extends K, K>(key: K1, hash: number): <V>(
self: HashMap<K, V>
) => boolean
<K1 extends K, K, V>(
self: HashMap<K, V>,
key: K1,
hash: number
): boolean
}
Checks whether the specified key has an entry in the HashMap using a custom
hash.
Example (Checking keys with a hash)
import { Hash, HashMap } from "effect"
// Create a map with case-sensitive keys
const userMap = HashMap.make(
["Admin", { role: "administrator" }],
["User", { role: "standard" }]
)
// Check with exact hash
const exactHash = Hash.string("Admin")
console.log(HashMap.hasHash(userMap, "Admin", exactHash)) // true
// A matching hash does not override key equality
console.log(HashMap.hasHash(userMap, "admin", exactHash)) // false
// A different hash also cannot find the existing key
const lowercaseHash = Hash.string("admin")
console.log(HashMap.hasHash(userMap, "Admin", lowercaseHash)) // false
hasHash: {
<function (type parameter) K1 in <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => booleanK1 extends function (type parameter) K in <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => booleanK, function (type parameter) K in <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => booleanK>(key: K1 extends Kkey: function (type parameter) K1 in <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => booleanK1, hash: numberhash: number): <function (type parameter) V in <V>(self: HashMap<K, V>): booleanV>(self: HashMap<K, V>(parameter) self: {
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
self: 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) K in <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => booleanK, function (type parameter) V in <V>(self: HashMap<K, V>): booleanV>) => boolean
<function (type parameter) K1 in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanK1 extends function (type parameter) K in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanK, function (type parameter) K in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanK, function (type parameter) V in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanV>(self: HashMap<K, V>(parameter) self: {
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
self: 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) K in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanK, function (type parameter) V in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanV>, key: K1 extends Kkey: function (type parameter) K1 in <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): booleanK1, hash: numberhash: number): boolean
} = import internalinternal.const hasHash: anyhasHash