@@ -149,6 +149,7 @@
Loading
149 149
   * @param options
150 150
   * @param saveOpts
151 151
   * @deprecated since 2.9.0 see {@link https://parseplatform.org/Parse-SDK-JS/api/master/Parse.User.html#linkWith linkWith}
152 +
   * @returns {Promise}
152 153
   */
153 154
  _linkWith(provider: any, options: { authData?: AuthData }, saveOpts?: FullOptions = {}): Promise<ParseUser> {
154 155
    return this.linkWith(provider, options, saveOpts);
@@ -306,7 +307,7 @@
Loading
306 307
  /**
307 308
   * Returns get("username").
308 309
   *
309 -
   * @returns {string} User's username
310 +
   * @returns {string}
310 311
   */
311 312
  getUsername(): ?string {
312 313
    const username = this.get('username');
@@ -320,8 +321,6 @@
Loading
320 321
   * Calls set("username", username, options) and returns the result.
321 322
   *
322 323
   * @param {string} username
323 -
   * @param {object} options
324 -
   * @returns {boolean}
325 324
   */
326 325
  setUsername(username: string) {
327 326
    // Strip anonymity, even we do not support anonymous user in js SDK, we may
@@ -384,7 +383,7 @@
Loading
384 383
  /**
385 384
   * Checks whether this user is the current user and has been authenticated.
386 385
   *
387 -
   * @returns (Boolean) whether this user is the current user and is logged in.
386 +
   * @returns {boolean} whether this user is the current user and is logged in.
388 387
   */
389 388
  authenticated(): boolean {
390 389
    const current = ParseUser.current();
@@ -461,6 +460,7 @@
Loading
461 460
   * storage if this is current user.
462 461
   *
463 462
   * @param {...any} args
463 +
   * @returns {Promise}
464 464
   */
465 465
  save(...args: Array<any>): Promise<ParseUser> {
466 466
    return super.save.apply(this, args).then(() => {
@@ -476,6 +476,7 @@
Loading
476 476
   * the current user when it is destroyed
477 477
   *
478 478
   * @param {...any} args
479 +
   * @returns {Parse.User}
479 480
   */
480 481
  destroy(...args: Array<any>): Promise<ParseUser> {
481 482
    return super.destroy.apply(this, args).then(() => {
@@ -491,6 +492,7 @@
Loading
491 492
   * storage if this is current user.
492 493
   *
493 494
   * @param {...any} args
495 +
   * @returns {Parse.User}
494 496
   */
495 497
  fetch(...args: Array<any>): Promise<ParseUser> {
496 498
    return super.fetch.apply(this, args).then(() => {
@@ -506,6 +508,7 @@
Loading
506 508
   * storage if this is current user.
507 509
   *
508 510
   * @param {...any} args
511 +
   * @returns {Parse.User}
509 512
   */
510 513
  fetchWithInclude(...args: Array<any>): Promise<ParseUser> {
511 514
    return super.fetchWithInclude.apply(this, args).then(() => {
@@ -731,8 +734,9 @@
Loading
731 734
   * @param options
732 735
   * @param saveOpts
733 736
   * @static
737 +
   * @returns {Promise}
734 738
   */
735 -
  static logInWith(provider: any, options: { authData?: AuthData }, saveOpts?: FullOptions) {
739 +
  static logInWith(provider: any, options: { authData?: AuthData }, saveOpts?: FullOptions): Promise<ParseUser> {
736 740
    const user = new this();
737 741
    return user.linkWith(provider, options, saveOpts);
738 742
  }
@@ -858,7 +862,7 @@
Loading
858 862
   * It is not necessary to call this method from cloud code unless you are
859 863
   * handling user signup or login from the server side. In a cloud code call,
860 864
   * this function will not attempt to upgrade the current token.
861 -
865 +
   *
862 866
   * @param {object} options
863 867
   * @static
864 868
   * @returns {Promise} A promise that is resolved when the process has
@@ -927,6 +931,7 @@
Loading
927 931
   * @param saveOpts
928 932
   * @deprecated since 2.9.0 see {@link https://parseplatform.org/Parse-SDK-JS/api/master/Parse.User.html#logInWith logInWith}
929 933
   * @static
934 +
   * @returns {Promise}
930 935
   */
931 936
  static _logInWith(provider: any, options: { authData?: AuthData }, saveOpts?: FullOptions) {
932 937
    const user = new this();

@@ -143,8 +143,7 @@
Loading
143 143
  /**
144 144
   * The ID of this object, unique within its class.
145 145
   *
146 -
   * @property id
147 -
   * @type String
146 +
   * @property {string} id
148 147
   */
149 148
  id: ?string;
150 149
  _localId: ?string;
@@ -161,8 +160,8 @@
Loading
161 160
  /**
162 161
   * The first time this object was saved on the server.
163 162
   *
164 -
   * @property createdAt
165 -
   * @type Date
163 +
   * @property {Date} createdAt
164 +
   * @returns {Date}
166 165
   */
167 166
  get createdAt(): ?Date {
168 167
    return this._getServerData().createdAt;
@@ -171,8 +170,8 @@
Loading
171 170
  /**
172 171
   * The last time this object was updated on the server.
173 172
   *
174 -
   * @property updatedAt
175 -
   * @type Date
173 +
   * @property {Date} updatedAt
174 +
   * @returns {Date}
176 175
   */
177 176
  get updatedAt(): ?Date {
178 177
    return this._getServerData().updatedAt;
@@ -199,6 +198,8 @@
Loading
199 198
200 199
  /**
201 200
   * Returns a unique identifier used to pull data from the State Controller.
201 +
   *
202 +
   * @returns {Parse.Object|object}
202 203
   */
203 204
  _getStateIdentifier(): ParseObject | {id: string, className: string} {
204 205
    if (singleInstance) {
@@ -584,6 +585,7 @@
Loading
584 585
   * Gets the value of an attribute.
585 586
   *
586 587
   * @param {string} attr The string name of an attribute.
588 +
   * @returns {*}
587 589
   */
588 590
  get(attr: string): mixed {
589 591
    return this.attributes[attr];
@@ -592,8 +594,7 @@
Loading
592 594
  /**
593 595
   * Gets a relation on the given class for the attribute.
594 596
   *
595 -
   * @param String attr The attribute to get the relation for.
596 -
   * @param attr
597 +
   * @param {string} attr The attribute to get the relation for.
597 598
   * @returns {Parse.Relation}
598 599
   */
599 600
  relation(attr: string): ParseRelation {
@@ -612,6 +613,7 @@
Loading
612 613
   * Gets the HTML-escaped value of an attribute.
613 614
   *
614 615
   * @param {string} attr The string name of an attribute.
616 +
   * @returns {string}
615 617
   */
616 618
  escape(attr: string): string {
617 619
    let val = this.attributes[attr];
@@ -1036,7 +1038,7 @@
Loading
1036 1038
   * <code>save</code>.  Your implementation should return
1037 1039
   *
1038 1040
   * @param {object} attrs The current data to validate.
1039 -
   * @returns {} False if the data is valid.  An error object otherwise.
1041 +
   * @returns {Parse.Error|boolean} False if the data is valid.  An error object otherwise.
1040 1042
   * @see Parse.Object#set
1041 1043
   */
1042 1044
  validate(attrs: AttributeMap): ParseError | boolean {
@@ -1215,13 +1217,13 @@
Loading
1215 1217
   * // The save failed.  Error is an instance of Parse.Error.
1216 1218
   * });</pre>
1217 1219
   *
1218 -
   * @param {string | object | null} [attrs]
1220 +
   * @param {string | object | null} [arg1]
1219 1221
   * Valid options are:<ul>
1220 1222
   * <li>`Object` - Key/value pairs to update on the object.</li>
1221 1223
   * <li>`String` Key - Key of attribute to update (requires arg2 to also be string)</li>
1222 1224
   * <li>`null` - Passing null for arg1 allows you to save the object with options passed in arg2.</li>
1223 1225
   * </ul>
1224 -
   * @param {string | object} [options]
1226 +
   * @param {string | object} [arg2]
1225 1227
   * <ul>
1226 1228
   * <li>`String` Value - If arg1 was passed as a key, arg2 is the value that should be set on that key.</li>
1227 1229
   * <li>`Object` Options - Valid options are:
@@ -1235,7 +1237,7 @@
Loading
1235 1237
   * </ul>
1236 1238
   * </li>
1237 1239
   * </ul>
1238 -
   * @param {object} [options]
1240 +
   * @param {object} [arg3]
1239 1241
   * Used to pass option parameters to method if arg1 and arg2 were both passed as strings.
1240 1242
   * Valid options are:
1241 1243
   * <ul>
@@ -1246,9 +1248,6 @@
Loading
1246 1248
   * <li>cascadeSave: If `false`, nested objects will not be saved (default is `true`).
1247 1249
   * <li>context: A dictionary that is accessible in Cloud Code `beforeSave` and `afterSave` triggers.
1248 1250
   * </ul>
1249 -
   * @param arg1
1250 -
   * @param arg2
1251 -
   * @param arg3
1252 1251
   * @returns {Promise} A promise that is fulfilled when the save
1253 1252
   * completes.
1254 1253
   */
@@ -1480,6 +1479,7 @@
Loading
1480 1479
   *       or an array of array of strings.
1481 1480
   * </ul>
1482 1481
   * @static
1482 +
   * @returns {Parse.Object[]}
1483 1483
   */
1484 1484
  static fetchAll(list: Array<ParseObject>, options: RequestOptions = {}) {
1485 1485
    const queryOptions = {};
@@ -1526,6 +1526,7 @@
Loading
1526 1526
   *       behalf of a specific user.
1527 1527
   * </ul>
1528 1528
   * @static
1529 +
   * @returns {Parse.Object[]}
1529 1530
   */
1530 1531
  static fetchAllWithInclude(list: Array<ParseObject>, keys: String|Array<string|Array<string>>, options: RequestOptions) {
1531 1532
    options = options || {};
@@ -1561,6 +1562,7 @@
Loading
1561 1562
   *       behalf of a specific user.
1562 1563
   * </ul>
1563 1564
   * @static
1565 +
   * @returns {Parse.Object[]}
1564 1566
   */
1565 1567
  static fetchAllIfNeededWithInclude(list: Array<ParseObject>, keys: String|Array<string|Array<string>>, options: RequestOptions) {
1566 1568
    options = options || {};
@@ -1584,6 +1586,7 @@
Loading
1584 1586
   * @param {Array} list A list of <code>Parse.Object</code>.
1585 1587
   * @param {object} options
1586 1588
   * @static
1589 +
   * @returns {Parse.Object[]}
1587 1590
   */
1588 1591
  static fetchAllIfNeeded(list: Array<ParseObject>, options) {
1589 1592
    options = options || {};
@@ -1703,6 +1706,7 @@
Loading
1703 1706
   * @param {Array} list A list of <code>Parse.Object</code>.
1704 1707
   * @param {object} options
1705 1708
   * @static
1709 +
   * @returns {Parse.Object[]}
1706 1710
   */
1707 1711
  static saveAll(list: Array<ParseObject>, options: RequestOptions = {}) {
1708 1712
    const saveOptions = {};

@@ -28,8 +28,8 @@
Loading
28 28
   * Call this method first to set up your authentication tokens for Parse.
29 29
   *
30 30
   * @param {string} applicationId Your Parse Application ID.
31 -
   * @param {string} javaScriptKey (optional) Your Parse JavaScript Key (Not needed for parse-server)
32 -
   * @param {string} masterKey (optional) Your Parse Master Key. (Node.js only!)
31 +
   * @param {string} [javaScriptKey] Your Parse JavaScript Key (Not needed for parse-server)
32 +
   * @param {string} [masterKey] Your Parse Master Key. (Node.js only!)
33 33
   * @static
34 34
   */
35 35
  initialize(applicationId: string, javaScriptKey: string) {
@@ -78,23 +78,23 @@
Loading
78 78
   * @member {string} Parse.applicationId
79 79
   * @static
80 80
   */
81 -
  get applicationId() {
82 -
    return CoreManager.get('APPLICATION_ID');
83 -
  },
84 81
  set applicationId(value) {
85 82
    CoreManager.set('APPLICATION_ID', value);
86 83
  },
84 +
  get applicationId() {
85 +
    return CoreManager.get('APPLICATION_ID');
86 +
  },
87 87
88 88
  /**
89 89
   * @member {string} Parse.javaScriptKey
90 90
   * @static
91 91
   */
92 -
  get javaScriptKey() {
93 -
    return CoreManager.get('JAVASCRIPT_KEY');
94 -
  },
95 92
  set javaScriptKey(value) {
96 93
    CoreManager.set('JAVASCRIPT_KEY', value);
97 94
  },
95 +
  get javaScriptKey() {
96 +
    return CoreManager.get('JAVASCRIPT_KEY');
97 +
  },
98 98
99 99
  /**
100 100
   * @member {string} Parse.masterKey
@@ -248,6 +248,7 @@
Loading
248 248
 * Flag that indicates whether Local Datastore is enabled.
249 249
 *
250 250
 * @static
251 +
 * @returns {boolean}
251 252
 */
252 253
Parse.isLocalDatastoreEnabled = function() {
253 254
  return Parse.LocalDatastore.isEnabled;
@@ -260,6 +261,7 @@
Loading
260 261
 * </pre>
261 262
 *
262 263
 * @static
264 +
 * @returns {object}
263 265
 */
264 266
Parse.dumpLocalDatastore = function() {
265 267
  if (!Parse.LocalDatastore.isEnabled) {
@@ -284,6 +286,7 @@
Loading
284 286
 * Flag that indicates whether Encrypted User is enabled.
285 287
 *
286 288
 * @static
289 +
 * @returns {boolean}
287 290
 */
288 291
Parse.isEncryptedUserEnabled = function() {
289 292
  return Parse.encryptedUser;

@@ -38,10 +38,8 @@
Loading
38 38
  _longitude: number;
39 39
40 40
  /**
41 -
   * @param {(number[] | object | number)} options Either a list of coordinate pairs, an object with `latitude`, `longitude`, or the latitude or the point.
42 -
   * @param {number} longitude The longitude of the GeoPoint
43 -
   * @param arg1
44 -
   * @param arg2
41 +
   * @param {(number[] | object | number)} arg1 Either a list of coordinate pairs, an object with `latitude`, `longitude`, or the latitude or the point.
42 +
   * @param {number} arg2 The longitude of the GeoPoint
45 43
   */
46 44
  constructor(
47 45
    arg1: Array<number> |

@@ -35,8 +35,7 @@
Loading
35 35
  permissionsById: ByIdMap;
36 36
37 37
  /**
38 -
   * @param {(Parse.User | object)} user The user to initialize the ACL for
39 -
   * @param arg1
38 +
   * @param {(Parse.User | object)} arg1 The user to initialize the ACL for
40 39
   */
41 40
  constructor(arg1: ParseUser | ByIdMap) {
42 41
    this.permissionsById = {};

@@ -224,8 +224,7 @@
Loading
224 224
 */
225 225
class ParseQuery {
226 226
  /**
227 -
   * @property className
228 -
   * @type String
227 +
   * @property {string} className
229 228
   */
230 229
  className: string;
231 230
  _where: any;
@@ -1261,7 +1260,7 @@
Loading
1261 1260
   * be greater than or equal to the provided value.
1262 1261
   *
1263 1262
   * @param {string} key The key to check.
1264 -
   * @param value The value that provides an lower bound.
1263 +
   * @param {*} value The value that provides an lower bound.
1265 1264
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1266 1265
   */
1267 1266
  greaterThanOrEqualTo(key: string, value: mixed): ParseQuery {
@@ -1273,8 +1272,7 @@
Loading
1273 1272
   * be contained in the provided list of values.
1274 1273
   *
1275 1274
   * @param {string} key The key to check.
1276 -
   * @param {Array} values The values that will match.
1277 -
   * @param value
1275 +
   * @param {*} value The values that will match.
1278 1276
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1279 1277
   */
1280 1278
  containedIn(key: string, value: mixed): ParseQuery {
@@ -1286,8 +1284,7 @@
Loading
1286 1284
   * not be contained in the provided list of values.
1287 1285
   *
1288 1286
   * @param {string} key The key to check.
1289 -
   * @param {Array} values The values that will not match.
1290 -
   * @param value
1287 +
   * @param {*} value The values that will not match.
1291 1288
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1292 1289
   */
1293 1290
  notContainedIn(key: string, value: mixed): ParseQuery {
@@ -1300,11 +1297,10 @@
Loading
1300 1297
   *
1301 1298
   * @param {string} key The key to check.
1302 1299
   * @param {Array} values The values that will match.
1303 -
   * @param value
1304 1300
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1305 1301
   */
1306 -
  containedBy(key: string, value: Array<mixed>): ParseQuery {
1307 -
    return this._addCondition(key, '$containedBy', value);
1302 +
  containedBy(key: string, values: Array<mixed>): ParseQuery {
1303 +
    return this._addCondition(key, '$containedBy', values);
1308 1304
  }
1309 1305
1310 1306
  /**
@@ -1463,14 +1459,13 @@
Loading
1463 1459
   *
1464 1460
   * @param {string} key The key that the string to match is stored in.
1465 1461
   * @param {string} substring The substring that the value must contain.
1466 -
   * @param value
1467 1462
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1468 1463
   */
1469 -
  contains(key: string, value: string): ParseQuery {
1464 +
  contains(key: string, substring: string): ParseQuery {
1470 1465
    if (typeof value !== 'string') {
1471 1466
      throw new Error('The value being searched for must be a string.');
1472 1467
    }
1473 -
    return this._addCondition(key, '$regex', quote(value));
1468 +
    return this._addCondition(key, '$regex', quote(substring));
1474 1469
  }
1475 1470
1476 1471
  /**
@@ -1555,14 +1550,13 @@
Loading
1555 1550
   *
1556 1551
   * @param {string} key The key that the string to match is stored in.
1557 1552
   * @param {string} prefix The substring that the value must start with.
1558 -
   * @param value
1559 1553
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1560 1554
   */
1561 -
  startsWith(key: string, value: string): ParseQuery {
1555 +
  startsWith(key: string, prefix: string): ParseQuery {
1562 1556
    if (typeof value !== 'string') {
1563 1557
      throw new Error('The value being searched for must be a string.');
1564 1558
    }
1565 -
    return this._addCondition(key, '$regex', this._regexStartWith(value));
1559 +
    return this._addCondition(key, '$regex', this._regexStartWith(prefix));
1566 1560
  }
1567 1561
1568 1562
  /**
@@ -1571,14 +1565,13 @@
Loading
1571 1565
   *
1572 1566
   * @param {string} key The key that the string to match is stored in.
1573 1567
   * @param {string} suffix The substring that the value must end with.
1574 -
   * @param value
1575 1568
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1576 1569
   */
1577 -
  endsWith(key: string, value: string): ParseQuery {
1570 +
  endsWith(key: string, suffix: string): ParseQuery {
1578 1571
    if (typeof value !== 'string') {
1579 1572
      throw new Error('The value being searched for must be a string.');
1580 1573
    }
1581 -
    return this._addCondition(key, '$regex', quote(value) + '$');
1574 +
    return this._addCondition(key, '$regex', quote(suffix) + '$');
1582 1575
  }
1583 1576
1584 1577
  /**
@@ -1603,20 +1596,18 @@
Loading
1603 1596
   *
1604 1597
   * @param {string} key The key that the Parse.GeoPoint is stored in.
1605 1598
   * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
1606 -
   * @param {number} maxDistance Maximum distance (in radians) of results to
1607 -
   * return.
1608 -
   * @param distance
1599 +
   * @param {number} maxDistance Maximum distance (in radians) of results to return.
1609 1600
   * @param {boolean} sorted A Bool value that is true if results should be
1610 1601
   * sorted by distance ascending, false is no sorting is required,
1611 1602
   * defaults to true.
1612 1603
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1613 1604
   */
1614 -
  withinRadians(key: string, point: ParseGeoPoint, distance: number, sorted: boolean): ParseQuery {
1605 +
  withinRadians(key: string, point: ParseGeoPoint, maxDistance: number, sorted: boolean): ParseQuery {
1615 1606
    if (sorted || sorted === undefined) {
1616 1607
      this.near(key, point);
1617 -
      return this._addCondition(key, '$maxDistance', distance);
1608 +
      return this._addCondition(key, '$maxDistance', maxDistance);
1618 1609
    } else {
1619 -
      return this._addCondition(key, '$geoWithin', { '$centerSphere': [[point.longitude, point.latitude], distance] });
1610 +
      return this._addCondition(key, '$geoWithin', { '$centerSphere': [[point.longitude, point.latitude], maxDistance] });
1620 1611
    }
1621 1612
  }
1622 1613
@@ -1627,16 +1618,14 @@
Loading
1627 1618
   *
1628 1619
   * @param {string} key The key that the Parse.GeoPoint is stored in.
1629 1620
   * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
1630 -
   * @param {number} maxDistance Maximum distance (in miles) of results to
1631 -
   * return.
1632 -
   * @param distance
1621 +
   * @param {number} maxDistance Maximum distance (in miles) of results to return.
1633 1622
   * @param {boolean} sorted A Bool value that is true if results should be
1634 1623
   * sorted by distance ascending, false is no sorting is required,
1635 1624
   * defaults to true.
1636 1625
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1637 1626
   */
1638 -
  withinMiles(key: string, point: ParseGeoPoint, distance: number, sorted: boolean): ParseQuery {
1639 -
    return this.withinRadians(key, point, distance / 3958.8, sorted);
1627 +
  withinMiles(key: string, point: ParseGeoPoint, maxDistance: number, sorted: boolean): ParseQuery {
1628 +
    return this.withinRadians(key, point, maxDistance / 3958.8, sorted);
1640 1629
  }
1641 1630
1642 1631
  /**
@@ -1646,16 +1635,14 @@
Loading
1646 1635
   *
1647 1636
   * @param {string} key The key that the Parse.GeoPoint is stored in.
1648 1637
   * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
1649 -
   * @param {number} maxDistance Maximum distance (in kilometers) of results
1650 -
   * to return.
1651 -
   * @param distance
1638 +
   * @param {number} maxDistance Maximum distance (in kilometers) of results to return.
1652 1639
   * @param {boolean} sorted A Bool value that is true if results should be
1653 1640
   * sorted by distance ascending, false is no sorting is required,
1654 1641
   * defaults to true.
1655 1642
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1656 1643
   */
1657 -
  withinKilometers(key: string, point: ParseGeoPoint, distance: number, sorted: boolean): ParseQuery {
1658 -
    return this.withinRadians(key, point, distance / 6371.0, sorted);
1644 +
  withinKilometers(key: string, point: ParseGeoPoint, maxDistance: number, sorted: boolean): ParseQuery {
1645 +
    return this.withinRadians(key, point, maxDistance / 6371.0, sorted);
1659 1646
  }
1660 1647
1661 1648
  /**
@@ -1689,8 +1676,7 @@
Loading
1689 1676
   * Polygon must have at least 3 points
1690 1677
   *
1691 1678
   * @param {string} key The key to be constrained.
1692 -
   * @param {Array} array of geopoints
1693 -
   * @param points
1679 +
   * @param {Array} points Array of Coordinates / GeoPoints
1694 1680
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1695 1681
   */
1696 1682
  withinPolygon(key: string, points: Array<Array<number>>): ParseQuery {
@@ -1702,8 +1688,7 @@
Loading
1702 1688
   * coordinates that contains a ParseGeoPoint
1703 1689
   *
1704 1690
   * @param {string} key The key to be constrained.
1705 -
   * @param {Parse.GeoPoint} GeoPoint
1706 -
   * @param point
1691 +
   * @param {Parse.GeoPoint} point
1707 1692
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1708 1693
   */
1709 1694
  polygonContains(key: string, point: ParseGeoPoint): ParseQuery {
@@ -1715,9 +1700,8 @@
Loading
1715 1700
  /**
1716 1701
   * Sorts the results in ascending order by the given key.
1717 1702
   *
1718 -
   * @param {(String|String[]|...String)} key The key to order by, which is a
1703 +
   * @param {(string|string[])} keys The key to order by, which is a
1719 1704
   * string of comma separated values, or an Array of keys, or multiple keys.
1720 -
   * @param {...any} keys
1721 1705
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1722 1706
   */
1723 1707
  ascending(...keys: Array<string>): ParseQuery {
@@ -1729,9 +1713,8 @@
Loading
1729 1713
   * Sorts the results in ascending order by the given key,
1730 1714
   * but can also add secondary sort descriptors without overwriting _order.
1731 1715
   *
1732 -
   * @param {(String|String[]|...String)} key The key to order by, which is a
1716 +
   * @param {(string|string[])} keys The key to order by, which is a
1733 1717
   * string of comma separated values, or an Array of keys, or multiple keys.
1734 -
   * @param {...any} keys
1735 1718
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1736 1719
   */
1737 1720
  addAscending(...keys: Array<string>): ParseQuery {
@@ -1751,9 +1734,8 @@
Loading
1751 1734
  /**
1752 1735
   * Sorts the results in descending order by the given key.
1753 1736
   *
1754 -
   * @param {(String|String[]|...String)} key The key to order by, which is a
1737 +
   * @param {(string|string[])} keys The key to order by, which is a
1755 1738
   * string of comma separated values, or an Array of keys, or multiple keys.
1756 -
   * @param {...any} keys
1757 1739
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1758 1740
   */
1759 1741
  descending(...keys: Array<string>): ParseQuery {
@@ -1765,9 +1747,8 @@
Loading
1765 1747
   * Sorts the results in descending order by the given key,
1766 1748
   * but can also add secondary sort descriptors without overwriting _order.
1767 1749
   *
1768 -
   * @param {(String|String[]|...String)} key The key to order by, which is a
1750 +
   * @param {(string|string[])} keys The key to order by, which is a
1769 1751
   * string of comma separated values, or an Array of keys, or multiple keys.
1770 -
   * @param {...any} keys
1771 1752
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1772 1753
   */
1773 1754
  addDescending(...keys: Array<string>): ParseQuery {
@@ -1826,8 +1807,7 @@
Loading
1826 1807
   * Note that result of this query will be wrapped as an object with
1827 1808
   * `results`: holding {ParseObject} array and `count`: integer holding total number
1828 1809
   *
1829 -
   * @param {boolean} b false - disable, true - enable.
1830 -
   * @param includeCount
1810 +
   * @param {boolean} includeCount false - disable, true - enable.
1831 1811
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1832 1812
   */
1833 1813
  withCount(includeCount: boolean = true): ParseQuery {
@@ -1845,8 +1825,7 @@
Loading
1845 1825
   * Requires Parse Server 3.0.0+
1846 1826
   * <pre>query.include('*');</pre>
1847 1827
   *
1848 -
   * @param {...string | Array<string>} key The name(s) of the key(s) to include.
1849 -
   * @param {...any} keys
1828 +
   * @param {...string|Array<string>} keys The name(s) of the key(s) to include.
1850 1829
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1851 1830
   */
1852 1831
  include(...keys: Array<string|Array<string>>): ParseQuery {
@@ -1876,7 +1855,7 @@
Loading
1876 1855
   * provided keys.  If this is called multiple times, then all of the keys
1877 1856
   * specified in each of the calls will be included.
1878 1857
   *
1879 -
   * @param {...string | Array<string>} keys The name(s) of the key(s) to include.
1858 +
   * @param {...string|Array<string>} keys The name(s) of the key(s) to include.
1880 1859
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1881 1860
   */
1882 1861
  select(...keys: Array<string|Array<string>>): ParseQuery {
@@ -1899,7 +1878,7 @@
Loading
1899 1878
   *
1900 1879
   * Requires Parse Server 3.6.0+
1901 1880
   *
1902 -
   * @param {...string | Array<string>} keys The name(s) of the key(s) to exclude.
1881 +
   * @param {...string|Array<string>} keys The name(s) of the key(s) to exclude.
1903 1882
   * @returns {Parse.Query} Returns the query, so you can chain this call.
1904 1883
   */
1905 1884
  exclude(...keys: Array<string|Array<string>>): ParseQuery {
@@ -1958,8 +1937,7 @@
Loading
1958 1937
   * will create a compoundQuery that is an or of the query1, query2, and
1959 1938
   * query3.
1960 1939
   *
1961 -
   * @param {...Parse.Query} var_args The list of queries to OR.
1962 -
   * @param {...any} queries
1940 +
   * @param {...Parse.Query} queries The list of queries to OR.
1963 1941
   * @static
1964 1942
   * @returns {Parse.Query} The query that is the OR of the passed in queries.
1965 1943
   */
@@ -1978,8 +1956,7 @@
Loading
1978 1956
   * will create a compoundQuery that is an and of the query1, query2, and
1979 1957
   * query3.
1980 1958
   *
1981 -
   * @param {...Parse.Query} var_args The list of queries to AND.
1982 -
   * @param {...any} queries
1959 +
   * @param {...Parse.Query} queries The list of queries to AND.
1983 1960
   * @static
1984 1961
   * @returns {Parse.Query} The query that is the AND of the passed in queries.
1985 1962
   */
@@ -1998,8 +1975,7 @@
Loading
1998 1975
   * will create a compoundQuery that is a nor of the query1, query2, and
1999 1976
   * query3.
2000 1977
   *
2001 -
   * @param {...Parse.Query} var_args The list of queries to NOR.
2002 -
   * @param {...any} queries
1978 +
   * @param {...Parse.Query} queries The list of queries to NOR.
2003 1979
   * @static
2004 1980
   * @returns {Parse.Query} The query that is the NOR of the passed in queries.
2005 1981
   */

@@ -8,7 +8,6 @@
Loading
8 8
 *
9 9
 * @flow
10 10
 * @private
11 -
 * @internal
12 11
 */
13 12
14 13
import { isLocalDatastoreKey } from './LocalDatastoreUtils';

@@ -22,8 +22,9 @@
Loading
22 22
 * Return an array of unsaved children, which are either Parse Objects or Files.
23 23
 * If it encounters any dirty Objects without Ids, it will throw an exception.
24 24
 *
25 -
 * @param obj
26 -
 * @param allowDeepUnsaved
25 +
 * @param {Parse.Object} obj
26 +
 * @param {boolean} allowDeepUnsaved
27 +
 * @returns {Array}
27 28
 */
28 29
export default function unsavedChildren(
29 30
  obj: ParseObject,
Files Coverage
src 92.01%
Project Totals (54 files) 92.01%

No yaml found.

Create your codecov.yml to customize your Codecov experience

Sunburst
The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.
Icicle
The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.
Grid
Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.
Loading