new documents/model()
A model is the first level if usable data-bearing entity in the system. It does NOT include any verbs for saving or anything like that, it is a pure, in memory data container
Parameters:
| Type | Description |
|---|
members
isEmpty :boolean
Returns true if this instance is empty
Type:
- boolean
isNew :boolean
If documents/model#_idField is filled in and it's value is empty this will be true.
Type:
- boolean
methods
all(obj, qu)
Returns true if all items match the query
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
- Type
- boolean
any(obj, qu)
Returns true if any of the items match the query
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
- Type
- boolean
every(obj, qu)
Returns true if all items match the query. Aliases as all
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute |
Returns:
- Type
- boolean
find(obj, qu)
Find all records that match a query
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
The results
- Type
- array
findKeys(obj, qu)
Find all records that match a query and returns the keys for those items. This is similar to module:documents/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 |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
- Type
- array
findOne(obj, qu)
Returns the first record that matches the query. Aliased as seek.
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
- Type
- object
findOneKey(obj, 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 |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
- Type
- object
get(path, record)
Reaches into an object and allows you to get at a value deeply nested in an object. This is not a query, but a straight reach in, useful for event bindings
Parameters:
| Name | Type | Description |
|---|---|---|
path |
array | The split path of the element to work with |
record |
object | The record to reach into |
Returns:
Whatever was found in the record
- Type
- *
remove(obj, qu)
Remove all items in the object/array that match the query
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute. See module:documents/probe.queryOperators for the operators you can use. |
Returns:
The array or object as appropriate without the records.
- Type
- object | array
set(path, record, setter, newValue)
This will write the value into a record at the path, creating intervening objects if they don't exist. This does not work as filtered update and is meant to be used on a single record. It is a nice way of setting a property at an arbitrary depth at will.
Parameters:
| Name | Type | Description |
|---|---|---|
path |
array | The split path of the element to work with |
record |
object | The record to reach into |
setter |
string | The set operation. See module:documents/probe.updateOperators for the operators you can use. |
newValue |
object | The value to write to the, or if the operator is $pull, the query of items to look for |
some(obj, qu)
Returns true if any of the items match the query. Aliases as any
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
array | object | The object to query |
qu |
object | The query to execute |
Returns:
- Type
- boolean
update(obj, qu, setDocument)
Updates all records in obj that match the query. See module:documents/probe.updateOperators for the operators that are supported.
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
object | array | The object to update |
qu |
object | The query which will be used to identify the records to updated |
setDocument |
object | The update operator. See module:documents/probe.updateOperators |