Skip to content

Update dependency ky to v2#1712

Open
renovate[bot] wants to merge 1 commit intomainfrom
renovate/ky-2.x
Open

Update dependency ky to v2#1712
renovate[bot] wants to merge 1 commit intomainfrom
renovate/ky-2.x

Conversation

@renovate
Copy link
Copy Markdown
Contributor

@renovate renovate bot commented Apr 9, 2026

This PR contains the following updates:

Package Change Age Confidence
ky 1.14.32.0.1 age confidence

Release Notes

sindresorhus/ky (ky)

v2.0.1

Compare Source

  • Improve compatibility with custom fetch implementations (#​858) 2971991
  • Fix fetch option forwarding 2df9b7e

v2.0.0

Compare Source

Breaking
New
Fixes
  • Fix beforeRequest hooks being skipped when a Request is returned (#​832) aec65db
  • Ignore non-Errors returned by beforeError hooks (#​833) a541fc0

Migration guide

Hook signatures

All hooks now receive a single state object instead of separate arguments.

hooks: {
-	beforeRequest: [(request, options) => {
+	beforeRequest: [({request, options}) => {
		request.headers.set('X-Custom', 'value');
	}],
-	afterResponse: [(request, options, response) => {
+	afterResponse: [({request, options, response}) => {
		log(response.status);
	}],
-	beforeRetry: [({request, options, error, retryCount}) => {
+	beforeRetry: [({request, options, error, retryCount}) => {
		// Same as before - beforeRetry already used an object
	}],
-	beforeError: [(error) => {
+	beforeError: [({error}) => {
		return error;
	}],
}
prefixUrl renamed to prefix
-ky('users', {prefixUrl: 'https://example.com/api/'});
+ky('users', {prefix: 'https://example.com/api/'});

Leading slashes in input are now allowed with prefix. There's also a new baseUrl option for standard URL resolution, which you may prefer over prefix.

beforeError hook receives all errors

Previously only received HTTPError. Now receives all error types. Use type guards:

+import {isHTTPError} from 'ky';

hooks: {
	beforeError: [
-		(error) => {
-			const {response} = error;
+		({error}) => {
+			if (isHTTPError(error)) {
+				const {response} = error;
+			}

			return error;
		}
	]
}
.json() on empty responses

.json() now throws a parse error on empty bodies and 204 responses instead of returning an empty string. This aligns with native JSON.parse behavior and surfaces the real issue; your code expected JSON but the server sent none.

Check the status before calling .json() if you expect empty responses:

const response = await ky('https://example.com/api');

if (response.status !== 204) {
    const data = await response.json();
}
Ky-specific options stripped from hooks

Ky-specific properties (hooks, json, parseJson, stringifyJson, searchParams, timeout, throwHttpErrors, fetch) are no longer available on the options object passed to hooks. If you need access to these values, store them in a variable outside the hook or use the context option to pass data between hooks.

searchParams merging

searchParams now merges with existing query parameters in the input URL instead of replacing them.

// v1: searchParams replaces ?existing=1
// v2: searchParams merges with ?existing=1
ky('https://example.com?existing=1', {searchParams: {added: 2}});
// => https://example.com?existing=1&added=2
HTTPError response body

error.response.json() and other body methods no longer work since the body is now automatically consumed. Use error.data instead, which has the pre-parsed response body immediately available.

-const body = await error.response.json();
-console.log(body.message);
+console.log(error.data.message);

This fixes resource leaks when catching HTTPError without consuming the body (#​633) and makes error details synchronously available (#​642). We considered cloning the response to keep both paths working, but that doubles memory usage for error bodies and adds edge cases around locked/large streams for little benefit. error.response is still available for headers and status.

Upgrading from 2.0.0-0

.json() on empty responses

The behavior changed again from the prerelease. .json() now throws instead of returning undefined for empty bodies and 204 responses. The return type is back to Promise<T> (no more | undefined).


Thanks to @​sholladay for helping with this update.



Configuration

📅 Schedule: (UTC)

  • Branch creation
    • At any time (no schedule defined)
  • Automerge
    • Between 07:00 AM and 04:59 PM, only on Monday, Tuesday, Wednesday, and Thursday (* 7-16 * * 1,2,3,4)

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/ky-2.x branch from a396da0 to 2d560e5 Compare April 9, 2026 16:18
@renovate renovate bot force-pushed the renovate/ky-2.x branch from 2d560e5 to 9632ee3 Compare April 13, 2026 07:04
@renovate renovate bot force-pushed the renovate/ky-2.x branch from 9632ee3 to 82f7916 Compare April 13, 2026 11:44
@renovate renovate bot force-pushed the renovate/ky-2.x branch 2 times, most recently from 4fdf954 to c6ce366 Compare April 13, 2026 12:34
@renovate renovate bot force-pushed the renovate/ky-2.x branch from c6ce366 to 07e23ba Compare April 13, 2026 15:45
@renovate renovate bot force-pushed the renovate/ky-2.x branch from 07e23ba to dec36c6 Compare April 14, 2026 07:56
@renovate renovate bot force-pushed the renovate/ky-2.x branch from dec36c6 to d201078 Compare April 14, 2026 11:42
@renovate renovate bot force-pushed the renovate/ky-2.x branch from d201078 to 1bc9baa Compare April 16, 2026 13:50
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.

0 participants