the-moby-effect/dist/dts/internal/endpoints/networks.d.ts

Moby/Docker API client built using effect-ts

import type * as HttpBody from "@effect/platform/HttpBody";
import type * as HttpClientError from "@effect/platform/HttpClientError";
import type * as Layer from "effect/Layer";
import type * as ParseResult from "effect/ParseResult";
import * as HttpClient from "@effect/platform/HttpClient";
import * as Effect from "effect/Effect";
import { NetworkConnectOptions as NetworkConnectRequest, NetworkCreateRequest, NetworkCreateResponse, NetworkDisconnectOptions as NetworkDisconnectRequest, NetworkPruneResponse, NetworkSummary } from "../generated/index.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const NetworksErrorTypeId: unique symbol;
/**
 * @since 1.0.0
 * @category Errors
 */
export type NetworksErrorTypeId = typeof NetworksErrorTypeId;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const isNetworksError: (u: unknown) => u is NetworksError;
declare const NetworksError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof NetworksErrorTypeId, typeof NetworksErrorTypeId> & {
    readonly _tag: "NetworksError";
} & Readonly<A>;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare class NetworksError extends NetworksError_base<{
    method: string;
    cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | unknown;
}> {
    get message(): string;
}
declare const Networks_base: Effect.Service.Class<Networks, "@the-moby-effect/endpoints/Networks", {
    readonly accessors: false;
    readonly dependencies: readonly [];
    readonly effect: Effect.Effect<{
        list: (options?: {
            readonly filters?: Record<string, string | Array<string>>;
        } | undefined) => Effect.Effect<Readonly<Array<NetworkSummary>>, NetworksError>;
        delete: (id: string) => Effect.Effect<void, NetworksError>;
        inspect: (id: string, options?: {
            readonly verbose?: boolean;
            readonly scope?: string;
        } | undefined) => Effect.Effect<Readonly<NetworkSummary>, NetworksError>;
        create: (createRequest: typeof NetworkCreateRequest.Encoded) => Effect.Effect<NetworkCreateResponse, NetworksError>;
        connect: (id: string, connectRequest: typeof NetworkConnectRequest.Encoded) => Effect.Effect<void, NetworksError>;
        disconnect: (id: string, disconnectRequest: typeof NetworkDisconnectRequest.Encoded) => Effect.Effect<void, NetworksError>;
        prune: (options: {
            readonly filters?: Record<string, string | Array<string>>;
        } | undefined) => Effect.Effect<NetworkPruneResponse, NetworksError, never>;
    }, never, HttpClient.HttpClient>;
}>;
/**
 * Networks service
 *
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Network
 */
export declare class Networks extends Networks_base {
}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Network
 */
export declare const NetworksLayer: Layer.Layer<Networks, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=networks.d.ts.map