Skip to content

Commit 163745e

Browse files
davimacedomtrezza
andauthored
Fix doc build (#1384)
* Fix doc build * neat * completed docs Co-authored-by: Manuel Trezza <[email protected]>
1 parent 6152423 commit 163745e

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

src/OfflineQuery.js

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,21 @@ function equalObjectsGeneric(obj, compareTo, eqlFn) {
8181
}
8282

8383
/**
84-
* Converts human readable relative date string
85-
* ie: 'in 10 days' to a date relative to now
84+
* @typedef RelativeTimeToDateResult
85+
* @property {string} status The conversion status, `error` if conversion failed or
86+
* `success` if conversion succeeded.
87+
* @property {string} info The error message if conversion failed, or the relative
88+
* time indication (`past`, `present`, `future`) if conversion succeeded.
89+
* @property {Date|undefined} result The converted date, or `undefined` if conversion
90+
* failed.
91+
*/
92+
/**
93+
* Converts human readable relative date string, for example, 'in 10 days' to a date
94+
* relative to now.
8695
*
87-
* @param {*} text
88-
* @param {*} now
89-
* @returns {status,info,result}
90-
* copied from parse-server/src/Adapters/Storage/Mongo/MongoTransform.js
96+
* @param {string} text The text to convert.
97+
* @param {Date} [now=new Date()] The date from which add or subtract. Default is now.
98+
* @returns {RelativeTimeToDateResult}
9199
*/
92100
function relativeTimeToDate(text, now = new Date()) {
93101
text = text.toLowerCase();

0 commit comments

Comments
 (0)