a2r/utils/docker.d.ts

A2R Framework

/**
 * Copies path to docker (works with files and folders)
 * @param sourcePath Source path
 * @param destPath Destination path (in docker)
 * @param dockerName Docker name
 */
export declare const copyPathToDocker: (sourcePath: string, destPath: string, dockerName: string) => Promise<void>;
/**
 * Removes a file from docker
 * @param filePath Path of file to remove
 * @param dockerName Docker name
 */
export declare const removeFileFromDocker: (filePath: string, dockerName: string) => Promise<void>;
/**
 * Removes a folder from docker
 * @param folderPath Path of folder to remove
 * @param dockerName Docker name
 */
export declare const removeFolderFromDocker: (folderPath: string, dockerName: string) => Promise<void>;
/**
 * Stops docker container
 * @param dockerName Docker name
 */
export declare const stop: (dockerName: string) => Promise<void>;
/**
 * Removes docker container
 * @param dockerName Docker name
 */
export declare const rm: (dockerName: string) => Promise<void>;
/**
 * Touches file in docker
 * @param filePath File path in docker
 * @param dockerName Docker name
 */
export declare const touch: (filePath: string, dockerName: string) => Promise<void>;
/**
 * Checks if image with given name exists on machine
 * @param imageName Image name
 */
export declare const imageExists: (imageName: string) => Promise<boolean>;
/**
 * Removes docker image from local machine
 * @param imageName Image name
 */
export declare const removeImage: (imageName: string) => Promise<void>;
/**
 * Checks is docker exists applying given filter
 * @param filter Filter (as in `docker ps --filter`)
 */
export declare const dockerExists: (filter: string, checkStopped?: boolean | undefined) => Promise<boolean>;
/**
 * Checks if docker with provided name is running
 * @param dockerName DOcker name
 * @param timeout Timeout (default: `5000`)
 */
export declare const isDockerRunning: (dockerName: string, timeout?: number) => Promise<boolean>;
/**
 * Check for framework and uninstall if installed
 * @param dockerName Docker name (dev-server)
 */
export declare const checkForFrameworkOnServer: (dockerName: string) => Promise<void>;