the-moby-effect
Version:
Moby/Docker API client built using effect-ts
81 lines • 3.27 kB
TypeScript
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 { Swarm as SwarmData, SwarmInitRequest, SwarmJoinRequest, SwarmSpec, SwarmUnlockKeyResponse, SwarmUnlockRequest } from "../generated/index.js";
/**
* @since 1.0.0
* @category Errors
*/
export declare const SwarmsErrorTypeId: unique symbol;
/**
* @since 1.0.0
* @category Errors
*/
export type SwarmsErrorTypeId = typeof SwarmsErrorTypeId;
/**
* @since 1.0.0
* @category Errors
*/
export declare const isSwarmsError: (u: unknown) => u is SwarmsError;
declare const SwarmsError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof SwarmsErrorTypeId, typeof SwarmsErrorTypeId> & {
readonly _tag: "SwarmsError";
} & Readonly<A>;
/**
* @since 1.0.0
* @category Errors
*/
export declare class SwarmsError extends SwarmsError_base<{
method: string;
cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | unknown;
}> {
get message(): string;
}
declare const Swarm_base: Effect.Service.Class<Swarm, "@the-moby-effect/endpoints/Swarm", {
readonly accessors: false;
readonly dependencies: readonly [];
readonly effect: Effect.Effect<{
inspect: () => Effect.Effect<Readonly<SwarmData>, SwarmsError, never>;
init: (options: typeof SwarmInitRequest.Encoded) => Effect.Effect<Readonly<string>, SwarmsError, never>;
join: (options: typeof SwarmJoinRequest.Encoded) => Effect.Effect<void, SwarmsError, never>;
leave: (options: {
/**
* Force leave swarm, even if this is the last manager or that it
* will break the cluster.
*/
readonly force?: boolean;
}) => Effect.Effect<void, SwarmsError, never>;
update: (options: {
readonly spec: SwarmSpec;
readonly version: number;
readonly rotateWorkerToken?: boolean;
readonly rotateManagerToken?: boolean;
readonly rotateManagerUnlockKey?: boolean;
}) => Effect.Effect<void, SwarmsError, never>;
unlockkey: () => Effect.Effect<SwarmUnlockKeyResponse, SwarmsError, never>;
unlock: (options: typeof SwarmUnlockRequest.Encoded) => Effect.Effect<void, SwarmsError, never>;
}, never, HttpClient.HttpClient>;
}>;
/**
* Engines can be clustered together in a swarm. Refer to the swarm mode
* documentation for more information.
*
* @since 1.0.0
* @category Tags
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Swarm
*/
export declare class Swarm extends Swarm_base {
}
/**
* Engines can be clustered together in a swarm. Refer to the swarm mode
* documentation for more information.
*
* @since 1.0.0
* @category Layers
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Swarm
*/
export declare const SwarmLayer: Layer.Layer<Swarm, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=swarm.d.ts.map