save

Author: leonitousconforti

docs/modules/Callbacks.ts.md

@@ -31,7 +31,7 @@ Create a callback client for the docker engine
 export declare const callbackClient: <E>(
   layer: Layer.Layer<
     Layer.Layer.Success<DockerEngine.DockerLayer>,
-    E | Layer.Layer.Error<DockerEngine.DockerLayer>,
+    Layer.Layer.Error<DockerEngine.DockerLayer> | E,
     Layer.Layer.Context<DockerEngine.DockerLayer>
   >
 ) => Promise<{

docs/modules/MobyConvey.ts.md

@@ -16,6 +16,7 @@ Added in v1.0.0
 
 - [Conveyance Sinks](#conveyance-sinks)
   - [followProgressInConsole](#followprogressinconsole)
+  - [followProgressSink](#followprogresssink)
   - [waitForProgressToComplete](#waitforprogresstocomplete)
 
 ---
@@ -24,24 +25,40 @@ Added in v1.0.0
 
 ## followProgressInConsole
 
+Tracks the progress stream in the console and returns the result.
+
 **Signature**
 
 ```ts
 export declare const followProgressInConsole: <E1, R1>(
-  stream: Stream<JSONMessage, E1, R1>
-) => Effect<Chunk<JSONMessage>, E1, Exclude<R1, Scope>>
+  stream: Stream.Stream<JSONMessage, E1, R1>
+) => Effect.Effect<Chunk.Chunk<JSONMessage>, E1, Exclude<R1, Scope.Scope>>
+```
+
+Added in v1.0.0
+
+## followProgressSink
+
+Consumes the progress stream and logs it to the console.
+
+**Signature**
+
+```ts
+export declare const followProgressSink: Sink.Sink<void, JSONMessage, never, never, never>
 ```
 
 Added in v1.0.0
 
 ## waitForProgressToComplete
 
+Waits for the progress stream to complete and returns the result.
+
 **Signature**
 
 ```ts
 export declare const waitForProgressToComplete: <E1, R1>(
-  stream: Stream<JSONMessage, E1, R1>
-) => Effect<Chunk<JSONMessage>, E1, Exclude<R1, Scope>>
+  stream: Stream.Stream<JSONMessage, E1, R1>
+) => Effect.Effect<Chunk.Chunk<JSONMessage>, E1, Exclude<R1, Scope.Scope>>
 ```
 
 Added in v1.0.0

docs/modules/MobyEngine.ts.md

@@ -1,6 +1,6 @@
 ---
 title: MobyPlatforms.ts
-nav_order: 11
+nav_order: 10
 parent: Modules
 ---
 
@@ -14,16 +14,41 @@ Added in v1.0.0
 
 <h2 class="text-delta">Table of contents</h2>
 
+- [Browser](#browser)
+  - [makeWebHttpClientLayer](#makewebhttpclientlayer)
 - [Connection](#connection)
   - [makeAgnosticHttpClientLayer](#makeagnostichttpclientlayer)
   - [makeBunHttpClientLayer](#makebunhttpclientlayer)
+- [Deno](#deno)
   - [makeDenoHttpClientLayer](#makedenohttpclientlayer)
+- [Fetch](#fetch)
+  - [makeFetchHttpClientLayer](#makefetchhttpclientlayer)
+- [NodeJS](#nodejs)
   - [makeNodeHttpClientLayer](#makenodehttpclientlayer)
+- [Undici](#undici)
   - [makeUndiciHttpClientLayer](#makeundicihttpclientlayer)
-  - [makeWebHttpClientLayer](#makewebhttpclientlayer)
 
 ---
 
+# Browser
+
+## makeWebHttpClientLayer
+
+Given the moby connection options, it will construct a layer that provides a
+http client that you could use to connect to your moby instance.
+
+This function will dynamically import the `@effect/platform-browser` package.
+
+**Signature**
+
+```ts
+export declare const makeWebHttpClientLayer: (
+  connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged
+) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>
+```
+
+Added in v1.0.0
+
 # Connection
 
 ## makeAgnosticHttpClientLayer
@@ -35,7 +60,7 @@ http client that you could use to connect to your moby instance.
 
 ```ts
 export declare const makeAgnosticHttpClientLayer: (
-  connectionOptions: MobyConnectionOptions
+  connectionOptions: MobyConnection.MobyConnectionOptions
 ) => Layer.Layer<HttpClient.HttpClient, never, HttpClient.HttpClient>
 ```
 
@@ -47,72 +72,96 @@ Given the moby connection options, it will construct a layer that provides a
 http client that you could use to connect to your moby instance. This is no
 different than the Node implementation currently.
 
+This function will dynamically import the `@effect/platform-node` package.
+
 **Signature**
 
 ```ts
 export declare const makeBunHttpClientLayer: (
-  connectionOptions: MobyConnectionOptions
+  connectionOptions: MobyConnection.MobyConnectionOptions
 ) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>
 ```
 
 Added in v1.0.0
 
+# Deno
+
 ## makeDenoHttpClientLayer
 
 Given the moby connection options, it will construct a layer that provides a
 http client that you could use to connect to your moby instance. This is no
 different than the Node implementation currently.
 
+This function will dynamically import the `@effect/platform-node` package.
+
+FIXME: https://github.com/denoland/deno/issues/21436?
+
+Will fallback to using undici for now because that seems to work
+
 **Signature**
 
 ```ts
 export declare const makeDenoHttpClientLayer: (
-  connectionOptions: MobyConnectionOptions
+  connectionOptions: MobyConnection.MobyConnectionOptions
 ) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>
 ```
 
 Added in v1.0.0
 
-## makeNodeHttpClientLayer
+# Fetch
+
+## makeFetchHttpClientLayer
 
 Given the moby connection options, it will construct a layer that provides a
-http client that you could use to connect to your moby instance.
+http client that you could use to connect to your moby instance. By only
+supporting http and https connection options, this function does not rely on
+any specific platform package and uses the `@effect/platform/FetchHttpClient`
+as its base http layer.
 
 **Signature**
 
 ```ts
-export declare const makeNodeHttpClientLayer: (
-  connectionOptions: MobyConnectionOptions
+export declare const makeFetchHttpClientLayer: (
+  connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged
 ) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>
 ```
 
 Added in v1.0.0
 
-## makeUndiciHttpClientLayer
+# NodeJS
+
+## makeNodeHttpClientLayer
 
 Given the moby connection options, it will construct a layer that provides a
 http client that you could use to connect to your moby instance.
 
+This function will dynamically import the `@effect/platform-node` package.
+
 **Signature**
 
 ```ts
-export declare const makeUndiciHttpClientLayer: (
-  connectionOptions: MobyConnectionOptions
+export declare const makeNodeHttpClientLayer: (
+  connectionOptions: MobyConnection.MobyConnectionOptions
 ) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>
 ```
 
 Added in v1.0.0
 
-## makeWebHttpClientLayer
+# Undici
+
+## makeUndiciHttpClientLayer
 
 Given the moby connection options, it will construct a layer that provides a
 http client that you could use to connect to your moby instance.
 
+This function will dynamically import the `@effect/platform-node` and
+`undici` packages.
+
 **Signature**
 
 ```ts
-export declare const makeWebHttpClientLayer: (
-  connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged
+export declare const makeUndiciHttpClientLayer: (
+  connectionOptions: MobyConnection.MobyConnectionOptions
 ) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>
 ```
 

docs/modules/MobyPlatforms.ts.md

@@ -1,6 +1,6 @@
 ---
 title: MobySchemas.ts
-nav_order: 12
+nav_order: 11
 parent: Modules
 ---