docs(sdk): retry config, resumable downloads, UploadSessionExpiredError#70
Merged
rubenhensen merged 1 commit intomainfrom May 8, 2026
Merged
Conversation
…xpiredError Closes #68
rubenhensen
approved these changes
May 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #68.
Summary
docs/sdk/js-encryption.md: new "Retry options" section documentingPostGuardConfig.retry(defaults: 5 attempts, 500 ms initial delay, 30 s cap, 2× multiplier, full jitter), per-phase timeouts (chunkTimeoutMs,finalizeTimeoutMs,downloadTimeoutMs), retry classification rules, theonRetryhook +RetryEventshape, and the note thatinitUploadandfinalizeUploadare deliberately not retried.docs/sdk/js-decryption.md: new "Retries and resumable downloads" section covering theRange-based resume, the206 Partial Contentrequirement, the silent-rewind protection (200 OKon resume → fail-not-retry), the shared retry budget across resumes, and the v1.6 behaviour change wheredownloadFileWithRetryreturns itsReadableStreamsynchronously.docs/sdk/js-errors.md: newUploadSessionExpiredErrorrow in the hierarchy and a section with properties (uuid,reason, status 404, body) plus a usage example.Source verification
encryption4all/postguard-js@a60716e(currentmainhead).curl -sIchecked — all return HTTP 200, line ranges match the cited content (RetryOptionsinterface,downloadRangeresume logic,UploadSessionExpiredErrorclass).npm run docs:buildsucceeds; the new anchors render indist/sdk/{js-encryption,js-decryption,js-errors}.html.Reviewer quickstart
```
git fetch origin && git checkout docs/postguard-js-retry-and-resume && npm install && npm run docs:dev
```
Source PRs: encryption4all/postguard-js#47 (retry config + UploadSessionExpiredError) and encryption4all/postguard-js#52 (resumable downloads).