Class GenericContainer

Hierarchy

GenericContainer
- GenericContainer

Index

Constructors

Properties

contentsToCopy createOpts directoriesToCopy environment exposedPorts filesToCopy hostConfig imageName logConsumer? networkAliases networkMode? postStartHook? pullPolicy reuse startupTimeout? waitStrategy

Accessors

hasExposedPorts

Constructors

constructor

new GenericContainer(image): GenericContainer
Parameters
- image: string
Returns GenericContainer
Inherited from TCGenericContainer.constructor
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:29

Properties

`Protected` contentsToCopy

contentsToCopy: ContentToCopy[]

`Protected` createOpts

createOpts: ContainerCreateOptions

`Protected` directoriesToCopy

directoriesToCopy: FileToCopy[]

`Protected` environment

environment: Record<string, string>

`Protected` exposedPorts

exposedPorts: PortWithOptionalBinding[]

`Protected` filesToCopy

filesToCopy: FileToCopy[]

`Protected` hostConfig

hostConfig: HostConfig

`Protected` imageName

imageName: ImageName

`Protected` `Optional` logConsumer

logConsumer?: ((stream) => unknown)

Type declaration

- (stream): unknown
- Parameters
  - stream: Readable
  Returns unknown

`Protected` networkAliases

networkAliases: string[]

`Protected` `Optional` networkMode

networkMode?: string

`Private` `Optional` postStartHook

postStartHook?: SyncOrAsyncHook<[StartedTestContainer]> = undefined

`Protected` pullPolicy

pullPolicy: ImagePullPolicy

`Protected` reuse

reuse: boolean

`Protected` `Optional` startupTimeout

startupTimeout?: number

`Protected` waitStrategy

waitStrategy: WaitStrategy

Accessors

`Protected` hasExposedPorts

get hasExposedPorts(): boolean
Returns boolean
Inherited from TCGenericContainer.hasExposedPorts
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:55

Methods

`Protected` `Optional` beforeContainerCreated

beforeContainerCreated(): Promise<void>
Returns Promise<void>
Inherited from TCGenericContainer.beforeContainerCreated
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:32

`Protected` `Optional` containerCreated

containerCreated(containerId): Promise<void>
Parameters
- containerId: string
Returns Promise<void>
Inherited from TCGenericContainer.containerCreated
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:33

`Protected` `Optional` containerStarted

containerStarted(container, inspectResult, reused): Promise<void>
Parameters
- container: StartedTestContainer
- inspectResult: InspectResult
- reused: boolean
Returns Promise<void>
Inherited from TCGenericContainer.containerStarted
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:41

`Protected` `Optional` containerStarting

containerStarting(inspectResult, reused): Promise<void>
Parameters
- inspectResult: InspectResult
- reused: boolean
Returns Promise<void>
Inherited from TCGenericContainer.containerStarting
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:34

onStart

onStart(hook): GenericContainer
Parameters
- hook: SyncOrAsyncHook<[StartedTestContainer]>
Returns GenericContainer
- Defined in src/generic-container.ts:17

start

start(): Promise<StartedTestContainer>
Returns Promise<StartedTestContainer>
Overrides TCGenericContainer.start
- Defined in src/generic-container.ts:11

withAddedCapabilities

withAddedCapabilities(...capabilities): GenericContainer
Parameters
- Rest ...capabilities: string[]
Returns GenericContainer
Inherited from TCGenericContainer.withAddedCapabilities
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:49

withBindMounts

withBindMounts(bindMounts): GenericContainer
Parameters
- bindMounts: BindMount[]
Returns GenericContainer
Inherited from TCGenericContainer.withBindMounts
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:57

withCommand

withCommand(command): GenericContainer
Parameters
- command: string[]
Returns GenericContainer
Inherited from TCGenericContainer.withCommand
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:42

withCopyContentToContainer

withCopyContentToContainer(contentsToCopy): GenericContainer
Parameters
- contentsToCopy: ContentToCopy[]
Returns GenericContainer
Inherited from TCGenericContainer.withCopyContentToContainer
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:69

withCopyDirectoriesToContainer

withCopyDirectoriesToContainer(directoriesToCopy): GenericContainer
Parameters
- directoriesToCopy: FileToCopy[]
Returns GenericContainer
Inherited from TCGenericContainer.withCopyDirectoriesToContainer
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:68

withCopyFilesToContainer

withCopyFilesToContainer(filesToCopy): GenericContainer
Parameters
- filesToCopy: FileToCopy[]
Returns GenericContainer
Inherited from TCGenericContainer.withCopyFilesToContainer
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:67

withDefaultLogDriver

withDefaultLogDriver(): GenericContainer
Returns GenericContainer
Inherited from TCGenericContainer.withDefaultLogDriver
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:61

withDroppedCapabilities

withDroppedCapabilities(...capabilities): GenericContainer
Parameters
- Rest ...capabilities: string[]
Returns GenericContainer
Inherited from TCGenericContainer.withDroppedCapabilities
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:50

withEntrypoint

withEntrypoint(entrypoint): GenericContainer
Parameters
- entrypoint: string[]
Returns GenericContainer
Inherited from TCGenericContainer.withEntrypoint
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:43

withEnvironment

withEnvironment(environment): GenericContainer
Parameters
- environment: Environment
Returns GenericContainer
Inherited from TCGenericContainer.withEnvironment
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:46

withExposedPorts

withExposedPorts(...ports): GenericContainer
Parameters
- Rest ...ports: PortWithOptionalBinding[]
Returns GenericContainer
Inherited from TCGenericContainer.withExposedPorts
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:56

withExtraHosts

withExtraHosts(extraHosts): GenericContainer
Parameters
- extraHosts: ExtraHost[]
Returns GenericContainer
Inherited from TCGenericContainer.withExtraHosts
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:54

withHealthCheck

withHealthCheck(healthCheck): GenericContainer
Parameters
- healthCheck: HealthCheck
Returns GenericContainer
Inherited from TCGenericContainer.withHealthCheck
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:58

withIpcMode

withIpcMode(ipcMode): GenericContainer
Parameters
- ipcMode: string
Returns GenericContainer
Inherited from TCGenericContainer.withIpcMode
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:66

withLabels

withLabels(labels): GenericContainer
Parameters
- labels: Labels
Returns GenericContainer
Inherited from TCGenericContainer.withLabels
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:45

withLogConsumer

withLogConsumer(logConsumer): GenericContainer
Parameters
- logConsumer: ((stream) => unknown)
  - - (stream): unknown
    - Parameters
      
      stream: Readable
      
      Returns unknown
Returns GenericContainer
Inherited from TCGenericContainer.withLogConsumer
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:73

withName

withName(name): GenericContainer
Parameters
- name: string
Returns GenericContainer
Inherited from TCGenericContainer.withName
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:44

withNetwork

withNetwork(network): GenericContainer
Parameters
- network: StartedNetwork
Returns GenericContainer
Inherited from TCGenericContainer.withNetwork
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:51

withNetworkAliases

withNetworkAliases(...networkAliases): GenericContainer
Parameters
- Rest ...networkAliases: string[]
Returns GenericContainer
Inherited from TCGenericContainer.withNetworkAliases
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:53

withNetworkMode

withNetworkMode(networkMode): GenericContainer
Parameters
- networkMode: string
Returns GenericContainer
Inherited from TCGenericContainer.withNetworkMode
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:52

withPrivilegedMode

withPrivilegedMode(): GenericContainer
Returns GenericContainer
Inherited from TCGenericContainer.withPrivilegedMode
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:62

withPullPolicy

withPullPolicy(pullPolicy): GenericContainer
Parameters
- pullPolicy: ImagePullPolicy
Returns GenericContainer
Inherited from TCGenericContainer.withPullPolicy
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:65

withResourcesQuota

withResourcesQuota(__namedParameters): GenericContainer
Parameters
- __namedParameters: ResourcesQuota
Returns GenericContainer
Inherited from TCGenericContainer.withResourcesQuota
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:71

withReuse

withReuse(): GenericContainer
Returns GenericContainer
Inherited from TCGenericContainer.withReuse
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:64

withSharedMemorySize

withSharedMemorySize(bytes): GenericContainer
Parameters
- bytes: number
Returns GenericContainer
Inherited from TCGenericContainer.withSharedMemorySize
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:72

withStartupTimeout

withStartupTimeout(startupTimeoutMs): GenericContainer
Parameters
- startupTimeoutMs: number
Returns GenericContainer
Inherited from TCGenericContainer.withStartupTimeout
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:59

withTmpFs

withTmpFs(tmpFs): GenericContainer
Parameters
- tmpFs: TmpFs
Returns GenericContainer
Inherited from TCGenericContainer.withTmpFs
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:47

withUlimits

withUlimits(ulimits): GenericContainer
Parameters
- ulimits: Ulimits
Returns GenericContainer
Inherited from TCGenericContainer.withUlimits
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:48

withUser

withUser(user): GenericContainer
Parameters
- user: string
Returns GenericContainer
Inherited from TCGenericContainer.withUser
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:63

withWaitStrategy

withWaitStrategy(waitStrategy): GenericContainer
Parameters
- waitStrategy: WaitStrategy
Returns GenericContainer
Inherited from TCGenericContainer.withWaitStrategy
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:60

withWorkingDir

withWorkingDir(workingDir): GenericContainer
Parameters
- workingDir: string
Returns GenericContainer
Inherited from TCGenericContainer.withWorkingDir
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:70

`Static` fromDockerfile

fromDockerfile(context, dockerfileName?): GenericContainerBuilder
Parameters
- context: string
- Optional dockerfileName: string
Returns GenericContainerBuilder
Inherited from TCGenericContainer.fromDockerfile
- Defined in node_modules/testcontainers/build/generic-container/generic-container.d.ts:13

Class GenericContainer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

image: string

Returns GenericContainer

Properties

Protected contentsToCopy

Protected createOpts

Protected directoriesToCopy

Protected environment

Protected exposedPorts

Protected filesToCopy

Protected hostConfig

Protected imageName

Protected Optional logConsumer

Type declaration

Parameters

stream: Readable

Returns unknown

Protected networkAliases

Protected Optional networkMode

Private Optional postStartHook

Protected pullPolicy

Protected reuse

Protected Optional startupTimeout

Protected waitStrategy

Accessors

Protected hasExposedPorts

Returns boolean

Methods

Protected Optional beforeContainerCreated

Returns Promise<void>

Protected Optional containerCreated

Parameters

containerId: string

Returns Promise<void>

Protected Optional containerStarted

Parameters

container: StartedTestContainer

inspectResult: InspectResult

reused: boolean

Returns Promise<void>

Protected Optional containerStarting

Parameters

inspectResult: InspectResult

reused: boolean

Returns Promise<void>

onStart

Parameters

hook: SyncOrAsyncHook<[StartedTestContainer]>

Returns GenericContainer

start

Returns Promise<StartedTestContainer>

withAddedCapabilities

Parameters

Rest ...capabilities: string[]

Returns GenericContainer

withBindMounts

Parameters

bindMounts: BindMount[]

Returns GenericContainer

withCommand

Parameters

command: string[]

Returns GenericContainer

withCopyContentToContainer

Parameters

contentsToCopy: ContentToCopy[]

Returns GenericContainer

withCopyDirectoriesToContainer

Parameters

directoriesToCopy: FileToCopy[]

Returns GenericContainer

`Protected` contentsToCopy

`Protected` createOpts

`Protected` directoriesToCopy

`Protected` environment

`Protected` exposedPorts

`Protected` filesToCopy

`Protected` hostConfig

`Protected` imageName

`Protected` `Optional` logConsumer

`Protected` networkAliases

`Protected` `Optional` networkMode

`Private` `Optional` postStartHook

`Protected` pullPolicy

`Protected` reuse

`Protected` `Optional` startupTimeout

`Protected` waitStrategy

`Protected` hasExposedPorts

`Protected` `Optional` beforeContainerCreated

`Protected` `Optional` containerCreated

`Protected` `Optional` containerStarted

`Protected` `Optional` containerStarting

`Rest` ...capabilities: string[]

`Rest` ...capabilities: string[]

`Rest` ...ports: PortWithOptionalBinding[]

`Rest` ...networkAliases: string[]