the-moby-effect/dist/dts/internal/endpoints/execs.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 Socket from "@effect/platform/Socket";
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 * as MobyDemux from "../../MobyDemux.js";
import { ContainerExecOptions as ContainerExecStartConfig, ContainerExecOptions as ExecConfig, ContainerExecInspect as ExecInspectResponse, IDResponse } from "../generated/index.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const ExecsErrorTypeId: unique symbol;
/**
 * @since 1.0.0
 * @category Errors
 */
export type ExecsErrorTypeId = typeof ExecsErrorTypeId;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const isExecsError: (u: unknown) => u is ExecsError;
declare const ExecsError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof ExecsErrorTypeId, typeof ExecsErrorTypeId> & {
    readonly _tag: "ExecsError";
} & Readonly<A>;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare class ExecsError extends ExecsError_base<{
    method: string;
    cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | Socket.SocketError | unknown;
}> {
    get message(): string;
}
declare const Execs_base: Effect.Service.Class<Execs, "@the-moby-effect/endpoints/Execs", {
    readonly accessors: false;
    readonly dependencies: readonly [];
    readonly effect: Effect.Effect<{
        container: (id: string, execConfig: typeof ExecConfig.Encoded) => Effect.Effect<Readonly<IDResponse>, ExecsError, never>;
        start: <T extends boolean | undefined = undefined>(id: string, execStartConfig: Omit<typeof ContainerExecStartConfig.Encoded, "Detach"> & {
            Detach?: T;
        }) => Effect.Effect<T extends true ? void : MobyDemux.MultiplexedSocket | MobyDemux.RawSocket, ExecsError, never>;
        resize: (id: string, options?: {
            readonly h?: number;
            readonly w?: number;
        } | undefined) => Effect.Effect<void, ExecsError, never>;
        inspect: (id: string) => Effect.Effect<ExecInspectResponse, ExecsError, never>;
    }, never, HttpClient.HttpClient>;
}>;
/**
 * Execs service
 *
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Exec
 */
export declare class Execs extends Execs_base {
}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Exec
 */
export declare const ExecsLayer: Layer.Layer<Execs, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=execs.d.ts.map