Skip to content

docs: correct request timeout units to seconds #544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pcbeingused333 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: correct request timeout units to seconds #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2819,23 +2819,23 @@ declare namespace PubNub {
*/
heartbeatInterval?: number;
/**
* Transactional requests timeout in milliseconds.
* Transactional requests timeout in seconds.
*
* Maximum duration for which PubNub client should wait for transactional request completion.
*
* @default `15` seconds
*/
transactionalRequestTimeout?: number;
/**
* Subscription requests timeout in milliseconds.
* Subscription requests timeout in seconds.
*
* Maximum duration for which PubNub client should wait for subscription request completion.
*
* @default `310` seconds
*/
subscribeRequestTimeout?: number;
/**
* File upload / download request timeout in milliseconds.
* File upload / download request timeout in seconds.
*
* Maximum duration for which PubNub client should wait for file upload / download request
* completion.
Expand Down
12 changes: 6 additions & 6 deletions src/core/interfaces/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ export type UserConfiguration = {
heartbeatInterval?: number;

/**
* Transactional requests timeout in milliseconds.
* Transactional requests timeout in seconds.
*
* Maximum duration for which PubNub client should wait for transactional request completion.
*
Expand All @@ -229,7 +229,7 @@ export type UserConfiguration = {
transactionalRequestTimeout?: number;

/**
* Subscription requests timeout in milliseconds.
* Subscription requests timeout in seconds.
*
* Maximum duration for which PubNub client should wait for subscription request completion.
*
Expand All @@ -238,7 +238,7 @@ export type UserConfiguration = {
subscribeRequestTimeout?: number;

/**
* File upload / download request timeout in milliseconds.
* File upload / download request timeout in seconds.
*
* Maximum duration for which PubNub client should wait for file upload / download request
* completion.
Expand Down Expand Up @@ -682,23 +682,23 @@ export interface PrivateClientConfiguration
/**
* Transactional request timeout.
*
* @returns Maximum duration in milliseconds for which PubNub client should wait for
* @returns Maximum duration in seconds for which PubNub client should wait for
* transactional request completion.
*/
getTransactionTimeout(): number;

/**
* Subscription requests timeout.
*
* @returns Maximum duration in milliseconds for which PubNub client should wait for
* @returns Maximum duration in seconds for which PubNub client should wait for
* subscription request completion.
*/
getSubscribeTimeout(): number;

/**
* File requests timeout.
*
* @returns Maximum duration in milliseconds for which PubNub client should wait for
* @returns Maximum duration in seconds for which PubNub client should wait for
* file upload / download request completion.
*/
getFileTimeout(): number;
Expand Down