2.0.2 • Published 3 years ago

@nomiclabs/hardhat-docker v2.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

npm hardhat

hardhat-docker

What

A library to manage Docker from Hardhat plugins.

Installation

npm install @nomiclabs/hardhat-docker

Usage

Importing HardhatDocker

const { HardhatDocker } = require("@nomiclabs/hardhat-docker");

Running Docker container

const image = { repository: "alpine", tag: "latest" };
const docker = await HardhatDocker.create();

if (!(await docker.hasPulledImage(image))) {
  await docker.pullImage(image);
}

const { statusCode, stdout, stderr } = await docker.runContainer(image, [
  "echo",
  "Hello world!",
]);

console.log(stdout.toString());

Available methods

MethodDescriptionArgumentsReturn Type
isInstalledcheck if docker is installedPromise<boolean>
imageExistscheck if docker image is available on docker hubImagePromise<boolean>
hasPulledImagecheck if docker image is pulledImagePromise<boolean>
isImageUpToDatecheck if latest docker image is installedImagePromise<boolean>
pullImagepulls docker image from docker hubImagePromise<void>
imageToRepoTagreturns image repository tagImageString
runContainerruns docker containerImage, commandPromise<ProcessResult>