Skip to content

Clarify API usage on bfcache #101

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
mingyc merged 1 commit into from
Apr 3, 2025
Merged

Clarify API usage on bfcache #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions docs/fetch-later-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ Note that from the point of view of the API user, the exact sending time is alwa

## Key scenarios

### Defer a `GET` request until page is destroyed or evicted from bfcache
### Defer a `GET` request until page is destroyed or entering bfcache

No matter the request succeeds or not, the browser will drop the response or
error from server, and the caller will not be able to tell.
> **NOTE**: No matter the request succeeds or not, the browser will drop the response or error from server, and the API user will not be able to tell the difference.

```js
fetchLater('/send_beacon');
Expand All @@ -54,6 +53,8 @@ fetchLater({

### Send a request when page is abondoned

The following code tries to ensure `fetchLater()` is called right at various pagelife cycle events that may indicate end of a page visit (but not covering all possible scenarios).

```js
let beaconResult = null;

Expand Down