Час очікування запиту на отримання API?

У мене є fetch-api POSTзапит:

fetch(url, {
  method: 'POST',
  body: formData,
  credentials: 'include'
})

Я хочу знати, який час очікування за замовчуванням для цього? і як ми можемо встановити для нього певне значення, наприклад 3 секунди або невизначені секунди?

Редагувати 1

Як зазначалося в коментарях, код у вихідній відповіді продовжує працювати таймер навіть після того, як обіцянка буде вирішена / відхилена.

Код нижче виправляє цю проблему.

function timeout(ms, promise) {
  return new Promise((resolve, reject) => {
    const timer = setTimeout(() => {
      reject(new Error('TIMEOUT'))
    }, ms)

    promise
      .then(value => {
        clearTimeout(timer)
        resolve(value)
      })
      .catch(reason => {
        clearTimeout(timer)
        reject(reason)
      })
  })
}

Оригінальна відповідь

Він не має вказаного за замовчуванням; специфікація взагалі не обговорює тайм-аути.

Ви можете застосувати власну обгортку тайм-ауту для обіцянок загалом:

// Rough implementation. Untested.
function timeout(ms, promise) {
  return new Promise(function(resolve, reject) {
    setTimeout(function() {
      reject(new Error("timeout"))
    }, ms)
    promise.then(resolve, reject)
  })
}

timeout(1000, fetch('/hello')).then(function(response) {
  // process response
}).catch(function(error) {
  // might be a timeout error
})

Як описано в https://github.com/github/fetch/issues/175 Коментар https://github.com/mislav

Мені дуже подобається чіткий підхід цього суті за допомогою Promise.race

fetchWithTimeout.js

export default function (url, options, timeout = 7000) {
    return Promise.race([
        fetch(url, options),
        new Promise((_, reject) =>
            setTimeout(() => reject(new Error('timeout')), timeout)
        )
    ]);
}

main.js

import fetch from './fetchWithTimeout'

// call as usual or with timeout as 3rd argument

fetch('http://google.com', options, 5000) // throw after max 5 seconds timeout error
.then((result) => {
    // handle result
})
.catch((e) => {
    // handle errors and timeout error
})

Використовуючи AbortController , ви зможете зробити це:

const controller = new AbortController();
const signal = controller.signal;

const fetchPromise = fetch(url, {signal});

// 5 second timeout:
const timeoutId = setTimeout(() => controller.abort(), 5000);


fetchPromise.then(response => {
  // completed request before timeout fired

  // If you only wanted to timeout the request, not the response, add:
  // clearTimeout(timeoutId);
})

Спираючись на чудову відповідь Endless , я створив корисну функцію утиліти.

const fetchTimeout = (url, ms, { signal, ...options } = {}) => {
    const controller = new AbortController();
    const promise = fetch(url, { signal: controller.signal, ...options });
    if (signal) signal.addEventListener("abort", () => controller.abort());
    const timeout = setTimeout(() => controller.abort(), ms);
    return promise.finally(() => clearTimeout(timeout));
};

1. Якщо тайм-аут досягнуто до отримання ресурсу, тоді отримання скасовано.
2. Якщо ресурс отримується до досягнення часу очікування, час очікування очищається.
3. Якщо вхідний сигнал перервано, тоді вилучення перервано, і час очікування очищений.

const controller = new AbortController();

document.querySelector("button.cancel").addEventListener("click", () => controller.abort());

fetchTimeout("example.json", 5000, { signal: controller.signal })
    .then(response => response.json())
    .then(console.log)
    .catch(error => {
        if (error.name === "AbortError") {
            // fetch aborted either due to timeout or due to user clicking the cancel button
        } else {
            // network error or json parsing error
        }
    });

Сподіваюся, що це допомагає.

в API вибору поки немає підтримки часу очікування. Але цього можна досягти, обгорнувши це обіцянкою.

наприклад,

  function fetchWrapper(url, options, timeout) {
    return new Promise((resolve, reject) => {
      fetch(url, options).then(resolve, reject);

      if (timeout) {
        const e = new Error("Connection timed out");
        setTimeout(reject, timeout, e);
      }
    });
  }

РЕДАГУВАТИ : Запит на отримання все ще буде виконуватися у фоновому режимі і, швидше за все, буде відображати помилку у вашій консолі.

Дійсно, Promise.raceпідхід кращий.

Див. Це посилання для довідки Promise.race ()

Перегон означає, що всі обіцянки будуть виконуватися одночасно, і перегони припиняться, як тільки одна з обіцянок поверне значення. Тому буде повернуто лише одне значення . Ви також можете передати функцію для виклику, якщо час вибору закінчується.

fetchWithTimeout(url, {
  method: 'POST',
  body: formData,
  credentials: 'include',
}, 5000, () => { /* do stuff here */ });

Якщо це викликає у вас інтерес, можливою реалізацією буде:

function fetchWithTimeout(url, options, delay, onTimeout) {
  const timer = new Promise((resolve) => {
    setTimeout(resolve, delay, {
      timeout: true,
    });
  });
  return Promise.race([
    fetch(url, options),
    timer
  ]).then(response => {
    if (response.timeout) {
      onTimeout();
    }
    return response;
  });
}

Ви можете створити обгортку timeoutPromise

function timeoutPromise(timeout, err, promise) {
  return new Promise(function(resolve,reject) {
    promise.then(resolve,reject);
    setTimeout(reject.bind(null,err), timeout);
  });
}

Потім можна обернути будь-яку обіцянку

timeoutPromise(100, new Error('Timed Out!'), fetch(...))
  .then(...)
  .catch(...)  

Це насправді не скасує базового з'єднання, але дозволить вам очікувати обіцянки.
Довідково

Якщо ви не налаштували час очікування у своєму коді, це буде час очікування запиту за замовчуванням для вашого браузера.

1) Firefox - 90 секунд

Введіть about:configполе URL-адреси Firefox. Знайдіть значення, яке відповідає ключуnetwork.http.connection-timeout

2) Хром - 300 секунд

Джерело

  fetchTimeout (url,options,timeout=3000) {
    return new Promise( (resolve, reject) => {
      fetch(url, options)
      .then(resolve,reject)
      setTimeout(reject,timeout);
    })
  }

За допомогою c-promis2 lib скасовуване завантаження з таймаутом може виглядати так ( демонстрація Live jsfiddle ):

import CPromise from "c-promise2"; // npm package

function fetchWithTimeout(url, {timeout, ...fetchOptions}= {}) {
    return new CPromise((resolve, reject, {signal}) => {
        fetch(url, {...fetchOptions, signal}).then(resolve, reject)
    }, timeout)
}
        
const chain = fetchWithTimeout("https://run.mocky.io/v3/753aa609-65ae-4109-8f83-9cfe365290f0?mocky-delay=10s", {timeout: 5000})
    .then(request=> console.log('done'));
    
// chain.cancel(); - to abort the request before the timeout

Цей код як пакет npm cp-fetch