UNPKG

1.7 kBTypeScriptView Raw
1import * as OctokitTypes from "@octokit/types";
2import { RequestError } from "@octokit/request-error";
3import { Octokit } from ".";
4export declare type RequestParameters = OctokitTypes.RequestParameters;
5export interface OctokitOptions {
6 authStrategy?: any;
7 auth?: any;
8 userAgent?: string;
9 previews?: string[];
10 baseUrl?: string;
11 log?: {
12 debug: (message: string) => unknown;
13 info: (message: string) => unknown;
14 warn: (message: string) => unknown;
15 error: (message: string) => unknown;
16 };
17 request?: OctokitTypes.RequestRequestOptions;
18 timeZone?: string;
19 [option: string]: any;
20}
21export declare type Constructor<T> = new (...args: any[]) => T;
22export declare type ReturnTypeOf<T extends AnyFunction | AnyFunction[]> = T extends AnyFunction ? ReturnType<T> : T extends AnyFunction[] ? UnionToIntersection<Exclude<ReturnType<T[number]>, void>> : never;
23/**
24 * @author https://stackoverflow.com/users/2887218/jcalz
25 * @see https://stackoverflow.com/a/50375286/10325032
26 */
27export declare type UnionToIntersection<Union> = (Union extends any ? (argument: Union) => void : never) extends (argument: infer Intersection) => void ? Intersection : never;
28declare type AnyFunction = (...args: any) => any;
29export declare type OctokitPlugin = (octokit: Octokit, options: OctokitOptions) => {
30 [key: string]: any;
31} | void;
32export declare type Hooks = {
33 request: {
34 Options: Required<OctokitTypes.EndpointDefaults>;
35 Result: OctokitTypes.OctokitResponse<any>;
36 Error: RequestError | Error;
37 };
38 [key: string]: {
39 Options: unknown;
40 Result: unknown;
41 Error: unknown;
42 };
43};
44export {};