Skip to content

Home > @opengovsg/testcontainers > setup

setup() function ​

Start the given containers concurrently and return their connection info. Faithful port of confetti's common.ts setup, with the optional network moved into an options object.

Signature:

typescript
setup: (configurations: ContainerConfiguration[], options?: {
    network?: StartedNetwork;
}) => Promise<StartedContainerInformation[]>

Parameters ​

ParameterTypeDescription
configurationsContainerConfiguration[]
options{ network?: StartedNetwork; }(Optional)

Returns:

Promise<StartedContainerInformation[]>