Skip to content

Enhance README with Cache mode & Keep Alive details #210

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
mzanoni merged 1 commit into from
Aug 26, 2026
Merged

Enhance README with Cache mode & Keep Alive details #210

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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,16 @@ After which you have access to various methods depending on the client you've bo

***Note: serverUrl is not required and will default to https://api.relewise.com/***

#### Cache mode
#### Cache mode & Keep Alive
By default, clients use `cache: 'no-cache'` to ensure responses are always fresh — this prevents stale results that could break personalization.
However, some service workers (often used in integrations) do not support the `no-cache` mode.

You can also configure request with `keepalive`: `true`. This can be useful to prevent tracking requests from being cancelled because the user navigated away from the page before the request compeleted.
```ts
const integrator = new Integrator(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
cache: 'default'
cache: 'default',
keepalive: true
});
```

Expand Down