docs: correct inaccurate Retry-After term ("timeout" → "delay")#870
Merged
sindresorhus merged 1 commit intoJun 22, 2026
Merged
Conversation
The Retry-After docs described the header value as a "date, timeout, or timestamp", but "timeout" is not one of the accepted forms. Per the HTTP spec the value is a delay in seconds or an HTTP date, and Ky additionally treats a large number as a Unix timestamp (source/core/Ky.ts). Replace the inaccurate "timeout" with "delay" in the readme and the matching JSDoc.
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
2 participants
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.
The retry documentation describes the
Retry-Afterheader value as a "date, timeout, or timestamp". "timeout" isn't one of the accepted forms.Per the HTTP spec the value is either a delay in seconds or an HTTP date, and ky additionally treats a large number as a Unix timestamp (
source/core/Ky.ts). So the accurate set is delay / date / timestamp.This replaces the inaccurate "timeout" with "delay" in the readme and the matching JSDoc in
source/types/options.ts. Docs-only, no behavior change.