aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/world/time/instant.lux
blob: b06126fc87810a9b6ba600c4b8fec58e1c9aa2bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
(.require
 [library
  [lux (.except and)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.of_millis)
             ($.default /.millis)
             ($.default /.equivalence)
             ($.default /.order)
             ($.default /.enum)
             ($.default /.date)
             ($.default /.time)
             ($.default /.day_of_week)

             ($.definition /.Instant
               "Instant is defined as milli-seconds since the epoch.")

             ($.definition /.span
               ""
               [(span from to)])

             ($.definition /.after
               ""
               [(after duration instant)])

             ($.definition /.relative
               ""
               [(relative instant)])

             ($.definition /.absolute
               ""
               [(absolute offset)])

             ($.definition /.epoch
               "The instant corresponding to 1970-01-01T00:00:00Z.")

             ($.definition /.codec
               (format "Based on ISO 8601."
                       \n "For example: 2017-01-15T21:14:51.827Z"))

             ($.definition /.now
               "Yields the current instant, as measured from the operating-system's clock.")

             ($.definition /.of_date_time
               ""
               [(of_date_time date time)])]
            []))