summaryrefslogtreecommitdiff
path: root/date-fns/docs/constants.md
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/docs/constants.md')
-rw-r--r--date-fns/docs/constants.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/date-fns/docs/constants.md b/date-fns/docs/constants.md
new file mode 100644
index 0000000..b792fd7
--- /dev/null
+++ b/date-fns/docs/constants.md
@@ -0,0 +1,47 @@
+# Constants
+
+date-fns provides with a number of useful constants.
+
+## Usage
+
+The constants could be imported from `date-fns/constants` or directly
+from `date-fns`:
+
+```js
+import { maxTime } from 'date-fns/constants'
+import { minTime } from 'date-fns'
+
+function isAllowedTime(time) {
+ return time <= maxTime && time >= minTime
+}
+```
+
+## Constants
+
+### `maxTime`
+
+Maximum allowed time:
+
+```js
+import { maxTime } from 'date-fns'
+
+const isValid = 8640000000000001 <= maxTime
+//=> false
+
+new Date(8640000000000001)
+//=> Invalid Date
+```
+
+### `minTime`
+
+Minimum allowed time:
+
+```js
+import { minTime } from 'date-fns'
+
+const isValid = -8640000000000001 >= minTime
+//=> false
+
+new Date(-8640000000000001)
+//=> Invalid Date
+```