Create a new Ky instance with complete new defaults.
OptionaldefaultOptions: OptionsA new Ky instance.
Fetch the given url using the option {method: 'delete'}.
Create a new Ky instance with some defaults overridden with your own.
In contrast to ky.create(), ky.extend() inherits defaults from its parent.
You can also refer to parent defaults by providing a function to .extend().
A new Ky instance.
import ky from 'ky';
const api = ky.create({prefixUrl: 'https://example.com/api'});
const usersApi = api.extend((options) => ({prefixUrl: `${options.prefixUrl}/users`}));
const response = await usersApi.get('123');
//=> 'https://example.com/api/users/123'
const response = await api.get('version');
//=> 'https://example.com/api/version'
Fetch the given url using the option {method: 'get'}.
Fetch the given url using the option {method: 'head'}.
Request object, URL object, or URL string.
Optionaloptions: OptionsA promise with Body methods added.
Fetch the given url using the option {method: 'patch'}.
Fetch the given url using the option {method: 'post'}.
Fetch the given url using the option {method: 'put'}.
ReadonlystopA Symbol that can be returned by a beforeRetry hook to stop the retry. This will also short circuit the remaining beforeRetry hooks.
Note: Returning this symbol makes Ky abort and return with an undefined response. Be sure to check for a response before accessing any properties on it or use optional chaining. It is also incompatible with body methods, such as .json() or .text(), because there is no response to parse. In general, we recommend throwing an error instead of returning this symbol, as that will cause Ky to abort and then throw, which avoids these limitations.
A valid use-case for ky.stop is to prevent retries when making requests for side effects, where the returned data is not important. For example, logging client activity to the server.
import ky from 'ky';
const options = {
hooks: {
beforeRetry: [
async ({request, options, error, retryCount}) => {
const shouldStopRetry = await ky('https://example.com/api');
if (shouldStopRetry) {
return ky.stop;
}
}
]
}
};
// Note that response will be `undefined` in case `ky.stop` is returned.
const response = await ky.post('https://example.com', options);
// Using `.text()` or other body methods is not supported.
const text = await ky('https://example.com', options).text();
API 请求函数，继承自 ky