the-moby-effect/dist/MobyPlatforms.d.ts

Moby/Docker API client built using effect-ts

/**
 * Http client layers for all platforms.
 *
 * @since 1.0.0
 */
import type * as Layer from "effect/Layer";
import type * as HttpClient from "effect/unstable/http/HttpClient";
import type * as Socket from "effect/unstable/socket/Socket";
import type * as MobyConnection from "./MobyConnection.ts";
/**
 * 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.
 *
 * @since 1.0.0
 * @category Connection
 */
export declare const makeAgnosticHttpClientLayer: (connectionOptions: MobyConnection.MobyConnectionOptions) => Layer.Layer<HttpClient.HttpClient, never, HttpClient.HttpClient>;
/**
 * 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.
 *
 * @since 1.0.0
 * @category Connection
 */
export declare const makeBunHttpClientLayer: (connectionOptions: MobyConnection.MobyConnectionOptions) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>;
/**
 * 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?
 *
 * @since 1.0.0
 * @category Deno
 */
export declare const makeDenoHttpClientLayer: (connectionOptions: MobyConnection.MobyConnectionOptions) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>;
/**
 * 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. 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.
 *
 * @since 1.0.0
 * @category Fetch
 */
export declare const makeFetchHttpClientLayer: (connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>;
/**
 * 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.
 *
 * @since 1.0.0
 * @category NodeJS
 */
export declare const makeNodeHttpClientLayer: (connectionOptions: MobyConnection.MobyConnectionOptions) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>;
/**
 * 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.
 *
 * @since 1.0.0
 * @category Undici
 */
export declare const makeUndiciHttpClientLayer: (connectionOptions: MobyConnection.MobyConnectionOptions) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>;
/**
 * 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.
 *
 * @since 1.0.0
 * @category Browser
 */
export declare const makeWebHttpClientLayer: (connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged) => Layer.Layer<HttpClient.HttpClient | Socket.WebSocketConstructor, never, never>;
//# sourceMappingURL=MobyPlatforms.d.ts.map