docker/readme.md
2019-11-20 13:36:36 +00:00

2.4 KiB

@mojoio/docker

unofficial docker engine api abstraction package written in TypeScript

Status for master

build status coverage report npm downloads per month Known Vulnerabilities TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import { DockerHost } from '@mojoio/docker'; // require Dockersock class

const run = async () => {
  const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock

  const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
};

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer