Skip to content

Add Intl.RelativeTimeFormat #2070

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+113 −0
Open

Add Intl.RelativeTimeFormat #2070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c482d26
add Intl.RelativeTime
toastal Jul 4, 2025
ff26cf0
attempt comment test?
toastal Jul 4, 2025
36dc208
update CHANGES
toastal Jul 4, 2025
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
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
* Ppx: allow "function" in object literals (#1897)
* Lib: add Dom_html.window.matchMedia & Dom_html.mediaQueryList (#2017)
* Lib: make the Wasm version of Json.output work with native ints and JavaScript objects (#1872)
* Lib: add Intl.RelativeDateFormat (#2070)

## Bug fixes
* Compiler: fix stack overflow issues with double translation (#1869)
Expand Down
55 changes: 55 additions & 0 deletions lib/js_of_ocaml/intl.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,57 @@ module PluralRules = struct
end
end

module RelativeTimeFormat = struct
include Shared

class type resolved_options = object
method locale : Js.js_string Js.t Js.readonly_prop

method style : Js.js_string Js.t Js.readonly_prop

method numberingSystem : Js.js_string Js.t Js.readonly_prop

method numeric : Js.js_string Js.t Js.readonly_prop
end

class type options = object
method localeMatcher : Js.js_string Js.t Js.prop

method numberingSystem : Js.js_string Js.t Js.optdef Js.prop

method style : Js.js_string Js.t Js.optdef Js.prop

method numeric : Js.js_string Js.t Js.optdef Js.prop
end

let options () : options Js.t =
object%js
val mutable localeMatcher = Js.string "best fit"

val mutable style = Js.undefined

val mutable numberingSystem = Js.undefined

val mutable numeric = Js.undefined
end

class type format_part = object
method _type : Js.js_string Js.t Js.readonly_prop

method _value : Js.js_string Js.t Js.readonly_prop
end

class type t = object
method format :
(Js.number Js.t -> Js.js_string Js.t -> Js.js_string Js.t) Js.readonly_prop

method formatToParts :
Js.date Js.t Js.optdef -> format_part Js.t Js.js_array Js.t Js.meth

method resolvedOptions : unit -> resolved_options Js.t Js.meth
end
end

class type intl = object
method _Collator : Collator._object Js.t Js.readonly_prop

Expand All @@ -422,6 +473,8 @@ class type intl = object

method _PluralRules : PluralRules._object Js.t Js.readonly_prop

method _RelativeTimeFormat : RelativeTimeFormat._object Js.t Js.readonly_prop

method getCanonicalLocales :
Js.js_string Js.t Js.js_array Js.t -> Js.js_string Js.t Js.js_array Js.t Js.meth
end
Expand All @@ -436,4 +489,6 @@ let numberFormat_constr = Js.Unsafe.global##._Intl##._NumberFormat

let pluralRules_constr = Js.Unsafe.global##._Intl##._PluralRules

let relativeTimeFormat_constr = Js.Unsafe.global##._Intl##._RelativeTimeFormat

let is_supported () = Js.Optdef.test intl
57 changes: 57 additions & 0 deletions lib/js_of_ocaml/intl.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,9 +346,16 @@ then (
(intl##._PluralRules##supportedLocalesOf
(jas [| "ban"; "id-u-co-pinyin"; "de-ID" |])
(def options))
let options = Intl.RelativeTimeFormat.options () in
let () = options##.numeric := "auto" in
let () = options##.style := "short" in
Comment on lines +351 to +352
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
let () = options##.numeric := "auto" in
let () = options##.style := "short" in
let () = options##.numeric := def (string "auto") in
let () = options##.style := def (string "short") in

let th_rtf = new%js Intl.relativeTimeFormat_constr (def (jas [| "th-TH" |])) options in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
let th_rtf = new%js Intl.relativeTimeFormat_constr (def (jas [| "th-TH" |])) options in
let th_rtf = new%js Intl.relativeTimeFormat_constr (def (jas [| "th-TH" |])) (def options) in

fc (th_rtf.format -1 "day");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct

with Error err -> Console.console##debug (string (string_of_error err)))
else Console.console##debug (string "Intl is not supported!")
]}
@see <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl> for API documentation.
@see <https://www.ecma-international.org/ecma-402/1.0/> for the ECMAScript specification. *)

Expand Down Expand Up @@ -627,6 +634,48 @@ module PluralRules : sig
end
end

module RelativeTimeFormat : sig
include Shared

class type resolved_options = object
method locale : Js.js_string Js.t Js.readonly_prop

method style : Js.js_string Js.t Js.readonly_prop

method numberingSystem : Js.js_string Js.t Js.readonly_prop

method numeric : Js.js_string Js.t Js.readonly_prop
end

class type options = object
method localeMatcher : Js.js_string Js.t Js.prop

method numberingSystem : Js.js_string Js.t Js.optdef Js.prop

method style : Js.js_string Js.t Js.optdef Js.prop

method numeric : Js.js_string Js.t Js.optdef Js.prop
end

val options : unit -> options Js.t

class type format_part = object
method _type : Js.js_string Js.t Js.readonly_prop

method _value : Js.js_string Js.t Js.readonly_prop
end

class type t = object
method format :
(Js.number Js.t -> Js.js_string Js.t -> Js.js_string Js.t) Js.readonly_prop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this a readonly_prop and not a method ?


method formatToParts :
Js.date Js.t Js.optdef -> format_part Js.t Js.js_array Js.t Js.meth
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This signature is not correct. this method takes a number and a string


method resolvedOptions : unit -> resolved_options Js.t Js.meth
end
end

class type intl = object
method _Collator : Collator._object Js.t Js.readonly_prop

Expand All @@ -636,6 +685,8 @@ class type intl = object

method _PluralRules : PluralRules._object Js.t Js.readonly_prop

method _RelativeTimeFormat : RelativeTimeFormat._object Js.t Js.readonly_prop

method getCanonicalLocales :
Js.js_string Js.t Js.js_array Js.t -> Js.js_string Js.t Js.js_array Js.t Js.meth
end
Expand Down Expand Up @@ -666,4 +717,10 @@ val pluralRules_constr :
-> PluralRules.t Js.t)
Js.constr

val relativeTimeFormat_constr :
( Js.js_string Js.t Js.js_array Js.t Js.optdef
-> RelativeTimeFormat.options Js.t Js.optdef
-> RelativeTimeFormat.t Js.t)
Js.constr

val is_supported : unit -> bool
Loading