Options
All
  • Public
  • Public/Protected
  • All
Menu

Module RequestRequestOptions

Index

Type aliases

Type aliases

RequestRequestOptions

RequestRequestOptions: { agent?: unknown; fetch?: Fetch; signal?: Signal; timeout?: number }

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
  • Optional agent?: unknown

    Node only. Useful for custom proxy, certificate, or dns lookup.

    see

    https://nodejs.org/api/http.html#http_class_http_agent

  • Optional fetch?: Fetch

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

  • Optional signal?: Signal

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

  • Optional timeout?: number

    Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). options.request.signal is recommended instead.

Generated using TypeDoc