Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Indexable

[option: string]: any

Index

Properties

Octokit

Octokit: Octokit.Static

Optional agent

agent: http.Agent
deprecated

Use {request: {agent}} instead. See https://github.com/octokit/request.js#request

app

app: OctokitApp

Optional auth

auth: string | { on2fa: () => Promise<string>; password: string; username: string } | { clientId: string; clientSecret: string } | (() => string | Promise<string>) | any

Optional authStrategy

authStrategy: any

Optional baseUrl

baseUrl: undefined | string

cache

cache: Cache

Optional catchErrors

catchErrors: undefined | false | true

Optional cert

cert: undefined | string

Optional debug

debug: undefined | false | true

Optional githubToken

githubToken: undefined | string

Optional headers

headers: undefined | {}
deprecated

Use {userAgent, previews} instead. See https://github.com/octokit/request.js#request

Optional id

id: undefined | number

Optional log

log: undefined | { debug?: undefined | ((message: string, info?: undefined | object) => void); error?: undefined | ((message: string, info?: undefined | object) => void); info?: undefined | ((message: string, info?: undefined | object) => void); warn?: undefined | ((message: string, info?: undefined | object) => void) }

logger

logger: Logger

Optional port

port: undefined | number

Optional previews

previews: string[]

Optional redisConfig

redisConfig: Redis.RedisOptions

Optional request

request: undefined | { agent?: http.Agent; timeout?: undefined | number }

Optional router

router: express.Router

Optional secret

secret: undefined | string

Optional throttleOptions

throttleOptions: any

Optional timeout

timeout: undefined | number
deprecated

Use {request: {timeout}} instead. See https://github.com/octokit/request.js#request

Optional userAgent

userAgent: undefined | string

Optional webhookPath

webhookPath: undefined | string

Optional webhookProxy

webhookProxy: undefined | string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc