Skip to content

Document Pear.teardown() returned promise & Pear.reload() formatting #185

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document Pear.teardown() returned promise & Pear.reload() formatting #185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80af91c
Fix formatting for `Pear.reload()` in Pear API article
lejeunerenard May 8, 2025
9f76ad5
Add note on returned value for `Pear.teardown()` API
lejeunerenard May 8, 2025
58abe06
Add note about calling `Pear.teardown()` w/o a `fn`
lejeunerenard May 8, 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
4 changes: 2 additions & 2 deletions reference/pear/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,15 +372,15 @@ The versions of runtimes.

### `Pear.teardown(fn <Async Function|Function>)`

Register application clean-up handlers to be called when an application begins to unload.
Register application clean-up handlers to be called when an application begins to unload. The returned promise resolves when the teardown callback is executed and containse the returned value. If no `fn` is provided, the promise for the last callback will be returned.

May be called multiple times to register multiple teardown handlers.

Functions supplied to teardown will be executed in order of registration when
an application begins to unload. Any promise returned from each supplied function
will be waited upon until resolution before calling the next teardown handler.

### Pear.reload()
### `Pear.reload()`

Refresh application in Desktop applications. Not available in terminal
applications.
Expand Down