Probot | probot

Hierarchy

Probot

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Probot(options?: Options): Probot

- Defined in src/probot.ts:44
Parameters
- Default value options: Options = {}
Returns 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

log: DeprecatedLogger

on

on: ProbotWebhooks["on"]

version

version: String

webhooks

webhooks: ProbotWebhooks

Static version

version: string = VERSION

Methods

load

load(appFn: ApplicationFunction | ApplicationFunction[]): Promise<void>

- Defined in src/probot.ts:112
Parameters
- appFn: ApplicationFunction | ApplicationFunction[]
Returns Promise<void>

receive

receive(event: WebhookEvent): Promise<void>

- Defined in src/probot.ts:107
Parameters
- event: WebhookEvent
Returns Promise<void>

Static defaults

defaults<S>(this: S, defaults: Options): ProbotWithDefaults & S

- Defined in src/probot.ts:24
Type parameters
- S: Constructor<any>
Parameters
- this: S
- defaults: Options
Returns ProbotWithDefaults & S

Generated using TypeDoc