Interface RequestInterface<D>

Type Parameters

• D extends object = object

• RequestInterface<T = any, O extends RequestParameters = RequestParameters>(
      options: O & { method?: string } & (
          "url" extends keyof D ? { url?: string } : { url: string }
      ),
  ): 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 extends string>(
      route: (keyof Endpoints) | R,
      options?: R extends keyof Endpoints
          ? Endpoints[R<R>]["parameters"] & RequestParameters
          : RequestParameters,
  ): 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}'
  • Optionaloptions: R extends keyof Endpoints
        ? Endpoints[R<R>]["parameters"] & RequestParameters
        : RequestParameters

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