Skip to content

docs: correct request timeout units to seconds - #544

Open
pcbeingused333 wants to merge 1 commit into
pubnub:masterfrom
pcbeingused333:fix/c2734-timeout-docs
Open

pcbeingused333 wants to merge 1 commit into
pubnub:masterfrom
pcbeingused333:fix/c2734-timeout-docs

Conversation

@pcbeingused333

Copy link
Copy Markdown

Fixes #537

The request timeout options and their getters describe milliseconds, but the configuration values are seconds and transports convert them to milliseconds. Correct the six JSDoc comments in the configuration interface and the three corresponding option comments in the published type declarations. Defaults and runtime behavior are unchanged.

Testing and validation

A focused documentation check fails against master and passes all nine assertions with this change. git diff --check passes.

Dependency installation (npm ci --ignore-scripts --no-audit --no-fund) failed with EACCES in the npm cache. Type declaration regeneration and the Node build could not run; the published declaration comments were synchronized directly with the source.

This change was prepared with assistance from an AI coding agent.

@pubnub-snyk-universal-prd

pubnub-snyk-universal-prd Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

This branch has not been deployed

No deployments
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.

timeouts are documented as milliseconds but applied as seconds

1 participant