Options
All
  • Public
  • Public/Protected
  • All
Menu

The app parameter available to ApplicationFunctions

property

{logger} log - A logger

Hierarchy

  • Application

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

log

on

on: ProbotWebhooks["on"]

receive

receive: ProbotWebhooks["receive"]

router

router: express.Router

Methods

auth

  • auth(installationId?: undefined | number, log?: Logger): Promise<InstanceType<typeof ProbotOctokit>>
  • Authenticate and get a GitHub client that can be used to make API calls.

    You'll probably want to use context.github instead.

    Note: app.auth is asynchronous, so it needs to be prefixed with a await to wait for the magic to happen.

     module.exports = (app) => {
       app.on('issues.opened', async context => {
         const github = await app.auth();
       });
     };

    Parameters

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

    Returns Promise<InstanceType<typeof ProbotOctokit>>

    An authenticated GitHub API client

load

route

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

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

    Parameters

    • Optional path: undefined | string

      the prefix for the routes

    Returns express.Router

    an express.Router

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Static method

Generated using TypeDoc