diff options
Diffstat (limited to 'date-fns/docs/Interval.js')
| -rw-r--r-- | date-fns/docs/Interval.js | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/date-fns/docs/Interval.js b/date-fns/docs/Interval.js new file mode 100644 index 0000000..15347b6 --- /dev/null +++ b/date-fns/docs/Interval.js @@ -0,0 +1,16 @@ +/** + * @category Types + * @summary An object that combines two dates to represent the time interval. + * + * @description + * An object that combines two dates to represent the time interval. + * + * @typedef {Object} Interval + * @property {Date|Number} start - the start of the interval + * @property {Date|Number} end - the end of the interval + * @throws {RangeError} The start of an interval cannot be after its end + * @throws {RangeError} Date in interval cannot be `Invalid Date` + */ +var Interval = {} + +module.exports = Interval |