@octokit/core

  • Version 3.6.0
  • Published
  • 52.1 kB
  • 7 dependencies
  • MIT license

Install

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

Overview

Extendable client for GitHub's REST & GraphQL APIs

Index

Classes

class Octokit

class Octokit {}

    constructor

    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, ...)

                      Package Files (1)

                      Dependencies (7)

                      Dev Dependencies (19)

                      Peer Dependencies (0)

                      No peer dependencies.

                      Badge

                      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
                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@octokit/core)
                      • 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>