Optional bodyA BodyInit object or null to set request's body.
Optional cacheA string indicating how the request will interact with the browser's cache to set request's cache.
Optional credentialsA string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.
Optional fetchUser-defined fetch function.
Has to be fully compatible with the Fetch API standard.
Use-cases:
fetch implementations like isomorphic-unfetch.fetch wrapper function provided by some frameworks that use server-side rendering (SSR).Optional init: RequestInitfetch
import ky from 'ky';
import fetch from 'isomorphic-unfetch';
const json = await ky('https://example.com', {fetch}).json();
Optional headersHTTP headers used to make the request.
You can pass a Headers instance or a plain object.
You can remove a header with .extend() by passing the header with an undefined value.
import ky from 'ky';
const url = 'https://sindresorhus.com';
const original = ky.create({
headers: {
rainbow: 'rainbow',
unicorn: 'unicorn'
}
});
const extended = original.extend({
headers: {
rainbow: undefined
}
});
const response = await extended(url).json();
console.log('rainbow' in response);
//=> false
console.log('unicorn' in response);
//=> true
Optional hooksHooks allow modifications during the request lifecycle. Hook functions may be async and are run serially.
Optional integrityA cryptographic hash of the resource to be fetched by request. Sets request's integrity.
Optional jsonShortcut for sending JSON. Use this instead of the body option.
Accepts any plain object or value, which will be JSON.stringify()'d and sent in the body with the correct header set.
Optional keepaliveA boolean to set request's keepalive.
Optional methodHTTP method used to make the request.
Internally, the standard methods (GET, POST, PUT, PATCH, HEAD and DELETE) are uppercased in order to avoid server errors due to case sensitivity.
Optional modeA string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.
Optional onDownload progress event handler.
Note: It's empty for the first call.
import ky from 'ky';
const response = await ky('https://example.com', {
onDownloadProgress: (progress, chunk) => {
// Example output:
// `0% - 0 of 1271 bytes`
// `100% - 1271 of 1271 bytes`
console.log(`${progress.percent * 100}% - ${progress.transferredBytes} of ${progress.totalBytes} bytes`);
}
});
Optional parseUser-defined JSON-parsing function.
Use-cases:
bourne package to protect from prototype pollution.reviver option of JSON.parse().JSON.parse()
import ky from 'ky';
import bourne from '@hapijs/bourne';
const json = await ky('https://example.com', {
parseJson: text => bourne(text)
}).json();
Optional prefixA prefix to prepend to the input URL when making the request. It can be any valid URL, either relative or absolute. A trailing slash / is optional and will be added automatically, if needed, when it is joined with input. Only takes effect when input is a string. The input argument cannot start with a slash / when using this option.
Useful when used with ky.extend() to create niche-specific Ky-instances.
Notes:
prefixUrl and input are joined, the result is resolved against the base URL of the page (if any).input are disallowed when using this option to enforce consistency and avoid confusion about how the input URL is handled, given that input will not follow the normal URL resolution rules when prefixUrl is being used, which changes the meaning of a leading slash.import ky from 'ky';
// On https://example.com
const response = await ky('unicorn', {prefixUrl: '/api'});
//=> 'https://example.com/api/unicorn'
const response = await ky('unicorn', {prefixUrl: 'https://cats.com'});
//=> 'https://cats.com/unicorn'
Optional priorityOptional redirectA string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.
Optional referrerA string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
Optional referrerA referrer policy to set request's referrerPolicy.
Optional retryAn object representing limit, methods, statusCodes and maxRetryAfter fields for maximum retry count, allowed methods, allowed status codes and maximum Retry-After time.
If retry is a number, it will be used as limit and other defaults will remain in place.
If maxRetryAfter is set to undefined, it will use options.timeout. If Retry-After header is greater than maxRetryAfter, it will cancel the request.
By default, delays between retries are calculated with the function 0.3 * (2 ** (attemptCount - 1)) * 1000, where attemptCount is the attempt number (starts from 1), however this can be changed by passing a delay function.
Retries are not triggered following a timeout.
import ky from 'ky';
const json = await ky('https://example.com', {
retry: {
limit: 10,
methods: ['get'],
statusCodes: [413]
}
}).json();
Optional searchSearch parameters to include in the request URL. Setting this will override all existing search parameters in the input URL.
Accepts any value supported by URLSearchParams().
Optional signalAn AbortSignal to set request's signal.
Optional throwThrow an HTTPError when, after following redirects, the response has a non-2xx status code. To also throw for redirects instead of following them, set the redirect option to 'manual'.
Setting this to false may be useful if you are checking for resource availability and are expecting error responses.
Note: If false, error responses are considered successful and the request will not be retried.
true
Optional timeoutTimeout in milliseconds for getting a response, including any retries. Can not be greater than 2147483647.
If set to false, there will be no timeout.
10000
Optional windowCan only be null. Used to disassociate request from any Window.
Generated using TypeDoc
Options are the same as
window.fetch, except for the KyOptions