@heycatch/sdk 0.7.0-dev.974 → 0.7.1-dev.1123

package/README.md

@@ -62,6 +62,31 @@ The remaining options above are browser behaviour. React Native honours
 does not have. The server entry accepts the same `HeyCatchConfig` so one
 object works under every import condition, and ignores them.
 
+## Delivery options
+
+By default the SDK batches captured events for a few seconds before sending
+them, which is right for a single-page app. On a **multi-page site** - one
+where each click is a full page load - a visitor can navigate away inside
+that window, and iOS Safari in particular does not reliably let the batch out
+as the page is torn down. The symptom is mobile pageviews missing from your
+dashboard while desktop looks fine. Two options, both browser-only and both
+unset by default:
+
+```ts
+analytics.init({
+  projectKey: 'hck_pk_...',
+  requestBatching: false, // send every event as it happens - the fix for multi-page sites
+  flushIntervalMs: 250, // or keep batching but shrink the window (250-5000 ms; default 3000)
+});
+```
+
+Set one or the other - with batching off the interval has nothing to act on.
+The cost is one request per captured event, and autocapture is on by default:
+the count follows how much a visitor clicks, not how many pages they open, so a
+busy page sends more requests than a quiet one. `flushIntervalMs: 250` is the
+middle ground - still batched, but a window short enough that a navigation
+rarely lands inside it.
+
 ## License
 
 MIT