UNPKG

1.75 kBMarkdownView Raw
1<a name="ResultSet"></a>
2## ResultSet
3* [new ResultSet(entries)](#new_ResultSet_new)
4* _instance_
5 * [.valueOf()](#ResultSet+valueOf) ⇒ <code>Array</code>
6 * [.toString()](#ResultSet+toString) ⇒ <code>string</code>
7 * [.toJSON()](#ResultSet+toJSON) ⇒ <code>Object</code>
8* _static_
9 * [.fromJSON(json)](#ResultSet.fromJSON) ⇒ <code>[ResultSet](#ResultSet)</code>
10
11<a name="new_ResultSet_new"></a>
12### new ResultSet(entries)
13A ResultSet contains a list or results
14
15
16| Param | Type |
17| --- | --- |
18| entries | <code>Array</code> |
19
20<a name="ResultSet+valueOf"></a>
21### resultSet.valueOf() ⇒ <code>Array</code>
22Returns the array with results hold by this ResultSet
23
24**Kind**: instance method of <code>[ResultSet](#ResultSet)</code>
25**Returns**: <code>Array</code> - entries
26<a name="ResultSet+toString"></a>
27### resultSet.toString() ⇒ <code>string</code>
28Returns the stringified results of the ResultSet
29
30**Kind**: instance method of <code>[ResultSet](#ResultSet)</code>
31**Returns**: <code>string</code> - string
32<a name="ResultSet+toJSON"></a>
33### resultSet.toJSON() ⇒ <code>Object</code>
34Get a JSON representation of the ResultSet
35
36**Kind**: instance method of <code>[ResultSet](#ResultSet)</code>
37**Returns**: <code>Object</code> - Returns a JSON object structured as: `{"mathjs": "ResultSet", "entries": [...]}`
38<a name="ResultSet.fromJSON"></a>
39### ResultSet.fromJSON(json) ⇒ <code>[ResultSet](#ResultSet)</code>
40Instantiate a ResultSet from a JSON object
41
42**Kind**: static method of <code>[ResultSet](#ResultSet)</code>
43
44| Param | Type | Description |
45| --- | --- | --- |
46| json | <code>Object</code> | A JSON object structured as: `{"mathjs": "ResultSet", "entries": [...]}` |
47