39 lines
2.0 KiB
Markdown
39 lines
2.0 KiB
Markdown
# @mojoio/docker
|
|
unofficial docker engine api abstraction package written in TypeScript
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
|
|
* [gitlab.com (source)](https://gitlab.com/mojoio/docker)
|
|
* [github.com (source mirror)](https://github.com/mojoio/docker)
|
|
* [docs (typedoc)](https://mojoio.gitlab.io/docker/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/mojoio/docker/commits/master)
|
|
[](https://gitlab.com/mojoio/docker/commits/master)
|
|
[](https://www.npmjs.com/package/@mojoio/docker)
|
|
[](https://snyk.io/test/npm/@mojoio/docker)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```typescript
|
|
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
|
|
};
|
|
```
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|