@effect/platform-browser 4.0.0-beta.7 → 4.0.0-beta.71

package/dist/BrowserSocket.d.ts

@@ -1,20 +1,78 @@
 /**
- * @since 1.0.0
+ * Provide Effect sockets backed by the browser `WebSocket` implementation.
+ *
+ * This module is the browser entry point for Effect's socket abstraction. Use
+ * {@link layerWebSocket} when a client-side Effect program needs a complete
+ * `Socket.Socket` connected to a WebSocket URL. Use
+ * {@link layerWebSocketConstructor} when lower-level socket code only needs the
+ * browser-backed constructor service.
+ *
+ * ## Mental model
+ *
+ * `layerWebSocket` delegates socket behavior to Effect's WebSocket support and
+ * supplies `globalThis.WebSocket` as the constructor. Incoming browser messages
+ * are normalized to strings or binary `Uint8Array` values. Browser `Blob`
+ * messages are read into bytes before they reach the socket consumer.
+ *
+ * Outgoing data should already be serialized to a string or bytes. To close the
+ * underlying browser socket with a specific code and reason, send a
+ * `CloseEvent` value so the close metadata is preserved.
+ *
+ * ## Common tasks
+ *
+ * - Connect RPC transports, browser tests, or realtime UI features to a
+ *   WebSocket URL with {@link layerWebSocket}.
+ * - Provide only the browser constructor service with
+ *   {@link layerWebSocketConstructor} when another socket layer builds the
+ *   connection.
+ * - Customize `closeCodeIsError` for protocols that treat specific close codes
+ *   as normal completion instead of socket failure.
+ *
+ * ## Gotchas
+ *
+ * Browser WebSocket rules still apply. URL schemes, subprotocol negotiation,
+ * mixed-content blocking, cookies, authentication, server origin checks, and
+ * extension negotiation are controlled by the browser and server rather than by
+ * Effect. Close events become socket errors unless `closeCodeIsError`
+ * classifies the close code as clean.
+ *
+ * @since 4.0.0
  */
 import * as Layer from "effect/Layer";
 import * as Socket from "effect/unstable/socket/Socket";
 /**
- * @since 1.0.0
- * @category Layers
+ * Creates a `Socket` layer connected to the given URL using the browser `WebSocket` constructor.
+ *
+ * **When to use**
+ *
+ * Use when browser or client-side code needs a complete `Socket` layer
+ * connected to a WebSocket URL.
+ *
+ * **Details**
+ *
+ * Delegates socket construction to `Socket.makeWebSocket` and provides the
+ * browser-backed `WebSocketConstructor` service.
+ *
+ * **Gotchas**
+ *
+ * Browser WebSocket rules still control URL schemes, mixed-content blocking,
+ * cookies, authentication, origin checks, subprotocols, and extensions. Close
+ * events are errors unless `closeCodeIsError` classifies the close code as
+ * clean.
+ *
+ * @see {@link layerWebSocketConstructor} for providing only the browser constructor service
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export declare const layerWebSocket: (url: string, options?: {
     readonly closeCodeIsError?: (code: number) => boolean;
 }) => Layer.Layer<Socket.Socket>;
 /**
- * A WebSocket constructor that uses `globalThis.WebSocket`.
+ * Layer that provides a `WebSocketConstructor` service backed by `globalThis.WebSocket`.
  *
- * @since 1.0.0
- * @category Layers
+ * @category layers
+ * @since 4.0.0
  */
 export declare const layerWebSocketConstructor: Layer.Layer<Socket.WebSocketConstructor>;
 //# sourceMappingURL=BrowserSocket.d.ts.map

package/dist/BrowserSocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserSocket.d.ts","sourceRoot":"","sources":["../src/BrowserSocket.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAA;AAEvD;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,EAAE,UAAU;IACpD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;CACtD,KAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAG1B,CAAA;AAEH;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,oBAAoB,CACvC,CAAA"}
+{"version":3,"file":"BrowserSocket.d.ts","sourceRoot":"","sources":["../src/BrowserSocket.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,EAAE,UAAU;IACpD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;CACtD,KAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAG1B,CAAA;AAEH;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,oBAAoB,CACvC,CAAA"}

package/dist/BrowserSocket.js

@@ -1,18 +1,76 @@
 /**
- * @since 1.0.0
+ * Provide Effect sockets backed by the browser `WebSocket` implementation.
+ *
+ * This module is the browser entry point for Effect's socket abstraction. Use
+ * {@link layerWebSocket} when a client-side Effect program needs a complete
+ * `Socket.Socket` connected to a WebSocket URL. Use
+ * {@link layerWebSocketConstructor} when lower-level socket code only needs the
+ * browser-backed constructor service.
+ *
+ * ## Mental model
+ *
+ * `layerWebSocket` delegates socket behavior to Effect's WebSocket support and
+ * supplies `globalThis.WebSocket` as the constructor. Incoming browser messages
+ * are normalized to strings or binary `Uint8Array` values. Browser `Blob`
+ * messages are read into bytes before they reach the socket consumer.
+ *
+ * Outgoing data should already be serialized to a string or bytes. To close the
+ * underlying browser socket with a specific code and reason, send a
+ * `CloseEvent` value so the close metadata is preserved.
+ *
+ * ## Common tasks
+ *
+ * - Connect RPC transports, browser tests, or realtime UI features to a
+ *   WebSocket URL with {@link layerWebSocket}.
+ * - Provide only the browser constructor service with
+ *   {@link layerWebSocketConstructor} when another socket layer builds the
+ *   connection.
+ * - Customize `closeCodeIsError` for protocols that treat specific close codes
+ *   as normal completion instead of socket failure.
+ *
+ * ## Gotchas
+ *
+ * Browser WebSocket rules still apply. URL schemes, subprotocol negotiation,
+ * mixed-content blocking, cookies, authentication, server origin checks, and
+ * extension negotiation are controlled by the browser and server rather than by
+ * Effect. Close events become socket errors unless `closeCodeIsError`
+ * classifies the close code as clean.
+ *
+ * @since 4.0.0
  */
 import * as Layer from "effect/Layer";
 import * as Socket from "effect/unstable/socket/Socket";
 /**
- * @since 1.0.0
- * @category Layers
+ * Creates a `Socket` layer connected to the given URL using the browser `WebSocket` constructor.
+ *
+ * **When to use**
+ *
+ * Use when browser or client-side code needs a complete `Socket` layer
+ * connected to a WebSocket URL.
+ *
+ * **Details**
+ *
+ * Delegates socket construction to `Socket.makeWebSocket` and provides the
+ * browser-backed `WebSocketConstructor` service.
+ *
+ * **Gotchas**
+ *
+ * Browser WebSocket rules still control URL schemes, mixed-content blocking,
+ * cookies, authentication, origin checks, subprotocols, and extensions. Close
+ * events are errors unless `closeCodeIsError` classifies the close code as
+ * clean.
+ *
+ * @see {@link layerWebSocketConstructor} for providing only the browser constructor service
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layerWebSocket = (url, options) => Layer.effect(Socket.Socket, Socket.makeWebSocket(url, options)).pipe(Layer.provide(layerWebSocketConstructor));
 /**
- * A WebSocket constructor that uses `globalThis.WebSocket`.
+ * Layer that provides a `WebSocketConstructor` service backed by `globalThis.WebSocket`.
  *
- * @since 1.0.0
- * @category Layers
+ * @category layers
+ * @since 4.0.0
  */
 export const layerWebSocketConstructor = Socket.layerWebSocketConstructorGlobal;
 //# sourceMappingURL=BrowserSocket.js.map

package/dist/BrowserSocket.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserSocket.js","names":["Layer","Socket","layerWebSocket","url","options","effect","makeWebSocket","pipe","provide","layerWebSocketConstructor","layerWebSocketConstructorGlobal"],"sources":["../src/BrowserSocket.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,MAAM,MAAM,+BAA+B;AAEvD;;;;AAIA,OAAO,MAAMC,cAAc,GAAGA,CAACC,GAAW,EAAEC,OAE3C,KACCJ,KAAK,CAACK,MAAM,CAACJ,MAAM,CAACA,MAAM,EAAEA,MAAM,CAACK,aAAa,CAACH,GAAG,EAAEC,OAAO,CAAC,CAAC,CAACG,IAAI,CAClEP,KAAK,CAACQ,OAAO,CAACC,yBAAyB,CAAC,CACzC;AAEH;;;;;;AAMA,OAAO,MAAMA,yBAAyB,GACpCR,MAAM,CAACS,+BAA+B","ignoreList":[]}
+{"version":3,"file":"BrowserSocket.js","names":["Layer","Socket","layerWebSocket","url","options","effect","makeWebSocket","pipe","provide","layerWebSocketConstructor","layerWebSocketConstructorGlobal"],"sources":["../src/BrowserSocket.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,OAAO,KAAKA,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,MAAM,MAAM,+BAA+B;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMC,cAAc,GAAGA,CAACC,GAAW,EAAEC,OAE3C,KACCJ,KAAK,CAACK,MAAM,CAACJ,MAAM,CAACA,MAAM,EAAEA,MAAM,CAACK,aAAa,CAACH,GAAG,EAAEC,OAAO,CAAC,CAAC,CAACG,IAAI,CAClEP,KAAK,CAACQ,OAAO,CAACC,yBAAyB,CAAC,CACzC;AAEH;;;;;;AAMA,OAAO,MAAMA,yBAAyB,GACpCR,MAAM,CAACS,+BAA+B","ignoreList":[]}

package/dist/BrowserStream.d.ts

@@ -1,15 +1,55 @@
 /**
- * @since 1.0.0
+ * Convert browser DOM events into Effect streams.
+ *
+ * This module provides typed constructors for listening to `window` and
+ * `document` events from Effect programs. Use {@link fromEventListenerWindow}
+ * for viewport, network, focus, pointer, keyboard, and other `Window` events,
+ * and use {@link fromEventListenerDocument} for document lifecycle,
+ * visibility, selection, fullscreen, and other `Document` events.
+ *
+ * ## Mental model
+ *
+ * Each constructor registers a DOM `addEventListener` callback when the stream
+ * is consumed and removes it when the stream is finalized. Browser events are
+ * push-based `EventTarget` notifications, so the browser does not slow down the
+ * event source when downstream stream processing is busy. Events are buffered
+ * inside the stream until a consumer pulls them.
+ *
+ * ## Common tasks
+ *
+ * - Track browser state such as resize, online / offline, focus, visibility, or
+ *   pointer activity with Effect stream operators.
+ * - Scope DOM listeners to a fiber so they are removed when the consuming
+ *   effect is interrupted or completes.
+ * - Set `bufferSize` for bursty event sources before applying sampling,
+ *   throttling, debouncing, or dropping logic downstream.
+ *
+ * ## Gotchas
+ *
+ * The default buffer is unbounded. High-frequency sources such as `scroll`,
+ * `pointermove`, or `mousemove` should usually specify `bufferSize` and reduce
+ * the event rate with stream operators.
+ *
+ * These helpers are for DOM events, not for `ReadableStream` request or
+ * response bodies. Fetch bodies follow Web Streams rules such as
+ * single-consumer locking and disturbed bodies after reads. When using the DOM
+ * `once` option, also use `Stream.take(1)` if the consuming code needs a finite
+ * stream.
+ *
+ * @since 4.0.0
  */
 import * as Stream from "effect/Stream";
 /**
  * Creates a `Stream` from `window.addEventListener`.
  *
+ * **Details**
+ *
  * By default, the underlying buffer is unbounded in size. You can customize the
- * buffer size an object as the second argument with the `bufferSize` field.
+ * buffer size by passing an object as the second argument with the `bufferSize`
+ * field.
  *
- * @since 1.0.0
  * @category Streams
+ * @since 4.0.0
  */
 export declare const fromEventListenerWindow: <K extends keyof WindowEventMap>(type: K, options?: boolean | {
     readonly capture?: boolean;
@@ -20,11 +60,14 @@ export declare const fromEventListenerWindow: <K extends keyof WindowEventMap>(t
 /**
  * Creates a `Stream` from `document.addEventListener`.
  *
+ * **Details**
+ *
  * By default, the underlying buffer is unbounded in size. You can customize the
- * buffer size an object as the second argument with the `bufferSize` field.
+ * buffer size by passing an object as the second argument with the `bufferSize`
+ * field.
  *
- * @since 1.0.0
  * @category Streams
+ * @since 4.0.0
  */
 export declare const fromEventListenerDocument: <K extends keyof DocumentEventMap>(type: K, options?: boolean | {
     readonly capture?: boolean;

package/dist/BrowserStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserStream.d.ts","sourceRoot":"","sources":["../src/BrowserStream.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,GAAI,CAAC,SAAS,MAAM,cAAc,EACpE,MAAM,CAAC,EACP,UAAU,OAAO,GAAG;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC,GAAG,SAAS,KACZ,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAuE,CAAA;AAEvH;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,GAAI,CAAC,SAAS,MAAM,gBAAgB,EACxE,MAAM,CAAC,EACP,UAAU,OAAO,GAAG;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC,GAAG,SAAS,KACZ,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CACsB,CAAA"}
+{"version":3,"file":"BrowserStream.d.ts","sourceRoot":"","sources":["../src/BrowserStream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB,GAAI,CAAC,SAAS,MAAM,cAAc,EACpE,MAAM,CAAC,EACP,UAAU,OAAO,GAAG;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC,GAAG,SAAS,KACZ,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAuE,CAAA;AAEvH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yBAAyB,GAAI,CAAC,SAAS,MAAM,gBAAgB,EACxE,MAAM,CAAC,EACP,UAAU,OAAO,GAAG;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC,GAAG,SAAS,KACZ,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CACsB,CAAA"}

package/dist/BrowserStream.js

@@ -1,25 +1,68 @@
 /**
- * @since 1.0.0
+ * Convert browser DOM events into Effect streams.
+ *
+ * This module provides typed constructors for listening to `window` and
+ * `document` events from Effect programs. Use {@link fromEventListenerWindow}
+ * for viewport, network, focus, pointer, keyboard, and other `Window` events,
+ * and use {@link fromEventListenerDocument} for document lifecycle,
+ * visibility, selection, fullscreen, and other `Document` events.
+ *
+ * ## Mental model
+ *
+ * Each constructor registers a DOM `addEventListener` callback when the stream
+ * is consumed and removes it when the stream is finalized. Browser events are
+ * push-based `EventTarget` notifications, so the browser does not slow down the
+ * event source when downstream stream processing is busy. Events are buffered
+ * inside the stream until a consumer pulls them.
+ *
+ * ## Common tasks
+ *
+ * - Track browser state such as resize, online / offline, focus, visibility, or
+ *   pointer activity with Effect stream operators.
+ * - Scope DOM listeners to a fiber so they are removed when the consuming
+ *   effect is interrupted or completes.
+ * - Set `bufferSize` for bursty event sources before applying sampling,
+ *   throttling, debouncing, or dropping logic downstream.
+ *
+ * ## Gotchas
+ *
+ * The default buffer is unbounded. High-frequency sources such as `scroll`,
+ * `pointermove`, or `mousemove` should usually specify `bufferSize` and reduce
+ * the event rate with stream operators.
+ *
+ * These helpers are for DOM events, not for `ReadableStream` request or
+ * response bodies. Fetch bodies follow Web Streams rules such as
+ * single-consumer locking and disturbed bodies after reads. When using the DOM
+ * `once` option, also use `Stream.take(1)` if the consuming code needs a finite
+ * stream.
+ *
+ * @since 4.0.0
  */
 import * as Stream from "effect/Stream";
 /**
  * Creates a `Stream` from `window.addEventListener`.
  *
+ * **Details**
+ *
  * By default, the underlying buffer is unbounded in size. You can customize the
- * buffer size an object as the second argument with the `bufferSize` field.
+ * buffer size by passing an object as the second argument with the `bufferSize`
+ * field.
  *
- * @since 1.0.0
  * @category Streams
+ * @since 4.0.0
  */
 export const fromEventListenerWindow = (type, options) => Stream.fromEventListener(window, type, options);
 /**
  * Creates a `Stream` from `document.addEventListener`.
  *
+ * **Details**
+ *
  * By default, the underlying buffer is unbounded in size. You can customize the
- * buffer size an object as the second argument with the `bufferSize` field.
+ * buffer size by passing an object as the second argument with the `bufferSize`
+ * field.
  *
- * @since 1.0.0
  * @category Streams
+ * @since 4.0.0
  */
 export const fromEventListenerDocument = (type, options) => Stream.fromEventListener(document, type, options);
 //# sourceMappingURL=BrowserStream.js.map

package/dist/BrowserStream.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserStream.js","names":["Stream","fromEventListenerWindow","type","options","fromEventListener","window","fromEventListenerDocument","document"],"sources":["../src/BrowserStream.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAEvC;;;;;;;;;AASA,OAAO,MAAMC,uBAAuB,GAAGA,CACrCC,IAAO,EACPC,OAKa,KACsCH,MAAM,CAACI,iBAAiB,CAAoBC,MAAM,EAAEH,IAAI,EAAEC,OAAO,CAAC;AAEvH;;;;;;;;;AASA,OAAO,MAAMG,yBAAyB,GAAGA,CACvCJ,IAAO,EACPC,OAKa,KAEbH,MAAM,CAACI,iBAAiB,CAAsBG,QAAQ,EAAEL,IAAI,EAAEC,OAAO,CAAC","ignoreList":[]}
+{"version":3,"file":"BrowserStream.js","names":["Stream","fromEventListenerWindow","type","options","fromEventListener","window","fromEventListenerDocument","document"],"sources":["../src/BrowserStream.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAEvC;;;;;;;;;;;;AAYA,OAAO,MAAMC,uBAAuB,GAAGA,CACrCC,IAAO,EACPC,OAKa,KACsCH,MAAM,CAACI,iBAAiB,CAAoBC,MAAM,EAAEH,IAAI,EAAEC,OAAO,CAAC;AAEvH;;;;;;;;;;;;AAYA,OAAO,MAAMG,yBAAyB,GAAGA,CACvCJ,IAAO,EACPC,OAKa,KAEbH,MAAM,CAACI,iBAAiB,CAAsBG,QAAQ,EAAEL,IAAI,EAAEC,OAAO,CAAC","ignoreList":[]}

package/dist/BrowserWorker.d.ts

@@ -1,13 +1,34 @@
 import * as Layer from "effect/Layer";
 import * as Worker from "effect/unstable/workers/Worker";
 /**
- * @since 1.0.0
- * @category Layers
+ * Creates browser worker layers by combining the default `WorkerPlatform` with a spawner for `Worker`, `SharedWorker`, or `MessagePort` instances.
+ *
+ * **When to use**
+ *
+ * Use when browser parent or client code needs both the browser
+ * `WorkerPlatform` and a `Spawner` from one layer.
+ *
+ * **Details**
+ *
+ * The `spawn` callback receives the numeric worker id and may return a
+ * `Worker`, `SharedWorker`, or `MessagePort`.
+ *
+ * **Gotchas**
+ *
+ * Scope finalization sends the worker close protocol over the port. Dedicated
+ * workers created by `spawn` are not terminated by this layer.
+ *
+ * @see {@link layerPlatform} for providing only the browser worker platform
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export declare const layer: (spawn: (id: number) => Worker | SharedWorker | MessagePort) => Layer.Layer<Worker.WorkerPlatform | Worker.Spawner>;
 /**
- * @since 1.0.0
- * @category Layers
+ * Layer that provides the browser `WorkerPlatform` for `Worker`, `SharedWorker`, and `MessagePort` communication.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export declare const layerPlatform: Layer.Layer<Worker.WorkerPlatform>;
 //# sourceMappingURL=BrowserWorker.d.ts.map

package/dist/BrowserWorker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserWorker.d.ts","sourceRoot":"","sources":["../src/BrowserWorker.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAErC,OAAO,KAAK,MAAM,MAAM,gCAAgC,CAAA;AAGxD;;;GAGG;AACH,eAAO,MAAM,KAAK,GAChB,OAAO,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,GAAG,YAAY,GAAG,WAAW,KACzD,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,OAAO,CAIlD,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CA2C5D,CAAA"}
+{"version":3,"file":"BrowserWorker.d.ts","sourceRoot":"","sources":["../src/BrowserWorker.ts"],"names":[],"mappings":"AAwCA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAErC,OAAO,KAAK,MAAM,MAAM,gCAAgC,CAAA;AAGxD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,KAAK,GAChB,OAAO,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,GAAG,YAAY,GAAG,WAAW,KACzD,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,OAAO,CAIlD,CAAA;AAEH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CA2C5D,CAAA"}

package/dist/BrowserWorker.js

@@ -1,5 +1,40 @@
 /**
- * @since 1.0.0
+ * Parent-side browser platform for running Effect workers.
+ *
+ * This module provides the `WorkerPlatform` used by browser code that spawns or
+ * connects to `Worker`, `SharedWorker`, and `MessagePort` endpoints through
+ * Effect's worker protocol. Pair it with `BrowserWorkerRunner` in the worker
+ * entrypoint when building worker-backed RPC clients, moving CPU-bound work off
+ * the main thread, isolating browser-only services, or adapting an existing
+ * `MessageChannel` in tests.
+ *
+ * **Mental model**
+ *
+ * Browser worker communication is normalized to a message port. Dedicated
+ * workers post messages on the worker object itself, shared workers post
+ * through `worker.port`, and raw `MessagePort` values can be supplied directly.
+ * `layerPlatform` provides only the browser platform, while `layer` combines
+ * the platform with a `Spawner` that creates a worker endpoint for each worker
+ * id.
+ *
+ * **Common tasks**
+ *
+ * Use `layer` when parent code should both provide browser worker messaging and
+ * define how workers are spawned. Use `layerPlatform` when a spawner is already
+ * provided elsewhere. Return a `MessagePort` from the spawner for tests or
+ * custom channels, a `Worker` for dedicated workers, or a `SharedWorker` when
+ * multiple browser contexts should share one worker runtime.
+ *
+ * **Gotchas**
+ *
+ * Messages use the browser structured-clone algorithm, so payloads and transfer
+ * lists must be accepted by the target runtime. Transferring an `ArrayBuffer` or
+ * `MessagePort` moves ownership away from the sender. Scope finalization sends
+ * the worker close signal over the port, but code that created a dedicated
+ * `Worker` remains responsible for broader lifecycle concerns such as
+ * terminating it.
+ *
+ * @since 4.0.0
  */
 import * as Deferred from "effect/Deferred";
 import * as Effect from "effect/Effect";
@@ -8,13 +43,34 @@ import * as Scope from "effect/Scope";
 import * as Worker from "effect/unstable/workers/Worker";
 import { WorkerError, WorkerReceiveError } from "effect/unstable/workers/WorkerError";
 /**
- * @since 1.0.0
- * @category Layers
+ * Creates browser worker layers by combining the default `WorkerPlatform` with a spawner for `Worker`, `SharedWorker`, or `MessagePort` instances.
+ *
+ * **When to use**
+ *
+ * Use when browser parent or client code needs both the browser
+ * `WorkerPlatform` and a `Spawner` from one layer.
+ *
+ * **Details**
+ *
+ * The `spawn` callback receives the numeric worker id and may return a
+ * `Worker`, `SharedWorker`, or `MessagePort`.
+ *
+ * **Gotchas**
+ *
+ * Scope finalization sends the worker close protocol over the port. Dedicated
+ * workers created by `spawn` are not terminated by this layer.
+ *
+ * @see {@link layerPlatform} for providing only the browser worker platform
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layer = spawn => Layer.merge(layerPlatform, Worker.layerSpawner(spawn));
 /**
- * @since 1.0.0
- * @category Layers
+ * Layer that provides the browser `WorkerPlatform` for `Worker`, `SharedWorker`, and `MessagePort` communication.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layerPlatform = /*#__PURE__*/Layer.succeed(Worker.WorkerPlatform)(/*#__PURE__*/Worker.makePlatform()({
   setup({
@@ -41,7 +97,7 @@ export const layerPlatform = /*#__PURE__*/Layer.succeed(Worker.WorkerPlatform)(/
           message: "An error event was emitter",
           cause: event.error ?? event.message
         })
-      }).asEffect());
+      }));
     }
     port.addEventListener("message", onMessage);
     port.addEventListener("error", onError);

package/dist/BrowserWorker.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserWorker.js","names":["Deferred","Effect","Layer","Scope","Worker","WorkerError","WorkerReceiveError","layer","spawn","merge","layerPlatform","layerSpawner","succeed","WorkerPlatform","makePlatform","setup","scope","worker","port","as","addFinalizer","sync","postMessage","listen","deferred","emit","onMessage","event","data","onError","doneUnsafe","reason","message","cause","error","asEffect","addEventListener","start","removeEventListener"],"sources":["../src/BrowserWorker.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,iBAAiB;AAC3C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,MAAM,MAAM,gCAAgC;AACxD,SAASC,WAAW,EAAEC,kBAAkB,QAAQ,qCAAqC;AAErF;;;;AAIA,OAAO,MAAMC,KAAK,GAChBC,KAA0D,IAE1DN,KAAK,CAACO,KAAK,CACTC,aAAa,EACbN,MAAM,CAACO,YAAY,CAACH,KAAK,CAAC,CAC3B;AAEH;;;;AAIA,OAAO,MAAME,aAAa,gBAAuCR,KAAK,CAACU,OAAO,CAACR,MAAM,CAACS,cAAc,CAAC,cACnGT,MAAM,CAACU,YAAY,EAA6D,CAAC;EAC/EC,KAAKA,CAAC;IAAEC,KAAK;IAAEC;EAAM,CAAE;IACrB,MAAMC,IAAI,GAAG,MAAM,IAAID,MAAM,GAAGA,MAAM,CAACC,IAAI,GAAGD,MAAM;IACpD,OAAOhB,MAAM,CAACkB,EAAE,CACdhB,KAAK,CAACiB,YAAY,CAChBJ,KAAK,EACLf,MAAM,CAACoB,IAAI,CAAC,MAAK;MACfH,IAAI,CAACI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC,CAAC,CACH,EACDJ,IAAI,CACL;EACH,CAAC;EACDK,MAAMA,CAAC;IAAEC,QAAQ;IAAEC,IAAI;IAAEP,IAAI;IAAEF;EAAK,CAAE;IACpC,SAASU,SAASA,CAACC,KAAmB;MACpCF,IAAI,CAACE,KAAK,CAACC,IAAI,CAAC;IAClB;IACA,SAASC,OAAOA,CAACF,KAAiB;MAChC3B,QAAQ,CAAC8B,UAAU,CACjBN,QAAQ,EACR,IAAInB,WAAW,CAAC;QACd0B,MAAM,EAAE,IAAIzB,kBAAkB,CAAC;UAC7B0B,OAAO,EAAE,4BAA4B;UACrCC,KAAK,EAAEN,KAAK,CAACO,KAAK,IAAIP,KAAK,CAACK;SAC7B;OACF,CAAC,CAACG,QAAQ,EAAE,CACd;IACH;IACAjB,IAAI,CAACkB,gBAAgB,CAAC,SAAS,EAAEV,SAAgB,CAAC;IAClDR,IAAI,CAACkB,gBAAgB,CAAC,OAAO,EAAEP,OAAc,CAAC;IAC9C,IAAI,OAAO,IAAIX,IAAI,EAAE;MACnBA,IAAI,CAACmB,KAAK,EAAE;IACd;IACA,OAAOlC,KAAK,CAACiB,YAAY,CACvBJ,KAAK,EACLf,MAAM,CAACoB,IAAI,CAAC,MAAK;MACfH,IAAI,CAACoB,mBAAmB,CAAC,SAAS,EAAEZ,SAAgB,CAAC;MACrDR,IAAI,CAACoB,mBAAmB,CAAC,OAAO,EAAET,OAAc,CAAC;IACnD,CAAC,CAAC,CACH;EACH;CACD,CAAC,CACH","ignoreList":[]}
+{"version":3,"file":"BrowserWorker.js","names":["Deferred","Effect","Layer","Scope","Worker","WorkerError","WorkerReceiveError","layer","spawn","merge","layerPlatform","layerSpawner","succeed","WorkerPlatform","makePlatform","setup","scope","worker","port","as","addFinalizer","sync","postMessage","listen","deferred","emit","onMessage","event","data","onError","doneUnsafe","reason","message","cause","error","addEventListener","start","removeEventListener"],"sources":["../src/BrowserWorker.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,OAAO,KAAKA,QAAQ,MAAM,iBAAiB;AAC3C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,MAAM,MAAM,gCAAgC;AACxD,SAASC,WAAW,EAAEC,kBAAkB,QAAQ,qCAAqC;AAErF;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAMC,KAAK,GAChBC,KAA0D,IAE1DN,KAAK,CAACO,KAAK,CACTC,aAAa,EACbN,MAAM,CAACO,YAAY,CAACH,KAAK,CAAC,CAC3B;AAEH;;;;;;AAMA,OAAO,MAAME,aAAa,gBAAuCR,KAAK,CAACU,OAAO,CAACR,MAAM,CAACS,cAAc,CAAC,cACnGT,MAAM,CAACU,YAAY,EAA6D,CAAC;EAC/EC,KAAKA,CAAC;IAAEC,KAAK;IAAEC;EAAM,CAAE;IACrB,MAAMC,IAAI,GAAG,MAAM,IAAID,MAAM,GAAGA,MAAM,CAACC,IAAI,GAAGD,MAAM;IACpD,OAAOhB,MAAM,CAACkB,EAAE,CACdhB,KAAK,CAACiB,YAAY,CAChBJ,KAAK,EACLf,MAAM,CAACoB,IAAI,CAAC,MAAK;MACfH,IAAI,CAACI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC,CAAC,CACH,EACDJ,IAAI,CACL;EACH,CAAC;EACDK,MAAMA,CAAC;IAAEC,QAAQ;IAAEC,IAAI;IAAEP,IAAI;IAAEF;EAAK,CAAE;IACpC,SAASU,SAASA,CAACC,KAAmB;MACpCF,IAAI,CAACE,KAAK,CAACC,IAAI,CAAC;IAClB;IACA,SAASC,OAAOA,CAACF,KAAiB;MAChC3B,QAAQ,CAAC8B,UAAU,CACjBN,QAAQ,EACR,IAAInB,WAAW,CAAC;QACd0B,MAAM,EAAE,IAAIzB,kBAAkB,CAAC;UAC7B0B,OAAO,EAAE,4BAA4B;UACrCC,KAAK,EAAEN,KAAK,CAACO,KAAK,IAAIP,KAAK,CAACK;SAC7B;OACF,CAAC,CACH;IACH;IACAd,IAAI,CAACiB,gBAAgB,CAAC,SAAS,EAAET,SAAgB,CAAC;IAClDR,IAAI,CAACiB,gBAAgB,CAAC,OAAO,EAAEN,OAAc,CAAC;IAC9C,IAAI,OAAO,IAAIX,IAAI,EAAE;MACnBA,IAAI,CAACkB,KAAK,EAAE;IACd;IACA,OAAOjC,KAAK,CAACiB,YAAY,CACvBJ,KAAK,EACLf,MAAM,CAACoB,IAAI,CAAC,MAAK;MACfH,IAAI,CAACmB,mBAAmB,CAAC,SAAS,EAAEX,SAAgB,CAAC;MACrDR,IAAI,CAACmB,mBAAmB,CAAC,OAAO,EAAER,OAAc,CAAC;IACnD,CAAC,CAAC,CACH;EACH;CACD,CAAC,CACH","ignoreList":[]}

package/dist/BrowserWorkerRunner.d.ts

@@ -1,18 +1,43 @@
 import * as Layer from "effect/Layer";
 import * as WorkerRunner from "effect/unstable/workers/WorkerRunner";
 /**
- * @since 1.0.0
- * @category Constructors
+ * Creates a `WorkerRunnerPlatform` service that runs worker handlers over a `MessagePort` or `Window`.
+ *
+ * @category constructors
+ * @since 4.0.0
  */
 export declare const make: (self: MessagePort | Window) => WorkerRunner.WorkerRunnerPlatform["Service"];
 /**
- * @since 1.0.0
- * @category Layers
+ * Layer that provides a browser `WorkerRunnerPlatform` using the global `self` worker context.
+ *
+ * **When to use**
+ *
+ * Use when a browser worker entry point uses the ambient `self` object as the
+ * worker transport.
+ *
+ * **Details**
+ *
+ * Delegates to `make(self)` and provides the runner-side platform used by
+ * protocols such as `RpcServer.layerProtocolWorkerRunner`.
+ *
+ * **Gotchas**
+ *
+ * This layer depends on the browser worker global `self`. Use
+ * `layerMessagePort` when the transport is an explicit `MessagePort` or
+ * `Window`.
+ *
+ * @see {@link make} for constructing a runner platform from an explicit endpoint
+ * @see {@link layerMessagePort} for providing a platform from an explicit endpoint
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export declare const layer: Layer.Layer<WorkerRunner.WorkerRunnerPlatform>;
 /**
- * @since 1.0.0
- * @category Layers
+ * Layer that provides a `WorkerRunnerPlatform` using the supplied `MessagePort` or `Window`.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export declare const layerMessagePort: (port: MessagePort | Window) => Layer.Layer<WorkerRunner.WorkerRunnerPlatform>;
 //# sourceMappingURL=BrowserWorkerRunner.d.ts.map

package/dist/BrowserWorkerRunner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserWorkerRunner.d.ts","sourceRoot":"","sources":["../src/BrowserWorkerRunner.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAIrC,OAAO,KAAK,YAAY,MAAM,sCAAsC,CAAA;AAUpE;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,WAAW,GAAG,MAAM,KAAG,YAAY,CAAC,oBAAoB,CAAC,SAAS,CA2H3F,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAEhE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,WAAW,GAAG,MAAM,KAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAC7C,CAAA"}
+{"version":3,"file":"BrowserWorkerRunner.d.ts","sourceRoot":"","sources":["../src/BrowserWorkerRunner.ts"],"names":[],"mappings":"AAuCA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAIrC,OAAO,KAAK,YAAY,MAAM,sCAAsC,CAAA;AAUpE;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,WAAW,GAAG,MAAM,KAAG,YAAY,CAAC,oBAAoB,CAAC,SAAS,CA2H3F,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAEhE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,WAAW,GAAG,MAAM,KAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAC7C,CAAA"}