Skip to content

Commit bb756a8

Browse files
Merge pull request #227 from algoliareadmebot/master
Update README
2 parents 3714d75 + 88ea000 commit bb756a8

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1212,7 +1212,7 @@ The following **individual filters** are supported:
12121212
Example: `inStock > 0`.
12131213

12141214
- **Range**: `${attributeName}:${lowerBound} TO ${upperBound}` matches all objects where the specified numeric
1215-
attribute is within the range [`${lowerBound}`, `${upperBound}`] (inclusive on both ends).
1215+
attribute is within the range [`${lowerBound}`, `${upperBound}`] \(inclusive on both ends).
12161216
Example: `publication_date: 1441745506 TO 1441755506`.
12171217

12181218
- **Facet filter**: `${facetName}:${facetValue}` matches all objects containing exactly the specified value in the specified facet attribute. *Facet matching is case sensitive*. Example: `category:Book`.
@@ -1798,6 +1798,14 @@ This advanced syntax brings two additional features:
17981798

17991799
List of words that should be considered as optional when found in the query.
18001800

1801+
This parameter can be useful when you want to do an **OR** between all words of the query.
1802+
To do that you can set optionalWords equals to the search query.
1803+
1804+
```js
1805+
var query = 'the query';
1806+
var params = {'optionalWords': query};
1807+
```
1808+
18011809
**Note:** You don't need to put commas between words.
18021810
Each string will automatically be tokenized into words, all of which will be considered as optional.
18031811

@@ -2007,7 +2015,7 @@ Each string represents a filter on a numeric attribute. Two forms are supported:
20072015
Example: `inStock > 0`.
20082016

20092017
- **Range**: `${attributeName}:${lowerBound} TO ${upperBound}` matches all objects where the specified numeric
2010-
attribute is within the range [`${lowerBound}`, `${upperBound}`] (inclusive on both ends).
2018+
attribute is within the range [`${lowerBound}`, `${upperBound}`] \(inclusive on both ends).
20112019
Example: `price: 0 TO 1000`.
20122020

20132021
If you specify multiple filters, they are interpreted as a conjunction (AND). If you want to use a disjunction (OR),

0 commit comments

Comments
 (0)