Skip to content
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

Mention ignoreErrors in nullable's documentation #3139

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Mention ignoreErrors in nullable's documentation #3139

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
850d184
Mention ignoreErrors in nullable's documentation
CLOVIS-AI Oct 11, 2023
a5fc6ea
Merge branch 'main' into 3138-nullable-ignore-errors
nomisRev Oct 17, 2023
75779ba
Merge branch 'main' into 3138-nullable-ignore-errors
serras Oct 19, 2023
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
3 changes: 3 additions & 0 deletions arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Builders.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ public inline fun <Error, A> either(@BuilderInference block: Raise<Error>.() ->
*
* Read more about running a [Raise] computation in the
* [Arrow docs](https://arrow-kt.io/learn/typed-errors/working-with-typed-errors/#running-and-inspecting-results).
*
* @see NullableRaise.ignoreErrors By default, `nullable` only allows raising `null`.
* Calling [ignoreErrors][NullableRaise.ignoreErrors] inside `nullable` allows to raise any error, which will be returned to the caller as if `null` was raised.
*/
public inline fun <A> nullable(block: NullableRaise.() -> A): A? =
merge { block(NullableRaise(this)) }
Expand Down