the-moby-effect/dist/internal/endpoints/system.d.ts

Moby/Docker API client built using effect-ts

import * as Context from "effect/Context";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import * as Schema from "effect/Schema";
import * as Stream from "effect/Stream";
import * as HttpClient from "effect/unstable/http/HttpClient";
import * as HttpApi from "effect/unstable/httpapi/HttpApi";
import * as HttpApiEndpoint from "effect/unstable/httpapi/HttpApiEndpoint";
import * as HttpApiGroup from "effect/unstable/httpapi/HttpApiGroup";
import * as HttpApiSchema from "effect/unstable/httpapi/HttpApiSchema";
import { RegistryAuthenticateOKBody as AuthResponse, TypesDiskUsage as DiskUsage, RegistryAuthConfig, SystemInfo, TypesVersion as SystemVersion } from "../generated/index.ts";
import { DockerError } from "./circular.ts";
import { BadRequest, InternalServerError, Unauthorized } from "./errors.ts";
/**
 * @since 1.0.0
 * @category HttpApi
 * @see https://docs.docker.com/reference/api/engine/version/v1.51/#tag/System
 */
export declare const SystemApi: HttpApi.HttpApi<"SystemApi", HttpApiGroup.HttpApiGroup<"system", HttpApiEndpoint.HttpApiEndpoint<"auth", "POST", "/auth", never, never, Schema.toCodecJson<typeof RegistryAuthConfig>, never, Schema.toCodecJson<Schema.Void | typeof AuthResponse>, Schema.toCodecJson<typeof Unauthorized | typeof InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"dataUsage", "GET", "/system/df", never, Schema.toCodecStringTree<Schema.Struct<{
    type: Schema.optional<Schema.$Array<Schema.Literals<readonly ["container", "image", "volume", "build-cache"]>>>;
}>>, never, never, Schema.toCodecJson<typeof DiskUsage>, Schema.toCodecJson<typeof InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"events", "GET", "/events", never, Schema.toCodecStringTree<Schema.Struct<{
    since: Schema.optional<Schema.String>;
    until: Schema.optional<Schema.String>;
}>>, never, never, HttpApiSchema.StreamUint8Array, Schema.toCodecJson<typeof BadRequest | typeof InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"info", "GET", "/info", never, never, never, never, Schema.toCodecJson<typeof SystemInfo>, Schema.toCodecJson<typeof InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"ping", "GET", "/_ping", never, never, never, never, Schema.toCodecJson<Schema.Literal<"OK">>, Schema.toCodecJson<typeof InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"pingHead", "HEAD", "/_ping", never, never, never, never, Schema.toCodecJson<Schema.Void>, Schema.toCodecJson<typeof InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"version", "GET", "/version", never, never, never, never, Schema.toCodecJson<typeof SystemVersion>, Schema.toCodecJson<typeof InternalServerError>, never, never>, false>>;
declare const System_base: Context.ServiceClass<System, "@the-moby-effect/endpoints/System", {
    auth: (payload: (typeof RegistryAuthConfig)["~type.make.in"]) => Effect.Effect<void | AuthResponse, DockerError, never>;
    info: () => Effect.Effect<SystemInfo, DockerError, never>;
    version: () => Effect.Effect<SystemVersion, DockerError, never>;
    ping: () => Effect.Effect<"OK", DockerError, never>;
    pingHead: () => Effect.Effect<void, DockerError, never>;
    events: (options?: {
        readonly since?: string | undefined;
        readonly until?: string | undefined;
    }) => Stream.Stream<unknown, DockerError, never>;
    dataUsage: (params?: {
        readonly type?: readonly ("build-cache" | "container" | "image" | "volume")[] | undefined;
    }) => Effect.Effect<DiskUsage, DockerError, never>;
}> & {
    readonly make: Effect.Effect<{
        auth: (payload: (typeof RegistryAuthConfig)["~type.make.in"]) => Effect.Effect<void | AuthResponse, DockerError, never>;
        info: () => Effect.Effect<SystemInfo, DockerError, never>;
        version: () => Effect.Effect<SystemVersion, DockerError, never>;
        ping: () => Effect.Effect<"OK", DockerError, never>;
        pingHead: () => Effect.Effect<void, DockerError, never>;
        events: (options?: {
            readonly since?: string | undefined;
            readonly until?: string | undefined;
        }) => Stream.Stream<unknown, DockerError, never>;
        dataUsage: (params?: {
            readonly type?: readonly ("build-cache" | "container" | "image" | "volume")[] | undefined;
        }) => Effect.Effect<DiskUsage, DockerError, never>;
    }, never, HttpClient.HttpClient>;
};
/**
 * @since 1.0.0
 * @category Services
 * @see https://docs.docker.com/reference/api/engine/version/v1.51/#tag/System
 */
export declare class System extends System_base {
}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/version/v1.51/#tag/System
 */
export declare const SystemLayer: Layer.Layer<System, never, HttpClient.HttpClient>;
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/version/v1.51/#tag/System
 */
export declare const SystemLayerLocalSocket: Layer.Layer<System, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=system.d.ts.map