new OCollector()
An object based collector
Parameters:
| Type | Description |
|---|
Extends
members
length :number
Get the size of the collection
Type:
- number
- Inherited From:
methods
all(qu)
Returns true if all items match the query. Aliases as every
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
- Inherited From:
Returns:
- Type
- boolean
any(qu)
Returns true if any of the items match the query. Aliases as all
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
- Inherited From:
Returns:
- Type
- boolean
every(qu)
Returns true if all items match the query. Aliases as all
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
- Inherited From:
Returns:
- Type
- boolean
find(qu)
Find all records that match a query
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
- Inherited From:
Returns:
The results
- Type
- array
findKeys(qu)
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. |
- Inherited From:
Returns:
- Type
- array
findOne(qu)
Returns the first record that matches the query. Aliased as seek.
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
- Inherited From:
Returns:
- Type
- object
findOneKey(qu)
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. |
- Inherited From:
Returns:
- Type
- object
remove(qu)
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. |
- Inherited From:
Returns:
The array or object as appropriate without the records.
- Type
- object | array
some(qu)
Returns true if any of the items match the query. Aliases as any
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute |
- Inherited From:
Returns:
- Type
- boolean
unique(qu)
Returns the set of unique records that match a query
Parameters:
| Name | Type | Description |
|---|---|---|
qu |
object | The query to execute. |
- Inherited From:
Returns:
- Type
- array
update(qu, setDocument)
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 |
- Inherited From: