Skip to content

Add remaining HTTP setting typings#785

Open
popsiclelmlm wants to merge 1 commit into
ClickHouse:mainfrom
popsiclelmlm:docs/http-settings-typings
Open

Add remaining HTTP setting typings#785
popsiclelmlm wants to merge 1 commit into
ClickHouse:mainfrom
popsiclelmlm:docs/http-settings-typings

Conversation

@popsiclelmlm
Copy link
Copy Markdown

Summary

Fixes #53.

Adds explicit ClickHouseSettings typings for several HTTP query parameters that ClickHouse handles outside the regular server settings set.

Reproduction

Before this change, these HTTP parameters could still be passed because ClickHouseSettings allows arbitrary keys, but TypeScript users did not get autocomplete or documentation for them.

Root cause

ClickHouseHTTPSettings only listed part of the HTTP-specific parameter surface.

Changes

  • Add typings for quota_key, stacktrace, buffer_size, and close_session.
  • Document that buffer_size is deprecated in favor of http_response_buffer_size.

Tests

  • git diff --check
  • npm --workspace @clickhouse/client-common run typecheck
  • npm --workspace @clickhouse/client-common run lint

Changelog

@clickhouse/client-common: add typings for additional HTTP settings.

Copilot AI review requested due to automatic review settings May 31, 2026 11:39
@popsiclelmlm popsiclelmlm requested a review from mshustov as a code owner May 31, 2026 11:39
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 31, 2026

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add typings for the remaining HTTP settings

2 participants