Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Take named options in `PostgreSqlContainer.withSSL`

Open Beginner friendly
  • Is something wrong?
#1,539 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
docker, postgresql, typescript
Domain
api, backend

Research direction

Start with packages/modules/postgresql/src/postgresql-container.ts and inspect PostgreSqlContainer.withSSL alongside withSSLCert and the positional overloads coordinated with #1518. Add the named-fields form while preserving the positional forms as deprecated overloads. Done when callers can pass { cert, key, ca } and the existing positional signatures remain available as deprecated overloads.

Written by the indexing model from the issue text.

Description

enhancement minor

What happens

PostgreSqlContainer has two SSL methods that take the same three file paths in different positions:

withSSL(certFile: string, keyFile: string, caCertFile?: string)
withSSLCert(caCertFile: string, certFile: string, keyFile: string)

All three are plain strings, so passing them in the wrong order compiles. The mistake shows up only when the server fails to start or a client fails to verify.

Expected

A form with named fields, for example withSSL({ cert, key, ca }), with the positional forms kept as deprecated overloads.

Where

packages/modules/postgresql/src/postgresql-container.ts.

Notes

  • withSSLCert(caCertFile, certFile, keyFile) matches Go's postgres.WithSSLCert(caCertFile, certFile, keyFile). withSSL is the one that differs.
  • Both were added in #1224.
  • The same applies to any module method that takes several paths or credentials positionally. Worth a line in the add-module skill.

Dependencies

  • Nothing blocks this. It can start now.
  • Coordinate with #1518: for the positional overloads.
Dominant language
TypeScript
Stars
2.6k
Forks
274
Avg merge
1d 14h
Merged PRs (30d)
44

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from testcontainers/testcontainers-node

All issues in testcontainers/testcontainers-node

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.