Repository navigation
Export the types used in public method signatures #1528
Description
What happens
Several types appear in public method signatures but are not exported from packages/testcontainers/src/index.ts, so consumers cannot name them. That makes it awkward to build arguments in a helper, annotate a variable, or write a wrapper.
| Type | Appears in |
|---|---|
BindMount |
withBindMounts |
TmpFs |
withTmpFs |
Ulimits |
withUlimits |
ExtraHost |
withExtraHosts |
ResourcesQuota |
withResourcesQuota |
DirectoryToCopy |
withCopyDirectoriesToContainer, copyDirectoriesToContainer |
ArchiveToCopy |
withCopyArchivesToContainer |
BuildArgs |
GenericContainerBuilder.withBuildArgs |
HttpWaitStrategy |
return type of Wait.forHttp |
CompositeWaitStrategy |
return type of Wait.forAll |
ShellWaitStrategy |
return type of Wait.forSuccessfulCommand |
StartedGenericContainer |
return type of StartedDockerComposeEnvironment.getContainer |
ComposeDownOptions |
StartedDockerComposeEnvironment.down, StoppedDockerComposeEnvironment.down |
ComposeOptions |
DockerComposeEnvironment.withClientOptions |
Reaper |
return type of getReaper |
Ports, HostPortBindings, HealthCheckStatus, NetworkSettings |
fields of the exported InspectResult |
AbstractWaitStrategy is not exported either. A custom wait strategy that is not a StartupCheckStrategy has to implement WaitStrategy directly and re-implement the timeout bookkeeping (withStartupTimeout, isStartupTimeoutSet, getStartupTimeout).
Expected
Every type that appears in an exported signature is exported from index.ts. AGENTS.md already asks for this when a type becomes part of the public API.
Where
packages/testcontainers/src/index.ts.
Notes
getContainercould return theStartedTestContainerinterface instead of exporting the concreteStartedGenericContainerclass.npm run knipdoes not catch these, because the types are used by other files.- A check that fails when an exported signature references an unexported type would stop this recurring.
Dependencies
- Nothing blocks this. It can start now.
Activity