Skip to content

Add docstring for Null.compare and Null.equal #7562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 18, 2025
Merged

Add docstring for Null.compare and Null.equal #7562

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a9268e
Add docstring for Null.compare and Null.equal
nojaf Jun 18, 2025
90b7f79
Use ==
nojaf Jun 18, 2025
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
35 changes: 35 additions & 0 deletions runtime/Stdlib_Null.resi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,43 @@ let asNullValue = myStr->Null.make // The compiler now thinks this can be `strin
*/
external make: 'a => t<'a> = "%identity"

/**
`equal(a, b, eq)` checks if `a` and `b` are equal.
If both are `Null.Value`, it will use function `eq` to check if the values are equal.

## Examples
```rescript
let a = Null.Value(1)
let b = Null.null
let c = Null.Value(2)

Null.equal(a, b, Int.equal) == false
Null.equal(a, c, Int.equal) == false
Null.equal(Null.null, Null.null, Int.equal) == true
```
*/
let equal: (t<'a>, t<'b>, ('a, 'b) => bool) => bool

/**
`compare(a, b, cmp)` compares `a` and `b`.
If both are `Null.Value`, it will use function `cmp` to compare the values.

## Examples
```rescript
let a = Null.Value(1)
let b = Null.null
let c = Null.Value(2)

// A value is greater than null
Null.compare(a, b, Int.compare) == Stdlib_Ordering.greater
// A value is less than null
Null.compare(b, a, Int.compare) == Stdlib_Ordering.less
// A null is equal to null
Null.compare(Null.null, Null.null, Int.compare) == Stdlib_Ordering.equal
// The compare function is used if both are `Null.Value`
Null.compare(a, c, Int.compare) == Stdlib_Ordering.less
```
*/
let compare: (t<'a>, t<'b>, ('a, 'b) => Stdlib_Ordering.t) => Stdlib_Ordering.t

/**
Expand Down