Skip to content

[auto-generated] [pg] Add missing enableChannelBinding option - #75378

Open
carlosalbertolajr wants to merge 1 commit into
DefinitelyTyped:masterfrom
carlosalbertolajr:fix/pg-enable-channel-binding
Open

[auto-generated] [pg] Add missing enableChannelBinding option#75378
carlosalbertolajr wants to merge 1 commit into
DefinitelyTyped:masterfrom
carlosalbertolajr:fix/pg-enable-channel-binding

Conversation

@carlosalbertolajr

@carlosalbertolajr carlosalbertolajr commented Aug 11, 2026

Copy link
Copy Markdown

pg documents enableChannelBinding as a configuration option for both Client and Pool, and the runtime reads it when selecting SCRAM-SHA-256-PLUS. However, ClientConfig currently omits the option, so documented configuration objects fail excess-property checking.

This small change adds the optional boolean to ClientConfig, from which PoolConfig and PoolOptions inherit, and exercises it through both constructors in the existing tests.

We are using this option in an application and currently need a local type intersection to express it. The option was introduced in pg@8.14.0 and is present in pg@8.21.0, which these declarations currently target, so I have not changed the package version.

Thank you for taking a look. I am happy to adjust the placement or test coverage if I have missed any package-specific convention.

If changing an existing definition:

Validation performed:

pnpm test pg
pnpm dprint check types/pg/index.d.ts types/pg/pg-tests.ts
pnpm exec tsc -p types/pg/tsconfig.json

@typescript-automation

typescript-automation Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

@carlosalbertolajr Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • 🕐 Most recent commit is approved by a DT maintainer

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 75378,
  "author": "carlosalbertolajr",
  "headCommitOid": "f67e5c5a91cce24d0795ccf68c10ce915cd0f5f2",
  "mergeBaseOid": "1b053e38fb241d5ebfa0e426e78a6133906441c0",
  "lastPushDate": "2026-08-11T20:23:19.000Z",
  "lastActivityDate": "2026-08-11T20:23:19.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "tooManyCommits": false,
  "tooManyReviews": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "pg",
      "kind": "edit",
      "files": [
        {
          "path": "types/pg/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/pg/pg-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "pspeter3"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 5258434909,
  "ciResult": "pass"
}

@typescript-automation

Copy link
Copy Markdown
Contributor

🔔 @pspeter3 — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-automation typescript-automation Bot moved this to Waiting for Code Reviews in Pull Request Status Board Aug 11, 2026
@typescript-automation typescript-automation Bot moved this from Waiting for Code Reviews to Needs Maintainer Review in Pull Request Status Board Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Needs Maintainer Review

Development

Successfully merging this pull request may close these issues.

1 participant