<V>(self: Trie<V>): IterableIterator<string>Returns an IterableIterator of the keys within the Trie.
Details
The keys are returned in alphabetical order, regardless of insertion order.
Example (Reading keys in alphabetical order)
import { Trie } from "effect"
import * as assert from "node:assert"
const trie = Trie.empty<number>().pipe(
Trie.insert("cab", 0),
Trie.insert("abc", 1),
Trie.insert("bca", 2)
)
const result = Array.from(Trie.keys(trie))
assert.deepStrictEqual(result, ["abc", "bca", "cab"])getters
Source effect/Trie.ts:2081 lines
export const const keys: <V>(
self: Trie<V>
) => IterableIterator<string>
Returns an IterableIterator of the keys within the Trie.
Details
The keys are returned in alphabetical order, regardless of insertion order.
Example (Reading keys in alphabetical order)
import { Trie } from "effect"
import * as assert from "node:assert"
const trie = Trie.empty<number>().pipe(
Trie.insert("cab", 0),
Trie.insert("abc", 1),
Trie.insert("bca", 2)
)
const result = Array.from(Trie.keys(trie))
assert.deepStrictEqual(result, ["abc", "bca", "cab"])
keys: <function (type parameter) V in <V>(self: Trie<V>): IterableIterator<string>V>(self: Trie<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;
}
interface Trie<in out Value>An immutable string-keyed map optimized for prefix lookup. Iteration yields
[key, value] pairs in key order, and update operations such as insert and
remove return new Trie values.
Example (Using a trie for prefix search)
import { Trie } from "effect"
// Create a trie with string-to-number mappings
const trie: Trie.Trie<number> = Trie.make(
["apple", 1],
["app", 2],
["application", 3],
["banana", 4]
)
// Get values by exact key
console.log(Trie.get(trie, "apple")) // Some(1)
console.log(Trie.get(trie, "grape")) // None
// Find all keys with a prefix
console.log(Array.from(Trie.keysWithPrefix(trie, "app")))
// ["app", "apple", "application"]
// Iterate over all entries (sorted alphabetically)
for (const [key, value] of trie) {
console.log(`${key}: ${value}`)
}
// Output: "app: 2", "apple: 1", "application: 3", "banana: 4"
// Check if key exists
console.log(Trie.has(trie, "app")) // true
// Get size
console.log(Trie.size(trie)) // 4
Trie<function (type parameter) V in <V>(self: Trie<V>): IterableIterator<string>V>) => interface IterableIterator<T, TReturn = any, TNext = any>Describes a user-defined
Iterator
that is also iterable.
IterableIterator<string> = import TRTR.const keys: <V>(
self: TR.Trie<V>
) => IterableIterator<string>