• Version 6.1.2
  • Published
  • 23 kB
  • 7 dependencies
  • MIT license


npm i @octokit/core
yarn add @octokit/core
pnpm add @octokit/core


Extendable client for GitHub's REST & GraphQL APIs



class Octokit

class Octokit {}


    constructor(options?: OctokitOptions);

      property auth

      auth: (...args: unknown[]) => Promise<unknown>;

        property graphql

        graphql: any;

          property hook

          hook: HookCollection<Hooks>;

            property log

            log: {
            [key: string]: any;
            debug: (message: string, additionalInfo?: object) => any;
            info: (message: string, additionalInfo?: object) => any;
            warn: (message: string, additionalInfo?: object) => any;
            error: (message: string, additionalInfo?: object) => any;

              property plugins

              static plugins: OctokitPlugin[];

                property request

                request: any;

                  property VERSION

                  static VERSION: string;

                    method defaults

                    static defaults: <S extends Constructor<any>>(
                    this: S,
                    defaults: OctokitOptions | Function
                    ) => S;

                      method plugin

                      static plugin: <
                      S extends Constructor<any> & { plugins: any[] },
                      T extends OctokitPlugin[]
                      this: S,
                      ...newPlugins: T
                      ) => S & Constructor<UnionToIntersection<ReturnTypeOf<T>>>;
                      • Attach a plugin (or many) to your Octokit instance.

                        Example 1

                        const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)


                      interface OctokitOptions

                      interface OctokitOptions {}

                        property auth

                        auth?: any;

                          property authStrategy

                          authStrategy?: any;

                            property baseUrl

                            baseUrl?: string;

                              property log

                              log?: {
                              debug: (message: string) => unknown;
                              info: (message: string) => unknown;
                              warn: (message: string) => unknown;
                              error: (message: string) => unknown;

                                property previews

                                previews?: string[];

                                  property request

                                  request?: OctokitTypes.RequestRequestOptions;

                                    property timeZone

                                    timeZone?: string;

                                      property userAgent

                                      userAgent?: string;

                                        index signature

                                        [option: string]: any;

                                          Package Files (2)

                                          Dependencies (7)

                                          Dev Dependencies (22)

                                          Peer Dependencies (0)

                                          No peer dependencies.


                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@octokit/core.

                                          • Markdown
                                          • HTML
                                            <a href="https://www.jsdocs.io/package/@octokit/core"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>