Type Alias RequestRequestOptions

RequestRequestOptions: {
    fetch?: Fetch;
    parseSuccessResponseBody?: boolean;
    redirect?: "follow" | "error" | "manual";
    signal?: AbortSignal;
    [option: string]: any;
}

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

Type declaration

  • [option: string]: any
  • Optionalfetch?: Fetch

    Custom replacement for built-in fetch method. Useful for testing or request hooks.

  • OptionalparseSuccessResponseBody?: boolean

    If set to false, the response body will not be parsed and will be returned as a stream.

  • Optionalredirect?: "follow" | "error" | "manual"
  • Optionalsignal?: AbortSignal

    Use an AbortController instance to cancel a request. In node you can only cancel streamed requests.

Settings

Member Visibility