Result

Members

---

documents

Description

Get the filtered and possibly altered documents.

Returns

Array.<object>

Filtered and possibly altered documents.

Details

Source

result.js, line 82

---

originalDocuments

Description

Get the filtered but unaltered results documents.

Returns

Array.<object>

Filtered but unaltered documents.

Details

Source

result.js, line 91

Methods

---

simpleSort( prop [, desc ] ) → {this}

Description

Sort the results given a specific property. Supported property value types are string, number, boolean or Date.

Parameters

Name	Type	Attributes	Default	Description
prop	string			Property name within the documents.
desc	boolean	<optional>	false	Whether to sort the results descending.

Returns

this

Result instance.

Details

Source

result.js, line 22

---

sort( sortFn ) → {this}

Description

Sort the results using your own custom sort function.

Parameters

Name	Type	Description
sortFn	function	Custom sort function which will be applied on each result.

Returns

this

Result instance.

Details

Source

result.js, line 42

---

map( mapFn ) → {this}

Description

Map the results using your own custom map function.

Parameters

Name	Type	Description
mapFn	function	Custom map function which will be applied on each result.

Returns

this

Result instance.

Details

Source

result.js, line 57

---

limit( value ) → {this}

Description

Limit the number of results.

Parameters

Name	Type	Description
value	number	Limit value for the results.

Returns

this

Result instance.

Details

Source

result.js, line 72