<K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>
(u: unknown): u is HashMap<unknown, unknown>Checks whether a value is a HashMap.
Example (Checking HashMap values)
import { HashMap } from "effect"
const map = HashMap.make(["a", 1], ["b", 2])
const notMap = { a: 1 }
console.log(HashMap.isHashMap(map)) // true
console.log(HashMap.isHashMap(notMap)) // false
console.log(HashMap.isHashMap(null)) // falserefinements
Source effect/HashMap.ts:2254 lines
export const const isHashMap: {
<K, V>(
u: Iterable<readonly [K, V]>
): u is HashMap<K, V>
(u: unknown): u is HashMap<unknown, unknown>
}
Checks whether a value is a HashMap.
Example (Checking HashMap values)
import { HashMap } from "effect"
const map = HashMap.make(["a", 1], ["b", 2])
const notMap = { a: 1 }
console.log(HashMap.isHashMap(map)) // true
console.log(HashMap.isHashMap(notMap)) // false
console.log(HashMap.isHashMap(null)) // false
isHashMap: {
<function (type parameter) K in <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>K, function (type parameter) V in <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>V>(u: Iterable<readonly [K, V]>u: interface Iterable<T, TReturn = any, TNext = any>Iterable<readonly [function (type parameter) K in <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>K, function (type parameter) V in <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>V]>): u: Iterable<readonly [K, V]>u is 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 <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>K, function (type parameter) V in <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>V>
(u: unknownu: unknown): u: unknownu is 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<unknown, unknown>
} = import internalinternal.const isHashMap: {
<K, V>(
u: Iterable<readonly [K, V]>
): u is internal.HashMap<K, V>
(u: unknown): u is internal.HashMap<
unknown,
unknown
>
}
Referenced by 1 symbols