@posthog/types 1.409.1 → 1.409.2

package/dist/capture.d.ts

@@ -53,7 +53,18 @@ export interface CaptureOptions {
      */
     _noTruncate?: boolean;
     /**
-     * If set, skips the batched queue
+     * If set, sends the event immediately instead of adding it to the batched queue.
+     *
+     * The batched queue drains with `sendBeacon` when the page hides, and an immediate send does
+     * not use that queue. On an active page, the SDK keeps its normal transport so failed requests
+     * can be retried. By default this is `fetch`, which keeps small requests alive across a navigation,
+     * or XHR when `fetch` is unavailable. Once PostHog's own `pagehide` handler (or `unload` fallback)
+     * marks the page as unloading, the SDK prefers `sendBeacon`, unless an explicit transport,
+     * a required response, or `request_headers` prevent it. Captures from `beforeunload` or `pagehide`
+     * listeners that run before PostHog's handler still use their normal transport. This is best effort,
+     * not a guarantee: XHR and requests too large for `fetch` keepalive can be cancelled by navigation.
+     * To always use a beacon, set `{ transport: 'sendBeacon' }`, but note that accepted beacons cannot
+     * report server failures to the SDK for retries.
      */
     send_instantly?: boolean;
     /**

package/dist/capture.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,aAAa,GACb,aAAa,GACb,aAAa,GACb,cAAc,GACd,mBAAmB,GACnB,YAAY,CAAA;AAElB;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAC9B,MAAM,GACN,WAAW,GACX,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,sBAAsB,CAAA;AAE5B,MAAM,MAAM,SAAS,GACf,wBAAwB,GACxB,cAAc,GAId,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEnB,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,CAAC,EAAE,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,YAAY,CAAA;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAEhB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC5C;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,KAAK,aAAa,GAAG,IAAI,CAAA"}
+{"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,aAAa,GACb,aAAa,GACb,aAAa,GACb,cAAc,GACd,mBAAmB,GACnB,YAAY,CAAA;AAElB;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAC9B,MAAM,GACN,WAAW,GACX,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,sBAAsB,CAAA;AAE5B,MAAM,MAAM,SAAS,GACf,wBAAwB,GACxB,cAAc,GAId,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEnB,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,CAAC,EAAE,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,YAAY,CAAA;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAEhB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC5C;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,KAAK,aAAa,GAAG,IAAI,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@posthog/types",
-  "version": "1.409.1",
+  "version": "1.409.2",
   "bugs": {
     "url": "https://github.com/PostHog/posthog-js/issues"
   },

package/src/capture.ts

@@ -88,7 +88,18 @@ export interface CaptureOptions {
     _noTruncate?: boolean
 
     /**
-     * If set, skips the batched queue
+     * If set, sends the event immediately instead of adding it to the batched queue.
+     *
+     * The batched queue drains with `sendBeacon` when the page hides, and an immediate send does
+     * not use that queue. On an active page, the SDK keeps its normal transport so failed requests
+     * can be retried. By default this is `fetch`, which keeps small requests alive across a navigation,
+     * or XHR when `fetch` is unavailable. Once PostHog's own `pagehide` handler (or `unload` fallback)
+     * marks the page as unloading, the SDK prefers `sendBeacon`, unless an explicit transport,
+     * a required response, or `request_headers` prevent it. Captures from `beforeunload` or `pagehide`
+     * listeners that run before PostHog's handler still use their normal transport. This is best effort,
+     * not a guarantee: XHR and requests too large for `fetch` keepalive can be cancelled by navigation.
+     * To always use a beacon, set `{ transport: 'sendBeacon' }`, but note that accepted beacons cannot
+     * report server failures to the SDK for retries.
      */
     send_instantly?: boolean