@tellahq/rescript 10.1.4-republish-2 → 10.1.4-republish-3

package/lib/ocaml/js_float.ml

@@ -0,0 +1,294 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** Provide utilities for JS float. *)
+
+external _NaN : float = "NaN"
+  [@@bs.val]
+(**
+  The special value "Not a Number"
+
+  **See:** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN)
+*)
+
+external isNaN : float -> bool = "isNaN"
+  [@@bs.val] [@@bs.scope "Number"]
+(**
+  Tests if the given value is `_NaN`
+
+  Note that both `_NaN = _NaN` and `_NaN == _NaN` will return `false`. `isNaN` is
+  therefore necessary to test for `_NaN`.
+
+  **return** `true` if the given value is `_NaN`, `false` otherwise
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN)
+*)
+
+external isFinite : float -> bool = "isFinite"
+  [@@bs.val] [@@bs.scope "Number"]
+(**
+  Tests if the given value is finite
+
+  **return** `true` if the given value is a finite number, `false` otherwise
+
+  ```res example
+  /* returns [false] */
+  Js.Float.isFinite(infinity)
+
+  /* returns [false] */
+  Js.Float.isFinite(neg_infinity)
+
+  /* returns [false] */
+  Js.Float.isFinite(Js.Float._NaN)
+
+  /* returns [true] */
+  Js.Float.isFinite(1234.)
+  ```
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite)
+*)
+
+external toExponential : float -> string = "toExponential"
+  [@@bs.send]
+(**
+  Formats a `float` using exponential (scientific) notation
+
+  **return** a `string` representing the given value in exponential notation
+
+  **raise** RangeError if digits is not in the range [0, 20] (inclusive)
+
+  ```res example
+  /* prints "7.71234e+1" */
+  Js.Float.toExponential(77.1234)->Js.log
+
+  /* prints "7.7e+1" */
+  Js.Float.toExponential(77.)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential)
+*)
+
+external toExponentialWithPrecision : float -> digits:int -> string
+  = "toExponential"
+  [@@bs.send]
+(**
+  Formats a `float` using exponential (scientific) notation
+
+  **digits** specifies how many digits should appear after the decimal point. The
+  value must be in the range [0, 20] (inclusive).
+
+  **return** a `string` representing the given value in exponential notation
+
+  The output will be rounded or padded with zeroes if necessary.
+
+  **raise** RangeError if digits is not in the range [0, 20] (inclusive)
+
+  ```res example
+  /* prints "7.71e+1" */
+  Js.Float.toExponentialWithPrecision(77.1234, ~digits=2)->Js.log
+  ```
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential)
+*)
+
+external toFixed : float -> string = "toFixed"
+  [@@bs.send]
+(**
+  Formats a `float` using fixed point notation
+
+  **return** a `string` representing the given value in fixed-point notation (usually)
+
+  **raise** RangeError if digits is not in the range [0, 20] (inclusive)
+
+  ```res example
+  /* prints "12346" (note the rounding) */
+  Js.Float.toFixed(12345.6789)->Js.log
+
+  /* print "1.2e+21" */
+  Js.Float.toFixed(1.2e21)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed)
+*)
+
+external toFixedWithPrecision : float -> digits:int -> string = "toFixed"
+  [@@bs.send]
+(**
+  Formats a `float` using fixed point notation
+
+  **digits** specifies how many digits should appear after the decimal point. The
+  value must be in the range [0, 20] (inclusive). Defaults to `0`.
+
+  **return** a `string` representing the given value in fixed-point notation (usually)
+
+  The output will be rounded or padded with zeroes if necessary.
+
+  **raise** RangeError if digits is not in the range [0, 20] (inclusive)
+
+  ```res example
+  /* prints "12345.7" (note the rounding) */
+  Js.Float.toFixedWithPrecision(12345.6789, ~digits=1)->Js.log
+
+  /* prints "0.00" (note the added zeroes) */
+  Js.Float.toFixedWithPrecision(0., ~digits=2)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed)
+*)
+
+external toPrecision : float -> string = "toPrecision"
+  [@@bs.send]
+(**
+  Formats a `float` using some fairly arbitrary rules
+
+  **return** a `string` representing the given value in fixed-point (usually)
+
+  `toPrecision` differs from `toFixed` in that the former will format the number
+  with full precision, while the latter will not output any digits after the
+  decimal point.
+
+  **raise** RangeError if digits is not in the range accepted by this function (what do you mean "vague"?)
+
+  ```res example
+  /* prints "12345.6789" */
+  Js.Float.toPrecision(12345.6789)->Js.log
+
+  /* print "1.2e+21" */
+  Js.Float.toPrecision(1.2e21)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision)
+*)
+(* equivalent to `toString` I think *)
+
+external toPrecisionWithPrecision : float -> digits:int -> string
+  = "toPrecision"
+  [@@bs.send]
+(**
+  Formats a `float` using some fairly arbitrary rules
+
+  **digits** specifies how many digits should appear in total. The
+  value must between 0 and some arbitrary number that's hopefully at least larger
+  than 20 (for Node it's 21. Why? Who knows).
+
+  **return** a `string` representing the given value in fixed-point or scientific notation
+
+  The output will be rounded or padded with zeroes if necessary.
+
+  `toPrecisionWithPrecision` differs from `toFixedWithPrecision` in that the former
+  will count all digits against the precision, while the latter will count only
+  the digits after the decimal point. `toPrecisionWithPrecision` will also use
+  scientific notation if the specified precision is less than the number for digits
+  before the decimal point.
+
+  **raise** RangeError if digits is not in the range accepted by this function (what do you mean "vague"?)
+
+  ```res example
+  /* prints "1e+4" */
+  Js.Float.toPrecisionWithPrecision(12345.6789, ~digits=1)->Js.log
+
+  /* prints "0.0" */
+  Js.Float.toPrecisionWithPrecision(0., ~digits=2)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision)
+*)
+
+external toString : float -> string = "toString"
+  [@@bs.send]
+(**
+  Formats a `float` as a string
+
+  **return** a `string` representing the given value in fixed-point (usually)
+
+  ```res example
+  /* prints "12345.6789" */
+  Js.Float.toString(12345.6789)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString)
+*)
+
+external toStringWithRadix : float -> radix:int -> string = "toString"
+  [@@bs.send]
+(**
+  Formats a `float` as a string
+
+  **radix** specifies the radix base to use for the formatted number. The
+  value must be in the range [2, 36] (inclusive).
+
+  **return** a `string` representing the given value in fixed-point (usually)
+
+  **raise** RangeError if radix is not in the range [2, 36] (inclusive)
+
+  ```res example
+  /* prints "110" */
+  Js.Float.toStringWithRadix(6., ~radix=2)->Js.log
+
+  /* prints "11.001000111101011100001010001111010111000010100011111" */
+  Js.Float.toStringWithRadix(3.14, ~radix=2)->Js.log
+
+  /* prints "deadbeef" */
+  Js.Float.toStringWithRadix(3735928559., ~radix=16)->Js.log
+
+  /* prints "3f.gez4w97ry0a18ymf6qadcxr" */
+  Js.Float.toStringWithRadix(123.456, ~radix=36)->Js.log
+  ```
+
+  **See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString)
+*)
+
+external fromString : string -> float = "Number"
+  [@@bs.val]
+(**
+  Parses the given `string` into a `float` using JavaScript semantics
+
+  **return** the number as a `float` if successfully parsed, `_NaN` otherwise.
+
+  ```res example
+  /* returns 123 */
+  Js.Float.fromString("123")
+
+  /* returns 12.3 */
+  Js.Float.fromString("12.3")
+
+  /* returns 0 */
+  Js.Float.fromString("")
+
+  /* returns 17 */
+  Js.Float.fromString("0x11")
+
+  /* returns 3 */
+  Js.Float.fromString("0b11")
+
+  /* returns 9 */
+  Js.Float.fromString("0o11")
+
+  /* returns [_NaN] */
+  Js.Float.fromString("hello")
+
+  /* returns [_NaN] */
+  Js.Float.fromString("100a")
+  ```
+*)

package/lib/ocaml/js_global.ml

@@ -0,0 +1,185 @@
+(* Copyright (C) 2017 Hongbo Zhang, Authors of ReScript
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** Contains functions available in the global scope
+    (`window` in a browser context) *)
+
+type intervalId
+(** Identify an interval started by `Js.Global.setInterval`. *)
+
+type timeoutId
+(** Identify timeout started by `Js.Global.setTimeout`. *)
+
+external clearInterval : intervalId -> unit = "clearInterval"
+  [@@bs.val]
+(**
+Clear an interval started by `Js.Global.setInterval`
+
+```res example
+/* API for a somewhat aggressive snoozing alarm clock */
+
+let punchSleepyGuy = () => Js.log("Punch")
+
+let interval = ref(Js.Nullable.null)
+
+let remind = () => {
+  Js.log("Wake Up!")
+  punchSleepyGuy()
+}
+
+let snooze = mins =>
+  interval := Js.Nullable.return(Js.Global.setInterval(remind, mins * 60 * 1000))
+
+let cancel = () =>
+  Js.Nullable.iter(interval.contents, (. intervalId) => Js.Global.clearInterval(intervalId))
+```
+*)
+
+external clearTimeout : timeoutId -> unit = "clearTimeout"
+  [@@bs.val]
+(**
+Clear a timeout started by `Js.Global.setTimeout`.
+
+```res example
+/* A simple model of a code monkey's brain */
+
+let closeHackerNewsTab = () => Js.log("close")
+
+let timer = ref(Js.Nullable.null)
+
+let work = () => closeHackerNewsTab()
+
+let procrastinate = mins => {
+  Js.Nullable.iter(timer.contents, (. timer) => Js.Global.clearTimeout(timer))
+  timer := Js.Nullable.return(Js.Global.setTimeout(work, mins * 60 * 1000))
+}
+```
+*)
+
+external setInterval : (unit -> unit) -> int -> intervalId = "setInterval"
+  [@@bs.val]
+(**
+Repeatedly executes a callback with a specified interval (in milliseconds)
+between calls. Returns a `Js.Global.intervalId` that can be passed to
+`Js.Global.clearInterval` to cancel the timeout.
+
+```res example
+/* Will count up and print the count to the console every second */
+
+let count = ref(0)
+
+let tick = () => {
+  count := count.contents + 1
+  Js.log(Belt.Int.toString(count.contents))
+}
+
+Js.Global.setInterval(tick, 1000)
+```
+*)
+
+external setIntervalFloat : (unit -> unit) -> float -> intervalId
+  = "setInterval"
+  [@@bs.val]
+(**
+Repeatedly executes a callback with a specified interval (in milliseconds)
+between calls. Returns a `Js.Global.intervalId` that can be passed to
+`Js.Global.clearInterval` to cancel the timeout.
+
+```res example
+/* Will count up and print the count to the console every second */
+
+let count = ref(0)
+
+let tick = () => {
+  count := count.contents + 1
+  Js.log(Belt.Int.toString(count.contents))
+}
+
+Js.Global.setIntervalFloat(tick, 1000.0)
+```
+*)
+
+external setTimeout : (unit -> unit) -> int -> timeoutId = "setTimeout"
+  [@@bs.val]
+(**
+Execute a callback after a specified delay (in milliseconds). Returns a
+`Js.Global.timeoutId` that can be passed to `Js.Global.clearTimeout` to cancel
+the timeout.
+
+```res example
+/* Prints "Timed out!" in the console after one second */
+
+let message = "Timed out!"
+
+Js.Global.setTimeout(() => Js.log(message), 1000)
+```
+*)
+
+external setTimeoutFloat : (unit -> unit) -> float -> timeoutId = "setTimeout"
+  [@@bs.val]
+(**
+Execute a callback after a specified delay (in milliseconds). Returns a
+`Js.Global.timeoutId` that can be passed to `Js.Global.clearTimeout` to cancel
+the timeout.
+
+```res example
+/* Prints "Timed out!" in the console after one second */
+
+let message = "Timed out!"
+
+Js.Global.setTimeoutFloat(() => Js.log(message), 1000.0)
+```
+*)
+
+external encodeURI : string -> string = "encodeURI"
+  [@@bs.val]
+(**
+  URL-encodes a string.
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI)
+*)
+
+external decodeURI : string -> string = "decodeURI"
+  [@@bs.val]
+(**
+  Decodes a URL-enmcoded string produced by `encodeURI`
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI)
+*)
+
+external encodeURIComponent : string -> string = "encodeURIComponent"
+  [@@bs.val]
+(**
+  URL-encodes a string, including characters with special meaning in a URI.
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent)
+*)
+
+external decodeURIComponent : string -> string = "decodeURIComponent"
+  [@@bs.val]
+(**
+  Decodes a URL-enmcoded string produced by `encodeURIComponent`
+
+  **see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent)
+*)

package/lib/ocaml/js_int.ml

@@ -0,0 +1,158 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** Provide utilities for handling `int`. *)
+
+(*
+  If we use number, we need coerce to int32 by adding `|0`,
+  otherwise `+0` can be wrong.
+  Most JS API is float oriented, it may overflow int32 or
+  comes with `NAN`
+*)
+
+(* + conversion*)
+
+external toExponential : int -> string = "toExponential"
+  [@@bs.send]
+(**
+Formats an `int` using exponential (scientific) notation.
+Returns a `string` representing the given value in exponential notation.
+Raises `RangeError` if digits is not in the range \[0, 20\] (inclusive).
+
+**see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential)
+
+```res example
+/* prints "7.7e+1" */
+Js.log(Js.Int.toExponential(77))
+```
+*)
+
+external toExponentialWithPrecision : int -> digits:int -> string
+  = "toExponential"
+  [@@bs.send]
+(**
+Formats an `int` using exponential (scientific) notation.
+`digits` specifies how many digits should appear after the decimal point. The value must be in the range \[0, 20\] (inclusive).
+
+Returns a `string` representing the given value in exponential notation.
+
+The output will be rounded or padded with zeroes if necessary.
+Raises `RangeError` if `digits` is not in the range \[0, 20\] (inclusive).
+
+**see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential)
+
+```res example
+/* prints "7.70e+1" */
+Js.log(Js.Int.toExponentialWithPrecision(77, ~digits=2))
+
+/* prints "5.68e+3" */
+Js.log(Js.Int.toExponentialWithPrecision(5678, ~digits=2))
+```
+*)
+
+external toPrecision : int -> string = "toPrecision"
+  [@@bs.send]
+(**
+Formats an `int` using some fairly arbitrary rules.
+Returns a `string` representing the given value in fixed-point (usually).
+
+`toPrecision` differs from `toFixed` in that the former will format the number with full precision, while the latter will not output any digits after the decimal point.
+Raises `RangeError` if `digits` is not in the range accepted by this function.
+
+**See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision)
+
+```res example
+/* prints "123456789" */
+Js.log(Js.Int.toPrecision(123456789))
+```
+*)
+
+external toPrecisionWithPrecision : int -> digits:int -> string = "toPrecision"
+  [@@bs.send]
+(**
+Formats an `int` using some fairly arbitrary rules.
+`digits` specifies how many digits should appear in total. The value must between 0 and some arbitrary number that's hopefully at least larger than 20 (for Node it's 21. Why? Who knows).
+
+Returns a `string` representing the given value in fixed-point or scientific notation.
+
+The output will be rounded or padded with zeroes if necessary.
+
+`toPrecisionWithPrecision` differs from `toFixedWithPrecision` in that the former will count all digits against the precision, while the latter will count only the digits after the decimal point.
+`toPrecisionWithPrecision` will also use scientific notation if the specified precision is less than the number of digits before the decimal point.
+Raises `RangeError` if `digits` is not in the range accepted by this function.
+
+
+**See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision)
+
+```res example
+/* prints "1.2e+8" */
+Js.log(Js.Int.toPrecisionWithPrecision(123456789, ~digits=2))
+
+/* prints "0.0" */
+Js.log(Js.Int.toPrecisionWithPrecision(0, ~digits=2))
+```
+*)
+
+external toString : int -> string = "toString"
+  [@@bs.send]
+(**
+Formats an `int` as a `string`. Returns a `string` representing the given value
+in fixed-point (usually).
+
+**See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString)
+
+```res example
+/* prints "123456789" */
+Js.log(Js.Int.toString(123456789))
+```
+*)
+
+external toStringWithRadix : int -> radix:int -> string = "toString"
+  [@@bs.send]
+(**
+Formats an `int` as a `string`. `radix` specifies the radix base to use for the
+formatted number. The value must be in the range \[2, 36\] (inclusive). Returns
+a `string` representing the given value in fixed-point (usually). Raises
+`RangeError` if `radix` is not in the range \[2, 36\] (inclusive).
+
+
+**See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString)
+
+```res example
+/* prints "110" */
+Js.log(Js.Int.toStringWithRadix(6, ~radix=2))
+
+/* prints "deadbeef" */
+Js.log(Js.Int.toStringWithRadix(3735928559, ~radix=16))
+
+/* prints "2n9c" */
+Js.log(Js.Int.toStringWithRadix(123456, ~radix=36))
+```
+*)
+
+external toFloat : int -> float = "%floatofint"
+
+let equal (x : int) y = x = y
+let max : int = 2147483647
+let min : int = -2147483648