@tellahq/rescript 10.1.0-alpha.2 → 10.1.4-republish-2

package/lib/ocaml/js_null.mli

@@ -1,87 +0,0 @@
-(* 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. *)
-
-(** Provides functionality for dealing with the `'a Js.null` type *)
-
-(** Provides functionality for dealing with the `Js.null('a)` type *)
-
-type +'a t = 'a Js.null
-(** Local alias for `Js.null('a)` *)
-
-external return : 'a -> 'a t = "%identity"
-(** Constructs a value of `Js.null('a)` containing a value of `'a`. *)
-
-val test : 'a t -> bool
-  [@@deprecated "Use = Js.null directly "]
-(** Returns `true` if the given value is empty (`null`), `false` otherwise. *)
-
-external empty : 'a t = "#null"
-(** The empty value, `null` *)
-
-external getUnsafe : 'a t -> 'a = "%identity"
-val getExn : 'a t -> 'a
-
-val bind : 'a t -> (('a -> 'b)[@bs]) -> 'b t
-(**
-Maps the contained value using the given function.
-
-If `Js.null('a)` contains a value, that value is unwrapped, mapped to a `'b`
-using the given function `'a => 'b`, then wrapped back up and returned as
-`Js.null('b)`.
-
-```res example
-let maybeGreetWorld = (maybeGreeting: Js.null<string>) =>
-  Js.Null.bind(maybeGreeting, (. greeting) => greeting ++ " world!")
-```
-*)
-
-val iter : 'a t -> (('a -> unit)[@bs]) -> unit
-(**
-Iterates over the contained value with the given function.
-If `Js.null('a)` contains a value, that value is unwrapped and applied to the given function.
-
-```res example
-let maybeSay = (maybeMessage: Js.null<string>) =>
-  Js.Null.iter(maybeMessage, (. message) => Js.log(message))
-```
-*)
-
-val fromOption : 'a option -> 'a t
-(**
-Maps `option('a)` to `Js.null('a)`.
-`Some(a)` => `a`
-`None` => `empty`
-*)
-
-val from_opt : 'a option -> 'a t [@@deprecated "Use fromOption instead"]
-
-external toOption : 'a t -> 'a option = "#null_to_opt"
-(**
-Maps `Js.null('a)` to `option('a)`.
-`a` => `Some(a)`
-`empty` => `None`
-*)
-
-external to_opt : 'a t -> 'a option = "#null_to_opt"
-  [@@deprecated "Use toOption instead"]

package/lib/ocaml/js_null_undefined.ml

@@ -1,50 +0,0 @@
-(* 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. *)
-
-(** Contains functionality for dealing with values that can be both `null` and `undefined` *)
-
-type + 'a t = 'a Js.nullable
-external toOption : 'a t -> 'a option = "#nullable_to_opt"
-external to_opt : 'a t -> 'a option = "#nullable_to_opt"
-external return : 'a -> 'a t = "%identity"
-external isNullable : 'a t -> bool =  "#is_nullable"
-external null : 'a t = "#null"
-external undefined : 'a t = "#undefined"
-
-let bind x f =
-  match to_opt x with
-  | None -> (Obj.magic (x: 'a t): 'b t)
-  | Some x -> return (f x [@bs])
-
-let iter x f =
-  match to_opt x with
-  | None -> ()
-  | Some x -> f x [@bs]
-
-let fromOption x =
-  match x with
-  | None -> undefined
-  | Some x -> return x
-
-let from_opt = fromOption

package/lib/ocaml/js_null_undefined.mli

@@ -1,85 +0,0 @@
-(* 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. *)
-
-(** Contains functionality for dealing with values that can be both `null` and `undefined` *)
-
-type +'a t = 'a Js.null_undefined
-(** Local alias for `Js.null_undefined('a)`. *)
-
-external return : 'a -> 'a t = "%identity"
-(** Constructs a value of `Js.null_undefined('a)` containing a value of `'a`. *)
-
-external isNullable : 'a t -> bool = "#is_nullable"
-(** Returns `true` if the given value is null or undefined, `false` otherwise. *)
-
-external null : 'a t = "#null"
-(** The null value of type `Js.null_undefined('a)`. *)
-
-external undefined : 'a t = "#undefined"
-(** The undefined value of type `Js.null_undefined('a)`. *)
-
-val bind : 'a t -> (('a -> 'b)[@bs]) -> 'b t
-(**
-Maps the contained value using the given function.
-
-If `Js.null_undefined('a)` contains a value, that value is unwrapped, mapped to
-a `'b` using the given function `a' => 'b`, then wrapped back up and returned
-as `Js.null_undefined('b)`.
-
-```res example
-let maybeGreetWorld = (maybeGreeting: Js.null_undefined<string>) =>
-  Js.Null_undefined.bind(maybeGreeting, (. greeting) => greeting ++ " world!")
-```
-*)
-
-val iter : 'a t -> (('a -> unit)[@bs]) -> unit
-(**
-Iterates over the contained value with the given function.
-If `Js.null_undefined('a)` contains a value, that value is unwrapped and applied to the given function.
-
-```res example
-let maybeSay = (maybeMessage: Js.null_undefined<string>) =>
-  Js.Null_undefined.iter(maybeMessage, (. message) => Js.log(message))
-```
-*)
-
-val fromOption : 'a option -> 'a t
-(**
-Maps `option('a)` to `Js.null_undefined('a)`.
-`Some(a)` => `a`
-`None` => `undefined`
-*)
-
-val from_opt : 'a option -> 'a t [@@deprecated "Use fromOption instead"]
-
-external toOption : 'a t -> 'a option = "#nullable_to_opt"
-(**
-Maps `Js.null_undefined('a)` to `option('a)`.
-`a` => `Some(a)`
-`undefined` => `None`
-`null` => `None`
-*)
-
-external to_opt : 'a t -> 'a option = "#nullable_to_opt"
-  [@@deprecated "Use toOption instead"]

package/lib/ocaml/js_obj.ml

@@ -1,100 +0,0 @@
-(* 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. *)
-
-(** Provides functions for inspecting and manipulating native JavaScript objects *)
-
-external empty : unit -> < .. > = ""
-  [@@bs.obj]
-(** `empty()` returns the empty object `{}` *)
-
-external assign : < .. > -> < .. > -> < .. > = "Object.assign"
-  [@@bs.val]
-(**
-`assign(target, source)` copies properties from source to target.
-Properties in `target` will be overwritten by properties in `source` if they have the same key.
-Returns `target`.
-
-**See** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
-
-```res example
-/* Copy an object */
-
-let obj = {"a": 1}
-
-let copy = Js.Obj.assign(Js.Obj.empty(), obj)
-
-/* prints "{ a: 1 }" */
-Js.log(copy)
-
-/* Merge objects with same properties */
-
-let target = {"a": 1, "b": 1}
-let source = {"b": 2}
-
-let obj = Js.Obj.assign(target, source)
-
-/* prints "{ a: 1, b: 2 }" */
-Js.log(obj)
-
-/* prints "{ a: 1, b: 2 }", target is modified */
-Js.log(target)
-```
-*)
-
-(* TODO:
-
-   Should we map this API as directly as possible, provide some abstractions, or deliberately nerf it?
-
-   "static":
-   - Object.create
-   - Object.defineProperty
-   - Object.defineProperties
-   - Object.entries - experimental
-   - Object.getOwnPropertyDescriptor
-   - Object.getOwnPropertyDescriptors
-   - Object.getOwnPropertyNames
-   - Object.getOwnPropertySymbols
-   - Object.getPrototypeOf
-   - Object.isExtensible
-   - Object.isFrozen
-   - Object.isSealed
-   - Object.preventExtension
-   - Object.seal
-   - Object.setPrototypeOf
-   - Object.values - experimental
-
-   bs.send:
-   - hasOwnProperty
-   - isPrototypeOf
-   - propertyIsEnumerable
-   - toLocaleString
-   - toString
-
-   Put directly on Js?
-   - Object.is
-*)
-
-external keys : < .. > -> string array = "Object.keys"
-  [@@bs.val]
-(** `keys(obj)` returns an `array` of the keys of `obj`'s own enumerable properties. *)

package/lib/ocaml/js_option.ml

@@ -1,203 +0,0 @@
-(* 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 `option`. *)
-
-(**
-  `Js.Option.t` is an alias for `option`
-*)
-type 'a t = 'a option
-
-(**
-  Wraps the given value in `Some()`
-
-  ```res example
-  Js.Option.some(1066) == Some(1066)
-  ```
-*)
-let some x = Some x 
-
-(**
-  Returns `true` if the argument is `Some(value)`; `false` if the argument is
-  `None`.
-*)
-let isSome = function
-  | None -> false
-  | Some _ -> true
-
-(**
-  The first argument to `isSomeValue` is an uncurried function `eq()` that
-  takes two arguments and returns `true` if they are considered to be equal. It
-  is used to compare a plain value `v1`(the second argument) with an `option`
-  value. If the `option` value is `None`, `isSomeValue()` returns `false`; if
-  the third argument is `Some(v2)`, `isSomeValue()` returns the result of
-  calling `eq(v1, v2)`.
-
-  ```res example
-  let clockEqual = (. a, b) => mod(a, 12) == mod(b, 12)
-  Js.Option.isSomeValue(clockEqual, 3, Some(15)) == true
-  Js.Option.isSomeValue(clockEqual, 3, Some(4)) == false
-  Js.Option.isSomeValue(clockEqual, 3, None) == false
-  ```
-*)
-let isSomeValue eq v x =
-  match x with 
-  | None -> false 
-  | Some x -> eq v x [@bs]
-
-(** Returns `true` if the argument is `None`; `false` otherwise. *)
-let isNone = function
-  | None -> true
-  | Some _ -> false
-
-(**
-  If the argument to `getExn()` is of the form `Some(value)`, returns `value`.
-  If given `None`, it throws a `getExn` exception.
-*)
-let getExn x =
-  match x with 
-  | None -> Js_exn.raiseError "getExn"
-  | Some x -> x 
-
-(**
-  The first argument to `equal` is an uncurried function `eq()` that takes two
-  arguments and returns `true` if they are considered to be equal. The second
-and third arguments are `option` values.
-
-  If the second and third arguments are of the form:
-
-  * `Some(v1)` and `Some(v2)`: returns `eq(v1, v2)`
-  * `Some(v1)` and `None`: returns `false`
-  * `None` and `Some(v2)`: returns `false`
-  * `None` and `None`: returns `true`
-
-  ```res example
-  let clockEqual = (. a, b) => mod(a, 12) == mod(b, 12)
-  Js.Option.equal(clockEqual, Some(3), Some(15)) == true
-  Js.Option.equal(clockEqual, Some(3), Some(16)) == false
-  Js.Option.equal(clockEqual, Some(3), None) == false
-  Js.Option.equal(clockEqual, None, Some(15)) == false
-  Js.Option.equal(clockEqual, None, None) == true
-  ```
-*)
-let equal eq a b =
-  match a  with 
-  | None -> b = None 
-  | Some x -> 
-    begin match b with 
-    | None -> false 
-    | Some y -> eq x y [@bs]
-    end
-
-(**
-  The first argument to `andThen()` is an uncurried function `f()` that takes a
-  plain value and returns an `option` result. The second argument is an
-  `option` value. If the second argument is `None`, the return value is `None`.
-  If the second argument is `Some(v)`, the return value is `f(v)`.
-
-  ```res example
-  let reciprocal = (. x) => x == 0 ? None : Some(1.0 /. Belt.Int.toFloat(x))
-  Js.Option.andThen(reciprocal, Some(5)) == Some(0.2)
-  Js.Option.andThen(reciprocal, Some(0)) == None
-  Js.Option.andThen(reciprocal, None) == None
-  ```
-*)
-let andThen f x =
-  match x with 
-  | None -> None 
-  | Some x -> f x [@bs]
-
-(**
-  The first argument to `map()` is an uncurried function `f()` that takes a
-  plain value and returns a plain result. The second argument is an `option`
-  value. If it is of the form `Some(v)`, `map()` returns `Some(f(v))`; if it is
-  `None`, the return value is `None`, and function `f()` is not called.
-
-  ```res example
-  let square = (. x) => x * x
-  Js.Option.map(square, Some(3)) == Some(9)
-  Js.Option.map(square, None) == None
-  ```
-*)
-let map f x =
-  match x with
-  | None -> None
-  | Some x -> Some (f x [@bs])
-
-(**
-  The first argument to `getWithDefault()` is a default value. If the second
-  argument is of the form `Some(v)`, `getWithDefault()` returns `v`; if the
-  second argument is `None`, the return value is the default value.
-
-  ```res example
-  Js.Option.getWithDefault(1066, Some(15)) == 15
-  Js.Option.getWithDefault(1066, None) == 1066
-  ```
-*)
-let getWithDefault a x =
-  match x with
-  | None -> a
-  | Some x -> x
-
-(** **See:** [getWithDefault](#getWithDefault) *)
-let default = getWithDefault  
-
-(**
-  The first argument to `filter()` is an uncurried function that takes a plain
-  value and returns a boolean. The second argument is an `option` value.
-
-  If the second argument is of the form `Some(v)` and `f(v)` is `true`,
-  the return value is `Some(v)`. Otherwise, the return value is `None`.
-
-  ```res example
-  let isEven = (. x) => mod(x, 2) == 0
-  Js.Option.filter(isEven, Some(2)) == Some(2)
-  Js.Option.filter(isEven, Some(3)) == None
-  Js.Option.filter(isEven, None) == None
-  ```
-*)
-let filter f x =
-  match x with
-  | None -> None
-  | Some x -> 
-    if f x [@bs] then
-      Some x
-    else
-      None
-
-(**
-  The `firstSome()` function takes two `option` values; if the first is of the form `Some(v1)`, that is the return value. Otherwise, `firstSome()` returns the second value.
-
-  ```res example
-  Js.Option.firstSome(Some("one"), Some("two")) == Some("one")
-  Js.Option.firstSome(Some("one"), None) == Some("one")
-  Js.Option.firstSome(None, Some("two")) == Some("two")
-  Js.Option.firstSome(None, None) == None
-  ```
-*)
-let firstSome a b =
-  match (a, b) with
-  | (Some _, _) -> a
-  | (None, Some _) -> b
-  | (None, None) -> None

package/lib/ocaml/js_option.mli

@@ -1,52 +0,0 @@
-(* 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. *)
-
-type 'a t = 'a option
-
-val some : 'a -> 'a option
-
-val isSome : 'a option -> bool
-
-val isSomeValue : ('a -> 'a -> bool [@bs]) -> 'a -> 'a option -> bool
-
-val isNone : 'a option -> bool
-
-val getExn : 'a option -> 'a
-
-val equal : ('a -> 'b -> bool [@bs]) -> 'a option -> 'b option -> bool
-
-val andThen : ('a -> 'b option [@bs]) -> 'a option -> 'b option
-
-val map : ('a -> 'b [@bs]) -> 'a option -> 'b option
-
-
-val getWithDefault :  'a -> 'a option -> 'a
-
-val default : 'a -> 'a option -> 'a
-[@@deprecated "Use `getWithDefault` instead since default has special meaning in ES module"]
-
-
-val filter : ('a -> bool [@bs]) -> 'a option -> 'a option
-
-val firstSome : 'a option -> 'a option -> 'a option