Skip to content

Commit fba6161

Browse files
committed
Fix documentation
1 parent c208509 commit fba6161

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ npm install @ecromaneli/search-engine
3030
## Basic Usage
3131

3232
```javascript
33-
const { SearchEngine } = require('@ecromaneli/search-engine')
33+
const SearchEngine = require('@ecromaneli/search-engine')
3434

3535
const users = [
3636
{ id: 1, name: 'John Doe', age: 28, tags: ['developer', 'javascript'] },
@@ -76,11 +76,11 @@ The `SearchOptions` object allows you to customize the behavior of the search en
7676
- When `false`, only actual numbers will be considered for range searches.
7777

7878
- **`allowKeyValueMatching`**:
79-
- When `true`, a query like `"admin"` will match both `{ admin: "value" }` and `{ key: "admin" }`.
79+
- When `true`, a query like `admin` will match both `{ admin: "value" }` and `{ key: "admin" }`.
8080
- When `false`, it will only match field names or values explicitly.
8181

8282
- **`matchChildKeysAsValues`**:
83-
- When `true`, a query like `"foo:bar"` will match both `{ foo: "bar" }` and `{ foo: { bar: "value" } }`.
83+
- When `true`, a query like `foo:bar` will match both `{ foo: "bar" }` and `{foo: { bar: "value" }}`.
8484
- When `false`, it will only match `{ foo: "bar" }`.
8585

8686
## Query Syntax Reference

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@ecromaneli/search-engine",
3-
"version": "2.0.1",
3+
"version": "2.0.2",
44
"description": "A powerful object search engine with advanced query syntax",
55
"main": "dist/npm/index.min.js",
66
"files": [ "dist/npm/index.min.*", "dist/npm/index.d.*", "LICENSE" ],

0 commit comments

Comments
 (0)