@ethersphere/bee-js 5.0.0 → 6.0.0-pre.0

package/dist/types/types/ky-universal/hooks.d.ts

@@ -1,92 +0,0 @@
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-import type { NormalizedOptions } from '../ky-options';
-export declare const stop: unique symbol;
-export declare type BeforeRequestHook = (request: Request, options: NormalizedOptions) => Request | Response | void | Promise<Request | Response | void>;
-export declare type BeforeRetryState = {
-    request: Request;
-    response: Response;
-    options: NormalizedOptions;
-    error: Error;
-    retryCount: number;
-};
-export declare type BeforeRetryHook = (options: BeforeRetryState) => typeof stop | void | Promise<typeof stop | void>;
-export declare type AfterResponseHook = (request: Request, options: NormalizedOptions, response: Response) => Response | void | Promise<Response | void>;
-export interface Hooks {
-    /**
-     This hook enables you to modify the request right before it is sent. Ky will make no further changes to the request after this. The hook function receives normalized input and options as arguments. You could, forf example, modiy `options.headers` here.
-  
-     A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) can be returned from this hook to completely avoid making a HTTP request. This can be used to mock a request, check an internal cache, etc. An **important** consideration when returning a `Response` from this hook is that all the following hooks will be skipped, so **ensure you only return a `Response` from the last hook**.
-  
-     @default []
-     */
-    beforeRequest?: BeforeRequestHook[];
-    /**
-     This hook enables you to modify the request right before retry. Ky will make no further changes to the request after this. The hook function receives an object with the normalized request and options, an error instance, and the retry count. You could, for example, modify `request.headers` here.
-  
-     If the request received a response, the error will be of type `HTTPError` and the `Response` object will be available at `error.response`. Be aware that some types of errors, such as network errors, inherently mean that a response was not received. In that case, the error will not be an instance of `HTTPError`.
-  
-     You can prevent Ky from retrying the request by throwing an error. Ky will not handle it in any way and the error will be propagated to the request initiator. The rest of the `beforeRetry` hooks will not be called in this case. Alternatively, you can return the [`ky.stop`](#ky.stop) symbol to do the same thing but without propagating an error (this has some limitations, see `ky.stop` docs for details).
-  
-     @example
-     ```
-     import ky from 'ky';
-  
-     const response = await ky('https://example.com', {
-          hooks: {
-              beforeRetry: [
-                  async ({request, options, error, retryCount}) => {
-                      const token = await ky('https://example.com/refresh-token');
-                      options.headers.set('Authorization', `token ${token}`);
-                  }
-              ]
-          }
-      });
-     ```
-  
-     @default []
-     */
-    beforeRetry?: BeforeRetryHook[];
-    /**
-     This hook enables you to read and optionally modify the response. The hook function receives normalized input, options, and a clone of the response as arguments. The return value of the hook function will be used by Ky as the response object if it's an instance of [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response).
-  
-     @default []
-  
-     @example
-     ```
-     import ky from 'ky';
-  
-     const response = await ky('https://example.com', {
-          hooks: {
-              afterResponse: [
-                  (_input, _options, response) => {
-                      // You could do something with the response, for example, logging.
-                      log(response);
-  
-                      // Or return a `Response` instance to overwrite the response.
-                      return new Response('A different response', {status: 200});
-                  },
-  
-                  // Or retry with a fresh token on a 403 error
-                  async (input, options, response) => {
-                      if (response.status === 403) {
-                          // Get a fresh token
-                          const token = await ky('https://example.com/token').text();
-  
-                          // Retry with the token
-                          options.headers.set('Authorization', `token ${token}`);
-  
-                          return ky(input, options);
-                      }
-                  }
-              ]
-          }
-      });
-     ```
-     */
-    afterResponse?: AfterResponseHook[];
-}

package/dist/types/types/ky-universal/retry.d.ts

@@ -1,38 +0,0 @@
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-export interface RetryOptions {
-    /**
-     The number of times to retry failed requests.
-  
-     @default 2
-     */
-    limit?: number;
-    /**
-     The HTTP methods allowed to retry.
-  
-     @default ['get', 'put', 'head', 'delete', 'options', 'trace']
-     */
-    methods?: string[];
-    /**
-     The HTTP status codes allowed to retry.
-  
-     @default [408, 413, 429, 500, 502, 503, 504]
-     */
-    statusCodes?: number[];
-    /**
-     The HTTP status codes allowed to retry with a `Retry-After` header.
-  
-     @default [413, 429, 503]
-     */
-    afterStatusCodes?: number[];
-    /**
-     If the `Retry-After` header is greater than `maxRetryAfter`, the request will be canceled.
-  
-     @default Infinity
-     */
-    maxRetryAfter?: number;
-}