Skip to content
Merged
Changes from all commits
Commits
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
65 changes: 65 additions & 0 deletions packages/@rescript/runtime/Stdlib_WeakSet.res
Original file line number Diff line number Diff line change
@@ -1,10 +1,75 @@
/***
Bindings to JavaScript's `WeakSet`.

Weak sets store references to objects without preventing those objects from being garbage collected.
*/

/** Mutable weak set storing object references of type `'a`. */
@notUndefined
type t<'a>

/**
Creates an empty weak set.

See [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) on MDN.

## Examples

```rescript
let visited = WeakSet.make()
WeakSet.has(visited, Object.make()) == false
```
*/
@new external make: unit => t<'a> = "WeakSet"

/**
`add(set, value)` inserts `value` into the weak set and returns the set for chaining.

See [`WeakSet.prototype.add`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet/add) on MDN.

## Examples

```rescript
let set = WeakSet.make()
let node = Object.make()
WeakSet.add(set, node)
WeakSet.has(set, node) == true
```
*/
@send external add: (t<'a>, 'a) => t<'a> = "add"

/**
`delete(set, value)` removes `value` and returns `true` if an entry existed.

See [`WeakSet.prototype.delete`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet/delete) on MDN.

## Examples

```rescript
let set = WeakSet.make()
let node = Object.make()
let _ = WeakSet.add(set, node)
WeakSet.delete(set, node) == true
WeakSet.delete(set, node) == false
```
*/
@send external delete: (t<'a>, 'a) => bool = "delete"

/**
`has(set, value)` checks whether `value` exists in the weak set.

See [`WeakSet.prototype.has`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet/has) on MDN.

## Examples

```rescript
let set = WeakSet.make()
let node = Object.make()
WeakSet.has(set, node) == false
let _ = WeakSet.add(set, node)
WeakSet.has(set, node) == true
```
*/
@send external has: (t<'a>, 'a) => bool = "has"

/**
Expand Down
Loading