lucaong / minisearch / #515

99%

push

GitHub Actions

Wildcard query that matches all documents (#234)

* Wildcard query that matches all documents

This commit introduces a special wildcard value, `MiniSearch.wildcard`,
that matches all documents:

```javascript
// Return search results for all documents
minisearch.search(MiniSearch.wildcard)

// Return search results for all documents in the 'fiction' category
minisearch.search(MiniSearch.wildcard, {
  filter: (result) => result.category === 'fiction'
})
```

This is useful for retrieving all results, but still apply search
options such as `filter` and `boostDocument`. It can also be useful in
query combinations, for example to query for all documents that DO NOT
contain a specific term:

```javascript
// Search for all documents that do NOT contain the term "maintenance"
const results = ms.search({
  combineWith: 'AND_NOT',
  queries: [
    MiniSearch.wildcard,
    'maintenance'
  ]
})
```

* Optimize wildcard search with no document boosting

In this case, there is no need to sort the results.

222 of 228 branches covered (0.0%)

Branch coverage included in aggregate %.

16 of 16 new or added lines in 1 file covered. (100.0%)

680 of 680 relevant lines covered (100.0%)

731.24 hits per line