@effect/platform-browser 4.0.0-rc.109 → 4.0.0-rc.110

package/ai-docs/src/70_cli/10_basics.ts

@@ -23,7 +23,8 @@ const tasks = Command.make("tasks").pipe(
     workspace,
     verbose: Flag.boolean("verbose").pipe(
       Flag.withAlias("v"),
-      Flag.withDescription("Print diagnostic output")
+      Flag.withDescription("Print diagnostic output"),
+      Flag.withDefault(false)
     )
   }),
   Command.withDescription("Track and manage tasks")
@@ -92,7 +93,8 @@ const list = Command.make(
       Flag.withDefault("open")
     ),
     json: Flag.boolean("json").pipe(
-      Flag.withDescription("Print machine-readable output")
+      Flag.withDescription("Print machine-readable output"),
+      Flag.withDefault(false)
     )
   },
   Effect.fn(function*({ status, json }) {

package/dist/BrowserRuntime.d.ts

@@ -2,15 +2,15 @@
  * Browser helper for running a root Effect program.
  *
  * This module exports `runMain`, a browser version of the main Effect runner.
- * It forwards runner options to the core runtime and adds a `beforeunload`
- * listener that interrupts the main fiber when the page is unloading.
+ * It forwards runner options to the core runtime and adds a `pagehide`
+ * listener that interrupts the main fiber when the document is discarded.
  *
  * @since 4.0.0
  */
 import type * as Effect from "effect/Effect";
 import { type Teardown } from "effect/Runtime";
 /**
- * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+ * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
  *
  * **When to use**
  *
@@ -21,11 +21,12 @@ import { type Teardown } from "effect/Runtime";
  *
  * Supports both direct and curried call forms. Options are forwarded to
  * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
- * behavior.
+ * behavior. A persisted `pagehide` event is ignored because the document is
+ * entering the back/forward cache and may be restored.
  *
  * **Gotchas**
  *
- * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+ * The `pagehide` interruption is best-effort. Browser teardown may prevent
  * asynchronous finalizers, network work, timers, or prompts from completing.
  *
  * @category running
@@ -33,7 +34,7 @@ import { type Teardown } from "effect/Runtime";
  */
 export declare const runMain: {
     /**
-     * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+     * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
      *
      * **When to use**
      *
@@ -44,11 +45,12 @@ export declare const runMain: {
      *
      * Supports both direct and curried call forms. Options are forwarded to
      * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
-     * behavior.
+     * behavior. A persisted `pagehide` event is ignored because the document is
+     * entering the back/forward cache and may be restored.
      *
      * **Gotchas**
      *
-     * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+     * The `pagehide` interruption is best-effort. Browser teardown may prevent
      * asynchronous finalizers, network work, timers, or prompts from completing.
      *
      * @category running
@@ -59,7 +61,7 @@ export declare const runMain: {
         readonly teardown?: Teardown | undefined;
     }): <E, A>(effect: Effect.Effect<A, E>) => void;
     /**
-     * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+     * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
      *
      * **When to use**
      *
@@ -70,11 +72,12 @@ export declare const runMain: {
      *
      * Supports both direct and curried call forms. Options are forwarded to
      * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
-     * behavior.
+     * behavior. A persisted `pagehide` event is ignored because the document is
+     * entering the back/forward cache and may be restored.
      *
      * **Gotchas**
      *
-     * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+     * The `pagehide` interruption is best-effort. Browser teardown may prevent
      * asynchronous finalizers, network work, timers, or prompts from completing.
      *
      * @category running

package/dist/BrowserRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserRuntime.d.ts","sourceRoot":"","sources":["../src/BrowserRuntime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAe,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CAKP,CAAA"}
+{"version":3,"file":"BrowserRuntime.d.ts","sourceRoot":"","sources":["../src/BrowserRuntime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAe,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CAOP,CAAA"}

package/dist/BrowserRuntime.js

@@ -1,6 +1,6 @@
 import { makeRunMain } from "effect/Runtime";
 /**
- * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+ * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
  *
  * **When to use**
  *
@@ -11,11 +11,12 @@ import { makeRunMain } from "effect/Runtime";
  *
  * Supports both direct and curried call forms. Options are forwarded to
  * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
- * behavior.
+ * behavior. A persisted `pagehide` event is ignored because the document is
+ * entering the back/forward cache and may be restored.
  *
  * **Gotchas**
  *
- * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+ * The `pagehide` interruption is best-effort. Browser teardown may prevent
  * asynchronous finalizers, network work, timers, or prompts from completing.
  *
  * @category running
@@ -24,8 +25,10 @@ import { makeRunMain } from "effect/Runtime";
 export const runMain = /*#__PURE__*/makeRunMain(({
   fiber
 }) => {
-  globalThis.addEventListener("beforeunload", () => {
-    fiber.interruptUnsafe(fiber.id);
+  globalThis.addEventListener("pagehide", event => {
+    if (!event.persisted) {
+      fiber.interruptUnsafe(fiber.id);
+    }
   });
 });
 //# sourceMappingURL=BrowserRuntime.js.map

package/dist/BrowserRuntime.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserRuntime.js","names":[],"sources":["../src/BrowserRuntime.ts"],"sourcesContent":[null],"mappings":"AAUA,SAAS,WAAW,QAAuB,gBAAgB;AAE3D;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAM,OAAO,gBA0DhB,WAAW,CAAC,CAAC;EAAE;AAAK,CAAE,KAAI;EAC5B,UAAU,CAAC,gBAAgB,CAAC,cAAc,EAAE,MAAK;IAC/C,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;EACjC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"BrowserRuntime.js","names":[],"sources":["../src/BrowserRuntime.ts"],"sourcesContent":[null],"mappings":"AAUA,SAAS,WAAW,QAAuB,gBAAgB;AAE3D;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAM,OAAO,gBA4DhB,WAAW,CAAC,CAAC;EAAE;AAAK,CAAE,KAAI;EAC5B,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAG,KAAK,IAAI;IAChD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;MACpB,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IACjC;EACF,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@effect/platform-browser",
   "type": "module",
-  "version": "4.0.0-rc.109",
+  "version": "4.0.0-rc.110",
   "license": "MIT",
   "description": "Platform specific implementations for the browser",
   "homepage": "https://effect.website",
@@ -49,12 +49,12 @@
     "provenance": true
   },
   "peerDependencies": {
-    "effect": "^4.0.0-rc.109"
+    "effect": "^4.0.0-rc.110"
   },
   "devDependencies": {
     "fake-indexeddb": "^6.2.5",
     "mock-xmlhttprequest": "^8.4.1",
-    "effect": "^4.0.0-rc.109"
+    "effect": "^4.0.0-rc.110"
   },
   "scripts": {
     "codegen": "effect-utils codegen",

package/src/BrowserRuntime.ts

@@ -2,8 +2,8 @@
  * Browser helper for running a root Effect program.
  *
  * This module exports `runMain`, a browser version of the main Effect runner.
- * It forwards runner options to the core runtime and adds a `beforeunload`
- * listener that interrupts the main fiber when the page is unloading.
+ * It forwards runner options to the core runtime and adds a `pagehide`
+ * listener that interrupts the main fiber when the document is discarded.
  *
  * @since 4.0.0
  */
@@ -11,7 +11,7 @@ import type * as Effect from "effect/Effect"
 import { makeRunMain, type Teardown } from "effect/Runtime"
 
 /**
- * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+ * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
  *
  * **When to use**
  *
@@ -22,11 +22,12 @@ import { makeRunMain, type Teardown } from "effect/Runtime"
  *
  * Supports both direct and curried call forms. Options are forwarded to
  * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
- * behavior.
+ * behavior. A persisted `pagehide` event is ignored because the document is
+ * entering the back/forward cache and may be restored.
  *
  * **Gotchas**
  *
- * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+ * The `pagehide` interruption is best-effort. Browser teardown may prevent
  * asynchronous finalizers, network work, timers, or prompts from completing.
  *
  * @category running
@@ -34,7 +35,7 @@ import { makeRunMain, type Teardown } from "effect/Runtime"
  */
 export const runMain: {
   /**
-   * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+   * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
    *
    * **When to use**
    *
@@ -45,11 +46,12 @@ export const runMain: {
    *
    * Supports both direct and curried call forms. Options are forwarded to
    * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
-   * behavior.
+   * behavior. A persisted `pagehide` event is ignored because the document is
+   * entering the back/forward cache and may be restored.
    *
    * **Gotchas**
    *
-   * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+   * The `pagehide` interruption is best-effort. Browser teardown may prevent
    * asynchronous finalizers, network work, timers, or prompts from completing.
    *
    * @category running
@@ -62,7 +64,7 @@ export const runMain: {
     }
   ): <E, A>(effect: Effect.Effect<A, E>) => void
   /**
-   * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+   * Runs an effect as the browser main program and interrupts its fiber when the document is discarded.
    *
    * **When to use**
    *
@@ -73,11 +75,12 @@ export const runMain: {
    *
    * Supports both direct and curried call forms. Options are forwarded to
    * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
-   * behavior.
+   * behavior. A persisted `pagehide` event is ignored because the document is
+   * entering the back/forward cache and may be restored.
    *
    * **Gotchas**
    *
-   * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+   * The `pagehide` interruption is best-effort. Browser teardown may prevent
    * asynchronous finalizers, network work, timers, or prompts from completing.
    *
    * @category running
@@ -91,7 +94,9 @@ export const runMain: {
     }
   ): void
 } = makeRunMain(({ fiber }) => {
-  globalThis.addEventListener("beforeunload", () => {
-    fiber.interruptUnsafe(fiber.id)
+  globalThis.addEventListener("pagehide", (event) => {
+    if (!event.persisted) {
+      fiber.interruptUnsafe(fiber.id)
+    }
   })
 })