UNPKG

@clarketm/supertrie

Version:

Trie with superpowers! 💪

github.com/clarketm/super/tree/master/packages/supertrie

133 lines (79 loc) • 3.31 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# [Trie](https://www.npmjs.com/package/@clarketm/supertrie) [![NPM release](https://img.shields.io/npm/v/@clarketm/supertrie.svg)](https://www.npmjs.com/package/@clarketm/supertrie) Trie with superpowers! 💪 ## Individual Module Installation ### Yarn ```bash $ yarn add @clarketm/supertrie ``` ### Npm ```bash $ npm install @clarketm/supertrie --save ``` ## API ### `constructor(iterable: Iterable<string>)` Construct a Trie ### `root: TrieNode` Get the root of the trie ### `insert(word: string)` Insert a string into the trie | Name | Type | Attribute | Description | | ---- | ------ | --------- | ---------------- | | word | string | | string to insert | ### `remove(word: string)` Remove a string from the trie | Name | Type | Attribute | Description | | ---- | ------ | --------- | ---------------- | | word | string | | string to remove | ### `search(query: string): Match` Search for a node in the trie matching the query | Name | Type | Attribute | Description | | ----- | ------ | --------- | -------------------------- | | query | string | | string query to search for | ### `includes(word: string): boolean` Check if the trie includes a word | Name | Type | Attribute | Description | | ---- | ------ | --------- | ----------------------- | | word | string | | full word to search for | ### `contains(word: string): boolean` > Alias to `includes(word)` Check if the trie contains a word | Name | Type | Attribute | Description | | ---- | ------ | --------- | ----------------------- | | word | string | | full word to search for | ### `startsWith(prefix: string): boolean` Check if the trie contains a prefix | Name | Type | Attribute | Description | | ------ | ------ | --------- | ---------------------------------------- | | prefix | string | | prefix (i.e. partial word) to search for | ## `TrieNode` TrieNode ### `constructor(char: character)` Construct a TrieNode ### `count: number` Get children count of the node ### `char: character` Get character value of node ### `isCompleteWord: boolean` Checks if node is a complete word ### `has(char: character): boolean` Check if node has a specific character as a child | Name | Type | Attribute | Description | | ---- | --------- | ------------------ | ----------- | | char | character | character to check | ### `get(char: character): TrieNode` Get child node with specific character value | Name | Type | Attribute | Description | | ---- | --------- | --------- | ---------------- | | char | character | | character to get | ### `set(char: character, node: TrieNode)` Set child node with specific character value | Name | Type | Attribute | Description | | ---- | --------- | --------- | --------------------------- | | char | character | | character to set | | node | TrieNode | | node to assign to character | ### `delete(char: character)` Delete child node with specific character value | Name | Type | Attribute | Description | | ---- | --------- | --------- | ------------------- | | char | character | | character to delete |