Skip to content

Commit

Permalink
Update CHANGELOG and docs for v6.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucaong
lucaong committed Feb 1, 2023
1 parent 644302c commit e872ff6
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 53 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Expand Up @@ -2,6 +2,16 @@

`MiniSearch` follows [semantic versioning](https://semver.org/spec/v2.0.0.html).

# v6.0.1

- [fix] The `boost` search option now does not interfere with the `fields`
search option: if `fields` is specified, boosting a field that is not
included in `fields` has no effect, and will not include such boosted field
in the search.
- [fix] When using `search` with a `QuerySpec`, the `combineWith` option is
now properly taking its default from the `SearchOptions` given as the second
argument.

# v6.0.0

This is a major release. The most notable change is the addition of `discard`,
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Expand Up @@ -85,7 +85,7 @@ Alternatively, if you prefer to use a `<script>` tag, you can require MiniSearch
[from a CDN](https://www.jsdelivr.com/package/npm/minisearch):

```html
<script src="https://cdn.jsdelivr.net/npm/minisearch@6.0.0/dist/umd/index.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/minisearch@6.0.1/dist/umd/index.min.js"></script>
```

In this case, `MiniSearch` will appear as a global variable in your project.
Expand Down
42 changes: 21 additions & 21 deletions docs/classes/_minisearch_.minisearch.html
View file
Expand Up @@ -198,7 +198,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L484">MiniSearch.ts:484</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L484">MiniSearch.ts:484</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -286,7 +286,7 @@ <h3>dirt<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1012">MiniSearch.ts:1012</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1012">MiniSearch.ts:1012</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -308,7 +308,7 @@ <h3>dirt<wbr>Factor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1023">MiniSearch.ts:1023</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1023">MiniSearch.ts:1023</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -334,7 +334,7 @@ <h3>document<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1291">MiniSearch.ts:1291</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1291">MiniSearch.ts:1291</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -356,7 +356,7 @@ <h3>is<wbr>Vacuuming</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1005">MiniSearch.ts:1005</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1005">MiniSearch.ts:1005</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -378,7 +378,7 @@ <h3>term<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1298">MiniSearch.ts:1298</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1298">MiniSearch.ts:1298</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -403,7 +403,7 @@ <h3>add</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L599">MiniSearch.ts:599</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L599">MiniSearch.ts:599</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -434,7 +434,7 @@ <h3>add<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L641">MiniSearch.ts:641</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L641">MiniSearch.ts:641</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -465,7 +465,7 @@ <h3>add<wbr>All<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L656">MiniSearch.ts:656</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L656">MiniSearch.ts:656</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -511,7 +511,7 @@ <h3>auto<wbr>Suggest</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1263">MiniSearch.ts:1263</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1263">MiniSearch.ts:1263</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -597,7 +597,7 @@ <h3>discard</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L803">MiniSearch.ts:803</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L803">MiniSearch.ts:803</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -668,7 +668,7 @@ <h3>discard<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L845">MiniSearch.ts:845</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L845">MiniSearch.ts:845</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -703,7 +703,7 @@ <h3>has</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1033">MiniSearch.ts:1033</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1033">MiniSearch.ts:1033</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -735,7 +735,7 @@ <h3>remove</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L691">MiniSearch.ts:691</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L691">MiniSearch.ts:691</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -773,7 +773,7 @@ <h3>remove<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L743">MiniSearch.ts:743</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L743">MiniSearch.ts:743</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -808,7 +808,7 @@ <h3>replace</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L876">MiniSearch.ts:876</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L876">MiniSearch.ts:876</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -847,7 +847,7 @@ <h3>search</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1175">MiniSearch.ts:1175</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1175">MiniSearch.ts:1175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -999,7 +999,7 @@ <h3>toJSON</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1539">MiniSearch.ts:1539</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1539">MiniSearch.ts:1539</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1039,7 +1039,7 @@ <h3>vacuum</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L923">MiniSearch.ts:923</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L923">MiniSearch.ts:923</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1100,7 +1100,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Default</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1351">MiniSearch.ts:1351</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1351">MiniSearch.ts:1351</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1146,7 +1146,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> loadJSON</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/2d7a021/src/MiniSearch.ts#L1323">MiniSearch.ts:1323</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/cc1aa97/src/MiniSearch.ts#L1323">MiniSearch.ts:1323</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit e872ff6

Please sign in to comment.