Skip to main content

Docker Compose Js API Overview

ClassDescription
ComposeWrapper around docker compose (with fallback to docker-compose) for programmatically managing Docker Compose services.

Type Aliases​

ComposeOptions​

ComposeOptions = object

Defined in: index.ts:12

Properties​

env?​

optional env?: NodeJS.ProcessEnv

Defined in: index.ts:17

Merged over process.env for the spawned docker compose process. Reaches the CLI, not the containers.


RunOptions​

RunOptions = object

Defined in: index.ts:7

Index Signature​

[arg: string]: Arg | null