-
Notifications
You must be signed in to change notification settings - Fork 126
/
_searchablemap_searchablemap_.searchablemap.html
955 lines (951 loc) · 58.6 KB
/
_searchablemap_searchablemap_.searchablemap.html
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SearchableMap | MiniSearch</title>
<meta name="description" content="Documentation for MiniSearch">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">MiniSearch</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_searchablemap_searchablemap_.html">"SearchableMap/SearchableMap"</a>
</li>
<li>
<a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a>
</li>
</ul>
<h1>Class SearchableMap<T></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A class implementing the same interface as a standard JavaScript
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map"><code>Map</code></a>
with string keys, but adding support for efficiently searching entries with
prefix or fuzzy search. This class is used internally by <a href="_minisearch_.minisearch.html">MiniSearch</a> as
the inverted index data structure. The implementation is a radix tree
(compressed prefix tree).</p>
</div>
<p>Since this class can be of general utility beyond <em>MiniSearch</em>, it is
exported by the <code>minisearch</code> package and can be imported (or required) as
<code>minisearch/SearchableMap</code>.</p>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T = <span class="tsd-signature-type">any</span></h4>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The type of the values stored in the map.</p>
</div>
</div>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SearchableMap</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#_symbol_iterator_" class="tsd-kind-icon">[<wbr>Symbol.iterator]</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#atprefix" class="tsd-kind-icon">at<wbr>Prefix</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#clear" class="tsd-kind-icon">clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#entries" class="tsd-kind-icon">entries</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#fetch" class="tsd-kind-icon">fetch</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#fuzzyget" class="tsd-kind-icon">fuzzy<wbr>Get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#has" class="tsd-kind-icon">has</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#keys" class="tsd-kind-icon">keys</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#set" class="tsd-kind-icon">set</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#update" class="tsd-kind-icon">update</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_searchablemap_searchablemap_.searchablemap.html#values" class="tsd-kind-icon">values</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="_searchablemap_searchablemap_.searchablemap.html#from" class="tsd-kind-icon">from</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="_searchablemap_searchablemap_.searchablemap.html#fromobject" class="tsd-kind-icon">from<wbr>Object</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Searchable<wbr>Map<span class="tsd-signature-symbol">(</span>tree<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RadixTree</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L31">SearchableMap/SearchableMap.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The constructor is normally called without arguments, creating an empty
map. In order to create a <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> from an iterable or from an
object, check <a href="_searchablemap_searchablemap_.searchablemap.html#from">SearchableMap.from</a> and <a href="_searchablemap_searchablemap_.searchablemap.html#fromobject">SearchableMap.fromObject</a>.</p>
</div>
<p>The constructor arguments are for internal use, when creating derived
mutable views of a map at a prefix.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> tree: <span class="tsd-signature-type">RadixTree</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map()</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> prefix: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="size" class="tsd-anchor"></a>
<h3>size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L207">SearchableMap/SearchableMap.ts:207</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/size">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/size</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_symbol_iterator_" class="tsd-anchor"></a>
<h3>[<wbr>Symbol.iterator]</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">[<wbr>Symbol.iterator]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"ENTRIES"</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L286">SearchableMap/SearchableMap.ts:286</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/@@iterator">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/@@iterator</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"ENTRIES"</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="atprefix" class="tsd-anchor"></a>
<h3>at<wbr>Prefix</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">at<wbr>Prefix<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L74">SearchableMap/SearchableMap.ts:74</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates and returns a mutable view of this <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a>, containing only
entries that share the given prefix.</p>
</div>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h3>Usage:</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">let</span> map = <span class="hljs-keyword">new</span> SearchableMap()
map.set(<span class="hljs-string">"unicorn"</span>, <span class="hljs-number">1</span>)
map.set(<span class="hljs-string">"universe"</span>, <span class="hljs-number">2</span>)
map.set(<span class="hljs-string">"university"</span>, <span class="hljs-number">3</span>)
map.set(<span class="hljs-string">"unique"</span>, <span class="hljs-number">4</span>)
map.set(<span class="hljs-string">"hello"</span>, <span class="hljs-number">5</span>)
<span class="hljs-keyword">let</span> uni = map.atPrefix(<span class="hljs-string">"uni"</span>)
uni.get(<span class="hljs-string">"unique"</span>) <span class="hljs-comment">// => 4</span>
uni.get(<span class="hljs-string">"unicorn"</span>) <span class="hljs-comment">// => 1</span>
uni.get(<span class="hljs-string">"hello"</span>) <span class="hljs-comment">// => undefined</span>
<span class="hljs-keyword">let</span> univer = map.atPrefix(<span class="hljs-string">"univer"</span>)
univer.get(<span class="hljs-string">"unique"</span>) <span class="hljs-comment">// => undefined</span>
univer.get(<span class="hljs-string">"universe"</span>) <span class="hljs-comment">// => 2</span>
univer.get(<span class="hljs-string">"university"</span>) <span class="hljs-comment">// => 3</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>prefix: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The prefix</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
<p>A <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> representing a mutable view of the original Map at the given prefix</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="clear" class="tsd-anchor"></a>
<h3>clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L97">SearchableMap/SearchableMap.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/clear">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/clear</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L106">SearchableMap/SearchableMap.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/delete">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/delete</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Key to delete</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="entries" class="tsd-anchor"></a>
<h3>entries</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">entries<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"ENTRIES"</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L115">SearchableMap/SearchableMap.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/entries">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/entries</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"ENTRIES"</span><span class="tsd-signature-symbol">></span></h4>
<p>An iterator iterating through <code>[key, value]</code> entries.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="fetch" class="tsd-anchor"></a>
<h3>fetch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, initial<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L262">SearchableMap/SearchableMap.ts:262</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches the value of the given key. If the value does not exist, calls the
given function to create a new value, which is inserted at the given key
and subsequently returned.</p>
</div>
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
<h3>Example:</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> map = searchableMap.fetch(<span class="hljs-string">'somekey'</span>, <span class="hljs-function">() =></span> <span class="hljs-keyword">new</span> <span class="hljs-built_in">Map</span>())
map.set(<span class="hljs-string">'foo'</span>, <span class="hljs-string">'bar'</span>)
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The key to update</p>
</div>
</li>
<li>
<h5>initial: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>The existing or new value at the given key</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="foreach" class="tsd-anchor"></a>
<h3>for<wbr>Each</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, map<span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L123">SearchableMap/SearchableMap.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/forEach">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/forEach</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, map<span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
<div class="tsd-comment tsd-typography">
<p>Iteration function</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, map<span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>value: <span class="tsd-signature-type">T</span></h5>
</li>
<li>
<h5>map: <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="fuzzyget" class="tsd-anchor"></a>
<h3>fuzzy<wbr>Get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fuzzy<wbr>Get<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxEditDistance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FuzzyResults</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L157">SearchableMap/SearchableMap.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a Map of all the entries that have a key within the given edit
distance from the search key. The keys of the returned Map are the matching
keys, while the values are two-element arrays where the first element is
the value associated to the key, and the second is the edit distance of the
key to the search key.</p>
</div>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h3>Usage:</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">let</span> map = <span class="hljs-keyword">new</span> SearchableMap()
map.set(<span class="hljs-string">'hello'</span>, <span class="hljs-string">'world'</span>)
map.set(<span class="hljs-string">'hell'</span>, <span class="hljs-string">'yeah'</span>)
map.set(<span class="hljs-string">'ciao'</span>, <span class="hljs-string">'mondo'</span>)
<span class="hljs-comment">// Get all entries that match the key 'hallo' with a maximum edit distance of 2</span>
map.fuzzyGet(<span class="hljs-string">'hallo'</span>, <span class="hljs-number">2</span>)
<span class="hljs-comment">// => Map(2) { 'hello' => ['world', 1], 'hell' => ['yeah', 2] }</span>
<span class="hljs-comment">// In the example, the "hello" key has value "world" and edit distance of 1</span>
<span class="hljs-comment">// (change "e" to "a"), the key "hell" has value "yeah" and edit distance of 2</span>
<span class="hljs-comment">// (change "e" to "a", delete "o")</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The search key</p>
</div>
</li>
<li>
<h5>maxEditDistance: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The maximum edit distance (Levenshtein)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FuzzyResults</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
<p>A Map of the matching keys to their value and edit distance</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="get" class="tsd-anchor"></a>
<h3>get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L167">SearchableMap/SearchableMap.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Key to get</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
<p>Value associated to the key, or <code>undefined</code> if the key is not
found.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="has" class="tsd-anchor"></a>
<h3>has</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L177">SearchableMap/SearchableMap.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Key</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>True if the key is in the map, false otherwise</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="keys" class="tsd-anchor"></a>
<h3>keys</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"KEYS"</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L186">SearchableMap/SearchableMap.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/keys">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/keys</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"KEYS"</span><span class="tsd-signature-symbol">></span></h4>
<p>An <code>Iterable</code> iterating through keys</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="set" class="tsd-anchor"></a>
<h3>set</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L196">SearchableMap/SearchableMap.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/set">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/set</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Key to set</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>Value to associate to the key</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
<p>The <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> itself, to allow chaining</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="update" class="tsd-anchor"></a>
<h3>update</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L238">SearchableMap/SearchableMap.ts:238</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Updates the value at the given key using the provided function. The function
is called with the current value at the key, and its return value is used as
the new value to be set.</p>
</div>
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
<h3>Example:</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-comment">// Increment the current value by one</span>
searchableMap.update(<span class="hljs-string">'somekey'</span>, <span class="hljs-function">(<span class="hljs-params">currentValue</span>) =></span> currentValue == <span class="hljs-literal">null</span> ? <span class="hljs-number">0</span> : currentValue + <span class="hljs-number">1</span>)
</code></pre>
<p>If the value at the given key is or will be an object, it might not require
re-assignment. In that case it is better to use <code>fetch()</code>, because it is
faster.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The key to update</p>
</div>
</li>
<li>
<h5>fn: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The function used to compute the new value from the current one</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
<p>The <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> itself, to allow chaining</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="values" class="tsd-anchor"></a>
<h3>values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"VALUES"</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L279">SearchableMap/SearchableMap.ts:279</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/values">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/values</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TreeIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"VALUES"</span><span class="tsd-signature-symbol">></span></h4>
<p>An <code>Iterable</code> iterating through values.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<a name="from" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<T><span class="tsd-signature-symbol">(</span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Entry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Entry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L296">SearchableMap/SearchableMap.ts:296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> from an <code>Iterable</code> of entries</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>entries: <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Entry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Entry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Entries to be inserted in the <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a></p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
<p>A new <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> with the given entries</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<a name="fromobject" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Object</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<wbr>Object<T><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/732d95a/src/SearchableMap/SearchableMap.ts#L310">SearchableMap/SearchableMap.ts:310</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> from the iterable properties of a JavaScript object</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>object: <span class="tsd-signature-symbol">{}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Object of entries for the <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a></p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">T</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-signature-type">SearchableMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
<p>A new <a href="_searchablemap_searchablemap_.searchablemap.html">SearchableMap</a> with the given entries</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_minisearch_.html">"<wbr>Mini<wbr>Search"</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_searchablemap_searchablemap_.html">"<wbr>Searchable<wbr>Map/<wbr>Searchable<wbr>Map"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="_searchablemap_searchablemap_.searchablemap.html" class="tsd-kind-icon">Searchable<wbr>Map</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#_symbol_iterator_" class="tsd-kind-icon">[<wbr>Symbol.iterator]</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#atprefix" class="tsd-kind-icon">at<wbr>Prefix</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#clear" class="tsd-kind-icon">clear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#entries" class="tsd-kind-icon">entries</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#fetch" class="tsd-kind-icon">fetch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#foreach" class="tsd-kind-icon">for<wbr>Each</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#fuzzyget" class="tsd-kind-icon">fuzzy<wbr>Get</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#has" class="tsd-kind-icon">has</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#keys" class="tsd-kind-icon">keys</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#set" class="tsd-kind-icon">set</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#update" class="tsd-kind-icon">update</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_searchablemap_searchablemap_.searchablemap.html#values" class="tsd-kind-icon">values</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<a href="_searchablemap_searchablemap_.searchablemap.html#from" class="tsd-kind-icon">from</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<a href="_searchablemap_searchablemap_.searchablemap.html#fromobject" class="tsd-kind-icon">from<wbr>Object</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>