Interface RequestInterface<D>

Type Parameters

• D extends object = object

• RequestInterface<T, O>(options): Promise<OctokitResponse<T, number>>

• Sends a request based on endpoint options

  Type Parameters

  • T = any
  • O extends RequestParameters = RequestParameters

  Parameters

  • options: O & {
        method?: string;
    } & ("url" extends keyof D
        ? {
            url?: string;
        }
        : {
            url: string;
        })

  Returns Promise<OctokitResponse<T, number>>
• RequestInterface<R>(route, options?): R extends keyof Endpoints
      ? Promise<Endpoints[R<R>]["response"]>
      : Promise<OctokitResponse<any, number>>

• Sends a request based on endpoint options

  Type Parameters

  • R extends string

  Parameters

  • route: (keyof Endpoints) | R

    Request method + URL. Example: 'GET /orgs/{org}'
  • Optional options: R extends keyof Endpoints
        ? Endpoints[R<R>]["parameters"] & RequestParameters
        : RequestParameters

  Returns R extends keyof Endpoints
      ? Promise<Endpoints[R<R>]["response"]>
      : Promise<OctokitResponse<any, number>>