InitDockerSuiteOptions

InitDockerSuiteOptions = object

Defined in: docker/init-docker-suite.ts:13

Properties

containerNamePrefix?

optional containerNamePrefix?: string

Defined in: docker/init-docker-suite.ts:43

Prefix for the image and container names.

Defaults to “test-”.

---

containerRunOptions?

optional containerRunOptions?: (name) => Except<DockerContainerRunOptions, "name" | "context" | "detach">

Defined in: docker/init-docker-suite.ts:34

Options to use when starting a container.

The suite owns the name, the context and the detach flag: it has to know the name to remove the container, it runs every command against one context, and a container started in the foreground would never hand control back to the test.

Parameters

name

DockerContainerName

Returns

Except<DockerContainerRunOptions, "name" | "context" | "detach">

---

context?

optional context?: string

Defined in: docker/init-docker-suite.ts:46

Docker context to run every command of this suite against.

---

onContainerStarted?

optional onContainerStarted?: (name) => void | Promise<void>

Defined in: docker/init-docker-suite.ts:18

Called after a container is started.

Parameters

name

DockerContainerName

Returns

void | Promise<void>

---

onContainerStarting?

optional onContainerStarting?: (name) => void | Promise<void>

Defined in: docker/init-docker-suite.ts:15

Called with the name a container is about to be started under.

Parameters

name

DockerContainerName

Returns

void | Promise<void>

---

onContainerStopped?

optional onContainerStopped?: (name) => void | Promise<void>

Defined in: docker/init-docker-suite.ts:24

Called after a container is removed.

Parameters

name

DockerContainerName

Returns

void | Promise<void>

---

onContainerStopping?

optional onContainerStopping?: (name) => void | Promise<void>

Defined in: docker/init-docker-suite.ts:21

Called before a container is removed, while it is still reachable.

Parameters

name

DockerContainerName

Returns

void | Promise<void>

---

reuseContainerInstance?

optional reuseContainerInstance?: boolean

Defined in: docker/init-docker-suite.ts:49

Whether to reuse the same container instance across tests.