Class: module:models/StoreResult

module:models/StoreResult()

new module:models/StoreResult()

Constructs a new StoreResult. Result document containing an array of stores.

Source:

Members

(inner) count :Number

The number of search results in the current page.

Type:
  • Number
Source:

(inner) data :Array.<module:models/Store>

Type:
Source:

(inner) next :String

The URL of the next result page.

Type:
  • String
Source:

(inner) previous :String

The URL of the previous result page.

Type:
  • String
Source:

(inner) start :Number

The zero-based index of the first search result to include in the document.

Type:
  • Number
Source:

(inner) total :Number

The total number of search results.

Type:
  • Number
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/StoreResult}

Constructs a StoreResult from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/StoreResult

Optional instance to populate.

Source:
Returns:

The populated StoreResult instance.

Type
module:models/StoreResult