the-moby-effect/dist/dts/internal/endpoints/volumes.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 { ClusterVolumeSpec, Volume, VolumeCreateOptions, VolumeListResponse, VolumePruneResponse } from "../generated/index.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const VolumesErrorTypeId: unique symbol;
/**
 * @since 1.0.0
 * @category Errors
 */
export type VolumesErrorTypeId = typeof VolumesErrorTypeId;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const isVolumesError: (u: unknown) => u is VolumesError;
declare const VolumesError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof VolumesErrorTypeId, typeof VolumesErrorTypeId> & {
    readonly _tag: "VolumesError";
} & Readonly<A>;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare class VolumesError extends VolumesError_base<{
    method: string;
    cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | unknown;
}> {
    get message(): string;
}
declare const Volumes_base: Effect.Service.Class<Volumes, "@the-moby-effect/endpoints/Volumes", {
    readonly accessors: false;
    readonly dependencies: readonly [];
    readonly effect: Effect.Effect<{
        list: (options?: {
            readonly filters?: {
                name?: [string] | undefined;
                driver?: [string] | undefined;
                label?: Array<string> | undefined;
                dangling?: ["true" | "false" | "1" | "0"] | undefined;
            };
        } | undefined) => Effect.Effect<VolumeListResponse, VolumesError>;
        create: (createOptions: typeof VolumeCreateOptions.Encoded) => Effect.Effect<Readonly<Volume>, VolumesError, never>;
        delete: (name: string, options?: {
            readonly force?: boolean | undefined;
        } | undefined) => Effect.Effect<void, VolumesError, never>;
        inspect: (name: string) => Effect.Effect<Readonly<Volume>, VolumesError, never>;
        update: (options: {
            readonly name: string;
            readonly spec: ClusterVolumeSpec;
            readonly version: number;
        }) => Effect.Effect<void, VolumesError, never>;
        prune: (options?: {
            readonly filters?: {
                label?: Array<string> | undefined;
                all?: ["true" | "false" | "1" | "0"] | undefined;
            };
        } | undefined) => Effect.Effect<VolumePruneResponse, VolumesError, never>;
    }, never, HttpClient.HttpClient>;
}>;
/**
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume
 */
export declare class Volumes extends Volumes_base {
}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume
 */
export declare const VolumesLayer: Layer.Layer<Volumes, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=volumes.d.ts.map