Global

Methods

hydrate(document){Object}

utils.js, line 175

When parsing, coerce types where applicable.

Name	Type	Description
document	Object	The document to hydrate.

Returns:

Type	Description
Object	The hydrated document.

Type Definitions

PaginationOptions

Pagination Options

Properties:

Name	Type	Description
page	Number	The page number.
size	Number	The page size.
start	Number	The starting index.
end	Number	The ending index (exclusive)

QueryObject

You can find more information on querying documents here.

Example

{ name: { $in: ['Foo', 'Bar'] } }

QueryListArray

An Array of id values associated with a particular query.

QueryMatchObject

Properties:

Name	Type	Description
queryList	Array	The list of document IDs.
matchType	String	The type of match strategy used.

WideMatch

Wide-Match strategy results.

Properties:

Name	Type	Description
targetQuery	String	A super-query that contains the requested query.
rangeOptions	Object	Properties Name Type Description start Number The starting index of the requested query's data (inclusive). end Number The starting index of the requested query's data (exclusive).