Skip to content

docs(boxsdkgen): add documentation about default timeout (box/box-codegen#944) #1421

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
box-sdk-build wants to merge 3 commits into
base: combined-sdk
Choose a base branch
from
+2 −1
Open

docs(boxsdkgen): add documentation about default timeout (box/box-codegen#944) #1421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14d58b8
chore: Update `.codegen.json` with commit hash of `codegen` and `open…
box-sdk-build Apr 22, 2026
0d4f601
chore: Update `.codegen.json` with commit hash of `codegen` and `open…
box-sdk-build Apr 24, 2026
b1421a4
docs: add documentation about default timeout (box/box-codegen#944)
box-sdk-build Apr 28, 2026
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
2 changes: 1 addition & 1 deletion .codegen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "450fb53", "specHash": "d0976fc", "version": "4.7.0" }
{ "engineHash": "18868e7", "specHash": "d0976fc", "version": "4.7.0" }
1 change: 1 addition & 0 deletions docs/sdk-gen/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ const client = new BoxClient({ auth, networkSession });

How timeout handling works:

- The SDK does not apply any timeout by default. Without explicit configuration, requests will wait indefinitely for a response.
- The SDK applies timeout only when `timeoutMs` is provided and greater than `0`.
- To disable SDK timeout handling, set `timeoutMs` to `0` (or a negative value), or omit `timeoutMs`.
- On timeout, the request is aborted and treated as a network error (`Connection timeout after <timeoutMs>ms`); if retries are exhausted, the SDK throws `BoxSdkError`.
Expand Down
Loading