Js_obj.res

/* 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
*/

/** `empty()` returns the empty object `{}` */
@obj
external empty: unit => {..} = ""

/**
`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)

## Examples

```rescript
/* 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)
```
*/
@val
external assign: ({..}, {..}) => {..} = "Object.assign"

/* 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

   send:
   - hasOwnProperty
   - isPrototypeOf
   - propertyIsEnumerable
   - toLocaleString
   - toString

   Put directly on Js?
   - Object.is
*/

/** `keys(obj)` returns an `array` of the keys of `obj`'s own enumerable properties. */
@val
external keys: {..} => array<string> = "Object.keys"