@octokit/core
- Version 7.0.6
 - Published
 - 23.2 kB
 - 7 dependencies
 - MIT license
 
Install
npm i @octokit/coreyarn add @octokit/corepnpm add @octokit/coreOverview
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) => typeof this;method plugin
static plugin: <    S extends Constructor<any> & { plugins: any[] },    T extends OctokitPlugin[]>(    this: S,    ...newPlugins: T) => typeof this & Constructor<UnionToIntersection<ReturnTypeOf<T>>>;Attach a plugin (or many) to your Octokit instance.
Example 1
const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
Interfaces
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 (17)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto 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[](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>
 
- Updated .
Package analyzed in 3881 ms. - Missing or incorrect documentation? Open an issue for this package.
 
