Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Probot

Index

Constructors

constructor

  • new Probot(options: Options): Probot

Properties

auth

auth: (installationId?: undefined | number, log?: Logger) => Promise<InstanceType<typeof ProbotOctokit>>

Type declaration

    • (installationId?: undefined | number, log?: Logger): Promise<InstanceType<typeof ProbotOctokit>>
    • Parameters

      • Optional installationId: undefined | number
      • Optional log: Logger

      Returns Promise<InstanceType<typeof ProbotOctokit>>

log

on

on: ProbotWebhooks["on"]

options

options: Options

server

server: express.Application

throttleOptions

throttleOptions: any

version

version: String

webhooks

webhooks: ProbotWebhooks

Accessors

logger

  • get logger(): LogFn & BaseLogger & {}
  • deprecated

    use probot.log instead

    Returns LogFn & BaseLogger & {}

webhook

  • get webhook(): Webhooks
  • deprecated

    probot.webhook is deprecated. Use probot.webhooks instead

    Returns Webhooks

Methods

load

receive

  • receive(event: WebhookEvent): Promise<void>
  • Parameters

    • event: WebhookEvent

    Returns Promise<void>

setup

start

  • start(): Server

stop

  • stop(): void

Static run

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Static method

Generated using TypeDoc