Skip to content

Commit

Permalink
Update CHANGELOG and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lucaong committed May 29, 2024
1 parent 4e158dd commit 6df3fa3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- More informative error when specifying an invalid value for `combineWith`
in JavaScript (in TypeScript this would be a compile time error)
- Use the Unicode flag to simplify the tokenizer regular expression
- Add `loadJSONAsync` method, to load a serialized index asynchronously

## v6.3.0 - 2023-11-22

Expand Down
6 changes: 6 additions & 0 deletions src/MiniSearch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1476,6 +1476,12 @@ export default class MiniSearch<T = any> {
/**
* Async equivalent of {@link MiniSearch.loadJSON}
*
* This function is an alternative to {@link MiniSearch.loadJSON} that returns
* a promise, and loads the index in batches, leaving pauses between them to avoid
* blocking the main thread. It tends to be slower than the synchronous
* version, but does not block the main thread, so it can be a better choice
* when deserializing very large indexes.
*
* @param json JSON-serialized index
* @param options configuration options, same as the constructor
* @return A Promise that will resolve to an instance of MiniSearch deserialized from the given JSON.
Expand Down

0 comments on commit 6df3fa3

Please sign in to comment.