@octokit/types/dist-types/RequestRequestOptions.d.ts

Shared TypeScript definitions for Octokit projects

import type { Fetch } from "./Fetch.js";
/**
 * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled
 */
export type RequestRequestOptions = {
    /**
     * Custom replacement for built-in fetch method. Useful for testing or request hooks.
     */
    fetch?: Fetch;
    /**
     * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests.
     */
    signal?: AbortSignal;
    /**
     * If set to `false`, the response body will not be parsed and will be returned as a stream.
     */
    parseSuccessResponseBody?: boolean;
    redirect?: "follow" | "error" | "manual";
    [option: string]: any;
};