Allow to specify timeout for single request in additional for total timeout including retries

[mahnunchik]

Hi,

I'm migrating from axios and axios-retry module.

I've faced with the issue that I can specify only total timeout including any retries.

It would be helpful to have ability to specify:

• timeout for single request/?response (for example 10000ms)
• total timeout (for example 30000ms)

axios-retry has shouldResetTimeout option which solves this task https://github.com/softonic/axios-retry/#options

[silas]

This might be a solution for some people (via ky@1.10.0):

import ky from "ky";

await ky.get("https://example.com", {
  timeout: false,
  signal: AbortSignal.timeout(30_000),
  hooks: {
    beforeRequest: [
      (request, options) => {
        const signal = AbortSignal.timeout(5_000);

        return new Request(request, {
          signal: options.signal ? AbortSignal.any([signal, options.signal]) : signal,
        });
      },
    ],
  },
});

Since this disables the builtin timeout, obviously it won't throw TimeoutError anymore.

You can try this method out using the pie.dev/delay/3 endpoint:

import ky from "ky";

let timeout = 500;

const data = await ky
  .get("https://pie.dev/delay/3", {
    timeout: false,
    retry: 5,
    signal: AbortSignal.timeout(10_000),
    hooks: {
      beforeRequest: [
        (request, options) => {
          timeout += 1000;

          console.log(`Request timeout ${timeout}`);

          const signal = AbortSignal.timeout(timeout);

          return new Request(request, {
            signal: options.signal ? AbortSignal.any([signal, options.signal]) : signal,
          });
        },
      ],
    },
  })
  .json();

console.log(data);