Skip to content

src: return Maybe<> on pending exception when cpp exception disabled #927

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
legendecas merged 12 commits into from
Aug 3, 2021
Merged

src: return Maybe<> on pending exception when cpp exception disabled #927

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
451f27f
src: return Maybe<> on pending exception when cpp exception disabled
legendecas Mar 9, 2021
0f95980
fixup! remove the newly added napi_pending_exception checks
legendecas Jun 3, 2021
676798c
fixup! FunctionReference::New return type
legendecas Jun 9, 2021
6d16dda
fixup!
legendecas Jun 10, 2021
c1385ba
fixup! doc: test docs
legendecas Jun 10, 2021
b946305
fixup! linter complaints
legendecas Jun 10, 2021
fec9561
fixup! review suggestions
legendecas Jun 16, 2021
6012787
Merge branch 'main' into maybe
legendecas Jun 17, 2021
baf6ab8
fixup! remove unnecessary MaybeUnwrapOr
legendecas Jun 18, 2021
43e14e5
fixup! apply review suggestions
legendecas Jul 14, 2021
b16a549
Merge remote-tracking branch 'upstream/main' into maybe
legendecas Jul 14, 2021
68facc7
fixup! update Symbol::For
legendecas Jul 14, 2021
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
Prev Previous commit
Next Next commit
fixup! review suggestions
  • Loading branch information
@legendecas
legendecas committed Jun 16, 2021
commit fec9561e9e14555090f6b98349d0a5bf2a5405c8
2 changes: 1 addition & 1 deletion doc/error_handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ exception.
If C++ exceptions are disabled (for more info see: [Setup](setup.md)), then the
`Napi::Error` class does not extend `std::exception`. This means that any calls to
node-addon-api function do not throw a C++ exceptions. Instead, these node-api
Comment thread
legendecas marked this conversation as resolved.
Outdated
functions that calling into JavaScript are returning with `Maybe` boxed values.
functions that call into JavaScript are returning with `Maybe` boxed values.
In that case, the calling side should convert the `Maybe` boxed values with
checks to ensure that the call did succeed and therefore no exception is pending.
If the check fails, that is to say, the returning value is _empty_, the calling
Expand Down
14 changes: 7 additions & 7 deletions doc/maybe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Maybe (template)

Class `Napi::Maybe<T>` represents an maybe empty value: every `Maybe` is either
`Just` and contains a value, or `Nothing`, and does not. `Maybe` types are very
common in node-addon-api code, as they represent the function may throw a
JavaScript exception and cause the program unable to evaluation any JavaScript
code until the exception is been handled.
Class `Napi::Maybe<T>` represents a value that may be empty: every `Maybe` is
either `Just` and contains a value, or `Nothing`, and does not. `Maybe` types
are very common in node-addon-api code, as they represent that the function may
throw a JavaScript exception and cause the program to be unable to evaluate any
JavaScript code until the exception has been handled.

Typically, the value wrapped in `Napi::Maybe<T>` is [`Napi::Value`] and its
subclasses.
Expand Down Expand Up @@ -58,7 +58,7 @@ template <typename T>
T Napi::Maybe::UnwrapOr(const T& default_value) const;
```

Return the value of type T contained in the Maybe, or using a default
Return the value of type T contained in the Maybe, or use a default
value if this Maybe is nothing (empty).

### UnwrapTo
Expand All @@ -69,6 +69,6 @@ bool Napi::Maybe::UnwrapTo() const;
```

Converts this Maybe to a value of type `T` in the `out`. If this Maybe is
nothing (empty), `false` is returned and `out is left untouched.
nothing (empty), `false` is returned and `out` is left untouched.

[`Napi::Value`]: ./value.md
Loading