Skip to content

add docs for date module #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Feb 23, 2023
Merged

add docs for date module #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
783a5c9
add docs for date module (WIP)
dkirchhof Feb 20, 2023
8a55275
add docs for date module
dkirchhof Feb 20, 2023
f2f8414
Merge branch 'main' into docs-date
dkirchhof Feb 20, 2023
5a2306d
remove Date.valueOf, add more examples for Date.makeXY functions
dkirchhof Feb 21, 2023
19a8c48
update CHANGELOG
dkirchhof Feb 21, 2023
aa928f2
change type time to msSinceEpoch and add doc strings
dkirchhof Feb 21, 2023
977eb7c
add examples for utc make functions
dkirchhof Feb 21, 2023
34124d7
fix formatting
dkirchhof Feb 21, 2023
b31f63c
add more information about epoch
dkirchhof Feb 21, 2023
efd89bb
added disclaimer to examples and fixed one example and its output
dkirchhof Feb 21, 2023
eea4fcc
fixed formatting of date module
dkirchhof Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- Remove internal async/await helpers that do not need to be exposed in `Core`.
- Add locale and formatting options to `localeDateString`, `localeString` and `localTimeString` functions https://github.com/rescript-association/rescript-core/pull/30
- Change `RegExp.source` to return a `string`. Was previously returning a `bool`, which is wrong. https://github.com/rescript-association/rescript-core/pull/47
- Remove `Date.valueOf` as it returns the same as `Date.getTime`. https://github.com/rescript-association/rescript-core/pull/61

### Documentation

Expand All @@ -24,3 +25,4 @@
- Docstrings for `Int`. https://github.com/rescript-association/rescript-core/pull/37
- Docstrings for `Dict`. https://github.com/rescript-association/rescript-core/pull/40
- Docstrings for `RegExp`. https://github.com/rescript-association/rescript-core/pull/47
- Docstrings for `Date`. https://github.com/rescript-association/rescript-core/pull/61
23 changes: 11 additions & 12 deletions src/Core__Date.res
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
type t = Js.Date.t

type time = float
type msSinceEpoch = float

type localeOptions = {
dateStyle?: [#full | #long | #medium | #short],
Expand All @@ -16,11 +16,9 @@ type localeOptions = {
timeZoneName?: [#long | #short],
}

@send external valueOf: t => time = "valueOf"

@new external make: unit => t = "Date"
@new external fromString: string => t = "Date"
@new external fromTime: time => t = "Date"
@new external fromTime: msSinceEpoch => t = "Date"

@new external makeWithYM: (~year: int, ~month: int) => t = "Date"
@new external makeWithYMD: (~year: int, ~month: int, ~date: int) => t = "Date"
Expand Down Expand Up @@ -49,18 +47,19 @@ external makeWithYMDHMSM: (
) => t = "Date"

module UTC = {
@val external makeWithYM: (~year: int, ~month: int) => time = "Date.UTC"
@val external makeWithYMD: (~year: int, ~month: int, ~date: int) => time = "Date.UTC"
@val external makeWithYM: (~year: int, ~month: int) => msSinceEpoch = "Date.UTC"
@val external makeWithYMD: (~year: int, ~month: int, ~date: int) => msSinceEpoch = "Date.UTC"
@val
external makeWithYMDH: (~year: int, ~month: int, ~date: int, ~hours: int) => time = "Date.UTC"
external makeWithYMDH: (~year: int, ~month: int, ~date: int, ~hours: int) => msSinceEpoch =
"Date.UTC"
@val
external makeWithYMDHM: (
~year: int,
~month: int,
~date: int,
~hours: int,
~minutes: int,
) => time = "Date.UTC"
) => msSinceEpoch = "Date.UTC"
@val
external makeWithYMDHMS: (
~year: int,
Expand All @@ -69,7 +68,7 @@ module UTC = {
~hours: int,
~minutes: int,
~seconds: int,
) => time = "Date.UTC"
) => msSinceEpoch = "Date.UTC"
@val
external makeWithYMDHMSM: (
~year: int,
Expand All @@ -79,12 +78,12 @@ module UTC = {
~minutes: int,
~seconds: int,
~milliseconds: int,
) => time = "Date.UTC"
) => msSinceEpoch = "Date.UTC"
}

@val external now: unit => time = "Date.now"
@val external now: unit => msSinceEpoch = "Date.now"

@send external getTime: t => time = "getTime"
@send external getTime: t => msSinceEpoch = "getTime"
@send external getTimezoneOffset: t => int = "getTimezoneOffset"

// Locale
Expand Down
Loading