Members
-
length :number
-
Description
Get the size of the collection
Details
Methods
-
every( qu ) → {boolean}
-
Description
Returns true if all items match the query. Aliases as
allParameters
Name Type Description quobject The query to execute
Returns
Details
-
some( qu ) → {boolean}
-
Description
Returns true if any of the items match the query. Aliases as
anyParameters
Name Type Description quobject The query to execute
Returns
Details
-
unique( qu ) → {array}
-
Description
Returns the set of unique records that match a query
Parameters
Name Type Description quobject The query to execute.
Returns
Details
-
all( qu ) → {boolean}
-
Description
Returns true if all items match the query. Aliases as
everyParameters
Name Type Description quobject The query to execute
Returns
Details
-
any( qu ) → {boolean}
-
Description
Returns true if any of the items match the query. Aliases as
allParameters
Name Type Description quobject The query to execute
Returns
Details
-
remove( qu ) → {object|array}
-
Description
Remove all items in the object/array that match the query
Parameters
Name Type Description quobject The query to execute. See module:ink/probe.queryOperators for the operators you can use.
Returns
Details
-
findOneKey( qu ) → {object}
-
Description
Returns the first record that matches the query and returns its key or index depending on whether
objis an object or array respectively.
Aliased asseekKey.Parameters
Name Type Description quobject The query to execute.
Returns
Details
-
findOne( qu ) → {object}
-
Description
Returns the first record that matches the query. Aliased as
seek.Parameters
Name Type Description quobject The query to execute.
Returns
Details
-
findKeys( qu ) → {array}
-
Description
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. Ifobjis an object it will return the hash key. If 'obj' is an array, it will return the indexParameters
Name Type Description quobject The query to execute.
Returns
Details
-
find( qu ) → {array}
-
Description
Find all records that match a query
Parameters
Name Type Description quobject The query to execute.
Returns
Details
-
update( qu, setDocument )
-
Description
Updates all records in obj that match the query. See module:ink/probe.updateOperators for the operators that are supported.
Parameters
Name Type Description quobject The query which will be used to identify the records to updated
setDocumentobject The update operator. See module:ink/probe.updateOperators
Details