lakutata/vendor/TypeDef.internal.106.d.ts

An IoC-based universal application framework.

import { DTO } from './TypeDef.internal.96.js';
import { DockerAuthOptions } from './TypeDef.internal.112.js';
import { DockerOutputCallback } from './TypeDef.internal.109.js';

declare class ImageTagOptions extends DTO {
    /**
     * The repository to tag in. For example, someuser/someimage.
     */
    repo: string;
    /**
     * The name of the new tag.
     */
    tag?: string;
}

declare class ImageExportOptions extends DTO {
    /**
     * Where the image exported to, should be filename or write stream
     */
    destination: string | NodeJS.WritableStream;
    /**
     * Export specific repoTag
     */
    repoTag?: string;
    /**
     * Create specific repoTag if not exist
     * @default true
     */
    createRepoTagIfNotExists?: boolean;
}

declare class ImageRemoveOptions extends DTO {
    /**
     * Force remove image
     * @default true
     */
    force?: boolean;
    noprune?: boolean;
}

declare class ImagePushOptions extends DTO {
    repo: string;
    tag?: string;
    auth?: DockerAuthOptions;
    outputCallback?: DockerOutputCallback;
}

declare class ImagePullOptions extends DTO {
    repo: string;
    tag?: string;
    platform?: string;
    auth?: DockerAuthOptions;
    outputCallback?: DockerOutputCallback;
}

declare class ImageBuildOptions extends DTO {
    workdir: string;
    files: string[];
    /**
     * Path within the build context to the Dockerfile. This is ignored if remote is specified and points to an external Dockerfile.
     * @default Dockerfile
     */
    dockerfile?: string;
    /**
     * A name and optional tag to apply to the image in the name:tag format.
     */
    repoTag?: string;
    /**
     * Platform in the format os[/arch[/variant]]
     * @default ""
     */
    platform?: string;
    /**
     * Target build stage
     * @default ""
     */
    target?: string;
    /**
     * A Git repository URI or HTTP/HTTPS context URI.
     * If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file.
     * If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build.
     * If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball.
     */
    remote?: string;
    /**
     * Suppress verbose build output.
     * @default false
     */
    quite?: boolean;
    /**
     * Do not use the cache when building the image.
     * @default false
     */
    nocache?: boolean;
    /**
     * Remove intermediate containers after a successful build.
     * @default true
     */
    rm?: boolean;
    /**
     * Always remove intermediate containers, even upon failure.
     * @default false
     */
    forcerm?: boolean;
    /**
     * Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB.
     */
    shmsize?: number;
    /**
     * JSON map of string pairs for build-time variables.
     * Users pass these values at build-time.
     * Docker uses the buildargs as the environment context for commands run via the Dockerfile RUN instruction, or for variable expansion in other Dockerfile instructions.
     * This is not meant for passing secret values.
     */
    buildargs?: {
        [key: string]: string;
    };
    auth?: DockerAuthOptions;
    outputCallback?: DockerOutputCallback;
}

declare class ImageImportOptions extends DTO {
    source: string | NodeJS.ReadableStream;
    /**
     * Suppress progress details during import
     * @default false
     */
    quiet?: boolean;
}

export { ImageBuildOptions, ImageExportOptions, ImageImportOptions, ImagePullOptions, ImagePushOptions, ImageRemoveOptions, ImageTagOptions };