the-moby-effect/dist/dts/internal/endpoints/nodes.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 { SwarmNode, SwarmNodeSpec } from "../generated/index.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const NodesErrorTypeId: unique symbol;
/**
 * @since 1.0.0
 * @category Errors
 */
export type NodesErrorTypeId = typeof NodesErrorTypeId;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const isNodesError: (u: unknown) => u is NodesError;
declare const NodesError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof NodesErrorTypeId, typeof NodesErrorTypeId> & {
    readonly _tag: "NodesError";
} & Readonly<A>;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare class NodesError extends NodesError_base<{
    method: string;
    cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | unknown;
}> {
    get message(): string;
}
declare const Nodes_base: Effect.Service.Class<Nodes, "@the-moby-effect/endpoints/Nodes", {
    readonly accessors: false;
    readonly dependencies: readonly [];
    readonly effect: Effect.Effect<{
        list: (options?: {
            readonly filters?: {
                id?: [string] | undefined;
                label?: [string] | undefined;
                membership?: ["accepted" | "pending"] | undefined;
                name?: [string] | undefined;
                "node.label"?: [string] | undefined;
                role?: ["manager" | "worker"] | undefined;
            };
        } | undefined) => Effect.Effect<Readonly<Array<SwarmNode>>, NodesError, never>;
        delete: (id: string, options?: {
            readonly force?: boolean | undefined;
        } | undefined) => Effect.Effect<void, NodesError, never>;
        inspect: (id: string) => Effect.Effect<Readonly<SwarmNode>, NodesError, never>;
        update: (id: string, options: {
            readonly body: SwarmNodeSpec;
            readonly version: number;
        }) => Effect.Effect<void, NodesError, never>;
    }, never, HttpClient.HttpClient>;
}>;
/**
 * Nodes service
 *
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/engine/api/v1.45/#tag/Node
 */
export declare class Nodes extends Nodes_base {
}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/engine/api/v1.45/#tag/Node
 */
export declare const NodesLayer: Layer.Layer<Nodes, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=nodes.d.ts.map