+138
-7
lines changedFilter options
+138
-7
lines changed Original file line number Diff line number Diff line change
@@ -50,20 +50,40 @@ await Post.select({
50 50 51 51
Add a basic where clause to the query.
52 52 53 +
**Simple:**
54 + 53 55
```js
54 56
await Model.where('status', 'active')
55 57
```
56 58 59 +
**Nested:**
60 + 61 +
<alert type="success">Available in version >= v1.8.0</alert>
62 + 63 +
```js
64 +
await Model.where(['user', 'status'], 'active')
65 +
```
66 + 57 67
## `whereIn`
58 68
- Arguments: `(field, array)`
59 69
- Returns: `self`
60 70 61 71
Add a "where in" clause to the query.
62 72 73 +
**Simple:**
74 + 63 75
```js
64 76
await Model.whereIn('id', [1, 2, 3])
65 77
```
66 78 79 +
**Nested:**
80 + 81 +
<alert type="success">Available in version >= v1.8.0</alert>
82 + 83 +
```js
84 +
await Model.whereIn(['user', 'id'], [1, 2, 3])
85 +
```
86 + 67 87
## `orderBy`
68 88
- Arguments: `(...args)`
69 89
- Returns: `self`
@@ -242,6 +242,33 @@ We can filter our **Posts** to only get results where `status` is `published`:
242 242
</code-block>
243 243
</code-group>
244 244 245 +
#### Nested Filter
246 + 247 +
<alert type="success">Available in version >= v1.8.0</alert>
248 + 249 +
The first argument of `where` also accepts an array of keys, which are used to build a nested filter.
250 + 251 +
So we can filter our **Posts** to only get results where `status` of `user` is `active`:
252 + 253 +
<code-group>
254 +
<code-block label="Query" active>
255 + 256 +
```js
257 +
const posts = await Post.where([
258 +
'user', 'status'
259 +
], 'active').get()
260 +
```
261 + 262 +
</code-block>
263 +
<code-block label="Request">
264 + 265 +
```http request
266 +
GET /posts?filter[user][status]=active
267 +
```
268 + 269 +
</code-block>
270 +
</code-group>
271 + 245 272
### Evaluating Multiple Values
246 273 247 274
See the [API reference](/api/query-builder-methods#wherein)
@@ -271,6 +298,33 @@ We can filter our **Posts** to only get results where `status` is `published` or
271 298
</code-block>
272 299
</code-group>
273 300 301 +
#### Nested Filter
302 + 303 +
<alert type="success">Available in version >= v1.8.0</alert>
304 + 305 +
The first argument of `whereIn` also accepts an array of keys, which are used to build a nested filter.
306 + 307 +
So we can filter our **Posts** to only get results where `status` of `user` is `active` or `inactive`:
308 + 309 +
<code-group>
310 +
<code-block label="Query" active>
311 + 312 +
```js
313 +
const posts = await Post.whereIn(['user', 'status'], [
314 +
'active', 'inactive'
315 +
]).get()
316 +
```
317 + 318 +
</code-block>
319 +
<code-block label="Request">
320 + 321 +
```http request
322 +
GET /posts?filter[user][status]=active,inactive
323 +
```
324 + 325 +
</code-block>
326 +
</code-group>
327 + 274 328
## Sorting
275 329 276 330
See the [API reference](/api/query-builder-methods#orderby)
@@ -3,6 +3,7 @@
3 3
*/
4 4 5 5
import Parser from './Parser';
6 +
import setProp from 'dset'
6 7 7 8
export default class Builder {
8 9
@@ -21,11 +22,43 @@ export default class Builder {
21 22
this.parser = new Parser(this)
22 23
}
23 24 24 -
// query string parsed
25 +
// query string parsed
25 26
query() {
26 27
return this.parser.query()
27 28
}
28 29 30 +
/**
31 +
* Helpers
32 +
*/
33 + 34 +
/**
35 +
* Nested filter via array-type keys.
36 +
*
37 +
* @example
38 +
* const [_key, _value] = this._nestedFilter(keys, value)
39 +
* this.filters[_key] = _value
40 +
*
41 +
* @param {string[]} keys - Array-type keys, like `['a', 'b', 'c']`.
42 +
* @param {*} value - The value to be set.
43 +
*
44 +
* @return {[]} - An array containing the first key, which is the index to be used in `filters`
45 +
* object, and a value, which is the nested filter.
46 +
*
47 +
*/
48 +
_nestedFilter (keys, value) {
49 +
// Get first key from `keys` array, then remove it from array
50 +
const _key = keys.shift()
51 +
// Initialize an empty object
52 +
const _value = {}
53 + 54 +
// Convert the keys into a deeply nested object, which the value of the deepest key is
55 +
// the `value` property.
56 +
// Then assign the object to `_value` property.
57 +
setProp(_value, keys, value)
58 + 59 +
return [_key, _value]
60 +
}
61 + 29 62
/**
30 63
* Query builder
31 64
*/
@@ -63,22 +96,37 @@ export default class Builder {
63 96
}
64 97 65 98
where(key, value) {
66 -
if (key === undefined || value === undefined)
99 +
if (key === undefined || value === undefined) {
67 100
throw new Error('The KEY and VALUE are required on where() method.')
101 +
}
68 102 69 -
if (Array.isArray(value) || value instanceof Object)
103 +
if (Array.isArray(value) || value instanceof Object) {
70 104
throw new Error('The VALUE must be primitive on where() method.')
105 +
}
71 106 72 -
this.filters[key] = value
107 +
if (Array.isArray(key)) {
108 +
const [_key, _value] = this._nestedFilter(key, value)
109 + 110 +
this.filters[_key] = _value
111 +
} else {
112 +
this.filters[key] = value
113 +
}
73 114 74 115
return this
75 116
}
76 117 77 118
whereIn(key, array) {
78 -
if (!Array.isArray(array))
119 +
if (!Array.isArray(array)) {
79 120
throw new Error('The second argument on whereIn() method must be an array.')
121 +
}
122 + 123 +
if (Array.isArray(key)) {
124 +
const [_key, _value] = this._nestedFilter(key, array.join(','))
80 125 81 -
this.filters[key] = array.join(',')
126 +
this.filters[_key] = _value
127 +
} else {
128 +
this.filters[key] = array.join(',')
129 +
}
82 130 83 131
return this
84 132
}
@@ -94,6 +94,11 @@ describe('Query builder', () => {
94 94
post = Post.where('id', 1).where('title', 'Cool')
95 95 96 96
expect(post._builder.filters).toEqual({ id: 1, title: 'Cool' })
97 + 98 +
post = Post.where(['user', 'status'], 'active')
99 + 100 +
expect(post._builder.filters).toEqual({ user: { status: 'active' } })
101 +
expect(post._builder.query()).toEqual('?filter[user][status]=active')
97 102
})
98 103 99 104
test('where() throws a exception when doest not have params or only first param', () => {
@@ -122,6 +127,10 @@ describe('Query builder', () => {
122 127
let post = Post.whereIn('status', ['ACTIVE', 'ARCHIVED'])
123 128 124 129
expect(post._builder.filters).toEqual({ status: 'ACTIVE,ARCHIVED' })
130 + 131 +
post = Post.whereIn(['user', 'status'], ['active', 'inactive'])
132 + 133 +
expect(post._builder.query()).toEqual('?filter[user][status]=active,inactive')
125 134
})
126 135 127 136
test('whereIn() throws a exception when second parameter is not a array', () => {
@@ -209,4 +218,4 @@ describe('Query builder', () => {
209 218
expect(post._builder.query()).toEqual(query)
210 219
expect(post._builder.query()).toEqual(query)
211 220
})
212 -
})
221 +
})
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4