UNPKG

603 BTypeScriptView Raw
1/**
2 * Builds Docker images from Dockerfiles
3 *
4 * Detect's the special `# dockter` comment and,
5 * - sends the instructions prior to the comment to Docker to be built as normal and
6 * - applies all following instructions into a single layer
7 */
8export default class DockerBuilder {
9 /**
10 * Build a Docker image for a project
11 *
12 * @param dir The project directory
13 * @param name The name to tag the image with
14 * @param dockerfile The name of the Dockerfile within `dir` to use for the build
15 */
16 build(dir: string, name?: string, dockerfile?: string): Promise<void>;
17}