48 lines
2.4 KiB
Markdown
48 lines
2.4 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 {Dockersock} from "dockersock"; // require Dockersock class
|
|
|
|
let myDockersock = new Dockersock(); // optional: you can pass a domain to the contructor, defaults to /var/run/docker.sock
|
|
|
|
myDockersock.listContainers() // promise, resolve gets container data
|
|
myDockersock.listContainersDetailed() // promise, resolve gets more detailed container data (by combining several requests internally)
|
|
myDockersock.listContainersRunning() // promise, resolve gets container data for currently running containers
|
|
myDockersock.listContainersStopped() // promise, resolve gets container data for stopped containers
|
|
|
|
myDockersock.startContainer({ // starts a already present container
|
|
name: "somecontainername"
|
|
})
|
|
|
|
myDockersock.newContainer({ // start new Container, equals "docker run" shell command
|
|
image: "someimagetag"
|
|
})
|
|
```
|
|
|
|
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)
|