Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

ApplicationFunction

ApplicationFunction: function

Type declaration

Resolver

Resolver: function

Type declaration

    • (appFnId: string, opts: object): string
    • Parameters

      • appFnId: string
      • opts: object

      Returns string

Variables

Const logger

logger: Logger = new Logger({level: toBunyanLogLevel(process.env.LOG_LEVEL || 'info'),name: 'probot',serializers,stream: new bunyanFormat({ outputMode: toBunyanFormat(process.env.LOG_FORMAT || 'short'), color: supportsColor.stdout })})

Functions

addGraphQL

addLogging

  • addLogging(client: GitHubAPI, logger: Logger): void

addPagination

addRateLimiting

  • addRateLimiting(octokit: GitHubAPI, limiter: Bottleneck): void

Const createApp

  • createApp(options: AppOptions): (Anonymous function)

createDefaultCache

  • createDefaultCache(): Cache

Const createProbot

  • createProbot(options: Options): Probot

Const createServer

Const createWebhookProxy

Private findPrivateKey

  • findPrivateKey(filepath?: undefined | string): Buffer | string | null
  • Finds a private key through various user-(un)specified methods. Order of precedence:

    1. Explicit path (CLI option)
    2. PRIVATE_KEY env var
    3. PRIVATE_KEY_PATH env var
    4. Any file w/ .pem extension in current working dir

    Parameters

    • Optional filepath: undefined | string

      Explicit, user-defined path to keyfile

    Returns Buffer | string | null

    Private key

Const logRequest

  • logRequest(__namedParameters: object): express.RequestHandler

Const resolve

Const wrapLogger

Object literals

Const serializers

serializers: object

err

err: function = bunyan.stdSerializers.err

Type declaration

    • (input: any): any
    • Parameters

      • input: any

      Returns any

req

req: function = bunyan.stdSerializers.req

Type declaration

    • (input: any): any
    • Parameters

      • input: any

      Returns any

event

  • event(event: WebhookEvent | any): any

installation

  • installation(installation: Installation): string | Installation
  • Parameters

    • installation: Installation

    Returns string | Installation

repository

  • repository(repository: PayloadRepository): undefined | string
  • Parameters

    • repository: PayloadRepository

    Returns undefined | string

res

  • res(res: ExpressResponseWithDuration): ExpressResponseWithDuration | object
  • Parameters

    • res: ExpressResponseWithDuration

    Returns ExpressResponseWithDuration | object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • 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