dockerode-utils/dist/Index.d.ts

Dockerode utilities

/// <reference types="dockerode" />
import * as Dockerode from "dockerode";
/**
 * Pull docker image and wait for it if you need
 * @param dockerode - dockerode
 * @param imageName - name of image to pull
 * @param onProgress - on progress hook
 * @returns Dockerode.Image
 */
export declare const pullImageAsync: (dockerode: Dockerode, imageName: string, onProgress?: ((event: any) => void) | undefined) => Promise<Dockerode.Image>;
/**
 * Execute command inside a container and get output from it, if you need
 * @param container - dockerode.container
 * @param cmd - command to execute
 * @returns result
 */
export declare const containerExec: (container: Dockerode.Container, cmd: string[]) => Promise<string[]>;
/**
 * Will wait until container produces specific stdout(console) log.
 * @desc If you're creating and then starting a container, sometimes, you need to wait until a service
 * is fully functional (eg. you can get response from container's exposed port) so you can continue executing code
 * @param container - container
 * @param timeout - how much time (in ms) to wait until it'll throw a error
 */
export declare const waitForOutput: (container: Dockerode.Container, predicate: (line: string) => boolean, timeout?: number) => Promise<boolean>;
/**
 * Is docker image exists ?
 * @param dockerode
 * @param imageNames - names of images
 * @return true if image with imageName exists otherwise false
 */
export declare const imageExists: (dockerode: Dockerode, imageNames: string | string[]) => Promise<boolean>;