Extends
Members
length :number
- Source:
- Inherited From:
Get the size of the collection
Type:
- number
Methods
all(qu) → {boolean}
- Source:
- Inherited From:
Returns true if all items match the query. Aliases as every
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
Returns:
- Type
- boolean
any(qu) → {boolean}
- Source:
- Inherited From:
Returns true if any of the items match the query. Aliases as all
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
Returns:
- Type
- boolean
every(qu) → {boolean}
- Source:
- Inherited From:
Returns true if all items match the query. Aliases as all
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
Returns:
- Type
- boolean
find(qu) → {array}
- Source:
- Inherited From:
Find all records that match a query
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
Returns:
The results
- Type
- array
findKeys(qu) → {array}
- Source:
- Inherited From:
Find all records that match a query and returns the keys for those items. This is similar to module:ink/probe.find but instead of returning
records, returns the keys. If obj is an object it will return the hash key. If 'obj' is an array, it will return the index
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
Returns:
- Type
- array
findOne(qu) → {object}
- Source:
- Inherited From:
Returns the first record that matches the query. Aliased as seek.
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
Returns:
- Type
- object
findOneKey(qu) → {object}
- Source:
- Inherited From:
Returns the first record that matches the query and returns its key or index depending on whether obj is an object or array respectively.
Aliased as seekKey.
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
Returns:
- Type
- object
remove(qu) → {object|array}
- Source:
- Inherited From:
Remove all items in the object/array that match the query
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. See module:ink/probe.queryOperators for the operators you can use. |
Returns:
The array or object as appropriate without the records.
- Type
- object | array
some(qu) → {boolean}
- Source:
- Inherited From:
Returns true if any of the items match the query. Aliases as any
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
Returns:
- Type
- boolean
unique(qu) → {array}
- Source:
- Inherited From:
Returns the set of unique records that match a query
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
Returns:
- Type
- array
update(qu, setDocument)
- Source:
- Inherited From:
Updates all records in obj that match the query. See module:ink/probe.updateOperators for the operators that are supported.
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query which will be used to identify the records to updated |
setDocument |
object | The update operator. See module:ink/probe.updateOperators |