WeakMap docstrings

Author: fhammerschmidt

tests/gentype_tests/typescript-react-example/src/WeakMap.res

@@ -1 +1,82 @@
-type t<'k, 'v>
+/***
+Bindings to JavaScript's `WeakMap`.
+
+Weak maps store key/value pairs where keys must be objects and the pairs do not keep those keys alive for garbage collection.
+*/
+
+/**
+Mutable weak map storing values of type `'v` with object keys `'k`.
+*/
+type t<'k, 'v> = Stdlib_WeakMap.t<'k, 'v>
+
+/**
+Creates an empty weak map.
+
+See [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) on MDN.
+
+## Examples
+
+```rescript
+let cache: WeakMap.t<{..}, string> = WeakMap.make()
+```
+*/
+let make: unit => t<'k, 'v> = Stdlib_WeakMap.make
+
+/**
+`get(map, key)` returns `Some(value)` when `key` exists, otherwise `None`.
+
+## Examples
+
+```rescript
+let cache = WeakMap.make()
+let key = Stdlib_Object.make()
+WeakMap.get(cache, key) == None
+WeakMap.set(cache, key, "user")
+WeakMap.get(cache, key) == Some("user")
+```
+*/
+let get: (t<'k, 'v>, 'k) => option<'v> = Stdlib_WeakMap.get
+
+/**
+`has(map, key)` checks whether `key` exists in the weak map.
+
+## Examples
+
+```rescript
+let cache = WeakMap.make()
+let key = Stdlib_Object.make()
+WeakMap.has(cache, key) == false
+WeakMap.set(cache, key, 1)
+WeakMap.has(cache, key) == true
+```
+*/
+let has: (t<'k, 'v>, 'k) => bool = Stdlib_WeakMap.has
+
+/**
+`set(map, key, value)` stores `value` at `key`. Returns the map for chaining.
+
+## Examples
+
+```rescript
+let cache = WeakMap.make()
+let key = Stdlib_Object.make()
+WeakMap.set(cache, key, 42)
+WeakMap.get(cache, key) == Some(42)
+```
+*/
+let set: (t<'k, 'v>, 'k, 'v) => t<'k, 'v> = Stdlib_WeakMap.set
+
+/**
+`delete(map, key)` removes `key` and returns `true` if an entry was removed.
+
+## Examples
+
+```rescript
+let cache = WeakMap.make()
+let key = Stdlib_Object.make()
+WeakMap.set(cache, key, "value")
+WeakMap.delete(cache, key) == true
+WeakMap.delete(cache, key) == false
+```
+*/
+let delete: (t<'k, 'v>, 'k) => bool = Stdlib_WeakMap.delete