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 & {}

router

  • get router(): Router
  • deprecated

    "app.router" is deprecated, use "getRouter()" from the app function instead: "({ app, getRouter }) => { ... }"

    Returns Router

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>

route

  • route(path?: undefined | string): Router
  • Get an express router that can be used to expose HTTP endpoints

    module.exports = ({ app, getRouter }) => {
      // Get an express router to expose new HTTP endpoints
      const router = getRouter('/my-app');
    
      // Use any middleware
      router.use(require('express').static(__dirname + '/public'));
    
      // Add a new route
      router.get('/hello-world', (req, res) => {
        res.end('Hello World');
      });
    };
    deprecated

    "app.route()" is deprecated, use the "getRouter()" argument from the app function instead: "({ app, getRouter }) => { ... }"

    Parameters

    • Optional path: undefined | string

      the prefix for the routes* @param path

    Returns Router

setup

start

  • start(): Server

stop

  • stop(): void

Static run

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Static method

Generated using TypeDoc