probot | probot

Index

Classes

Type aliases

Variables

Object literals

serializers

Type aliases

ApplicationFunction

ApplicationFunction: (app: Application) => void

Type declaration

- (app: Application): void
- Parameters
  - app: Application
  Returns void

Graphql

Graphql: (query: string, variables?: Variables, headers?: Headers) => ReturnType<typeof graphql>

Type declaration

- (query: string, variables?: Variables, headers?: Headers): ReturnType<typeof graphql>
- Parameters
  - query: string
  - Optional variables: Variables
  - Optional headers: Headers
  Returns ReturnType<typeof graphql>

MergeOptions

MergeOptions: merge.Options

OnCallback

OnCallback<T>: (context: Context<T>) => Promise<void>

Type parameters

Type declaration

- (context: Context<T>): Promise<void>
- Parameters
  - context: Context<T>
  Returns Promise<void>

Resolver

Resolver: (appFnId: string, opts: { basedir: string }) => string

Type declaration

- (appFnId: string, opts: { basedir: string }): string
- Parameters
  - appFnId: string
  - opts: { basedir: string }
    - basedir: string
  Returns string

Variables

Const BASE_KEY

BASE_KEY: "_extends" = "_extends"

Const BASE_REGEX

BASE_REGEX: RegExp = new RegExp('^' +'(?:([a-z\\d](?:[a-z\\d]|-(?=[a-z\\d])){0,38})/)?' + // org'([-_.\\w\\d]+)' + // project'(?::([-_./\\w\\d]+\\.ya?ml))?' + // filename'$','i')

Const CONFIG_PATH

CONFIG_PATH: ".github" = ".github"

Const DEFAULT_BASE

DEFAULT_BASE: ".github" = ".github"

Const ProbotOctokit

ProbotOctokit: Static = Octokit.plugin([throttling, retry, enterpriseCompatibility])

Let appMeta

appMeta: ReturnType<GitHubAPI["apps"]["getAuthenticated"]> | null = null

Const cache

cache: Cache = createDefaultCache()

Const defaultAppFns

defaultAppFns: ApplicationFunction[] = [require('./apps/default'),require('./apps/sentry'),require('./apps/stats')]

Const defaultOptions

defaultOptions: ResolveOptions

Let didFailRetrievingAppMeta

didFailRetrievingAppMeta: boolean = false

Const domain

domain: string = process.env.PROJECT_DOMAIN || `http://localhost:${process.env.PORT || 3000}`

Const hint

hint: "please use:* `--private-key=/path/to/private-key` flag, or* `PRIVATE_KEY` environment variable, or* `PRIVATE_KEY_PATH` environment variable" = `please use:* \`--private-key=/path/to/private-key\` flag, or* \`PRIVATE_KEY\` environment variable, or* \`PRIVATE_KEY_PATH\` environment variable`

Const isBase64

isBase64: any = require('is-base64')

Const logger

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

Const octokitGetNextPage

octokitGetNextPage: any = require('octokit-pagination-methods/lib/get-next-page')

Const octokitHasNextPage

octokitHasNextPage: any = require('octokit-pagination-methods/lib/has-next-page')

Const welcomeMessage

welcomeMessage: string = `\nWelcome to Probot! Go to ${domain} to get started.\n`

Functions

GitHubAPI

GitHubAPI(options?: Options): GitHubAPI

- Defined in src/github/index.ts:21
the @octokit/rest Node.js module, which wraps the GitHub API and allows you to do almost anything programmatically that you can do through a web browser.

see

https://github.com/octokit/rest.js

Parameters
- Default value options: Options = { Octokit: ProbotOctokit } as any
Returns GitHubAPI

addGraphQL

addGraphQL(client: GitHubAPI): void

- Defined in src/github/graphql.ts:18
Parameters
- client: GitHubAPI
Returns void

addLogging

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

- Defined in src/github/logging.ts:4
Parameters
- client: GitHubAPI
- logger: Logger
Returns void

addPagination

addPagination(octokit: Octokit): void

- Defined in src/github/pagination.ts:8
Parameters
- octokit: Octokit
Returns void

clearCache

clearCache(): void

- Defined in src/webhook-event-check.ts:170
A helper function used in testing that resets the cached result of /app.

Returns void

createDefaultCache

createDefaultCache(): Cache

- Defined in src/cache.ts:11
Returns Cache

Const createProbot

createProbot(options: Options): Probot

- Defined in src/index.ts:227
Parameters
- options: Options
Returns Probot

Const createServer

createServer(args: ServerArgs): Application

- Defined in src/server.ts:11
Parameters
- args: ServerArgs
Returns Application

Const createWebhookProxy

createWebhookProxy(opts: WebhookProxyOptions): EventSource | undefined

- Defined in src/webhook-proxy.ts:4
Parameters
- opts: WebhookProxyOptions
Returns EventSource | undefined

Const defaultCallback

defaultCallback(response: Octokit.AnyResponse, done: () => void): Response<any>

- Defined in src/github/pagination.ts:17
Parameters
- response: Octokit.AnyResponse
- done: () => void
  - - (): void
    - Returns void
Returns Response<any>

Private findPrivateKey

findPrivateKey(filepath?: undefined | string): string | null

- Defined in src/private-key.ts:23
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 string | null

Private key

inTestEnvironment

inTestEnvironment(): boolean

- Defined in src/webhook-event-check.ts:159
Detects if Probot is likely running in a test environment.

Note: This method only detects Jest environments or when NODE_ENV starts with test.

Returns boolean

Returns true if Probot is in a test environment.

isSubscribedToEvent

isSubscribedToEvent(app: Application, baseEventName: string): Promise<undefined | false | true>

- Defined in src/webhook-event-check.ts:40
Parameters
- app: Application
- baseEventName: string
  
  The base event name refers to the part before the first period mark (e.g. the issues part in issues.opened).
Returns Promise<undefined | false | true>

Returns false when the application is not subscribed to a webhook event. Otherwise, returns true. Returns undefined if Probot failed to retrieve GitHub App metadata.

Note: Probot will only check against a list of events known to be in the GET /app response. Therefore, only the false value should be considered truthy.

isUnauthenticatedEvent

isUnauthenticatedEvent(event: WebhookEvent<any>): boolean

- Defined in src/application.ts:27
Parameters
- event: WebhookEvent<any>
Returns boolean

isWebhookEventCheckEnabled

isWebhookEventCheckEnabled(): boolean

- Defined in src/webhook-event-check.ts:139
Returns boolean

Const logRequest

logRequest(__namedParameters: { logger: any }): express.RequestHandler

- Defined in src/middleware/logging.ts:9
Parameters
- __namedParameters: { logger: any }
  - logger: any
Returns express.RequestHandler

Const logRequestErrors

logRequestErrors(err: Error, req: Request, res: Response, next: NextFunction): void

- Defined in src/middleware/log-request-errors.ts:4
Parameters
- err: Error
- req: Request
- res: Response
- next: NextFunction
Returns void

paginate

paginate(octokit: Octokit, octokitPaginate: Paginate, ...args: any[]): Promise<any[]>

- Defined in src/github/pagination.ts:19
Parameters
- octokit: Octokit
- octokitPaginate: Paginate
- Rest ...args: any[]
Returns Promise<any[]>

Const resolve

resolve(appFnId: string, opts?: ResolveOptions): any

- Defined in src/resolver.ts:5
Parameters
- appFnId: string
- Optional opts: ResolveOptions
Returns any

retrieveAppMeta

retrieveAppMeta(app: Application): Promise<Response<{ created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; installations_count: number; name: string; node_id: string; owner: AppsGetAuthenticatedResponseOwner; permissions: AppsGetAuthenticatedResponsePermissions; slug: string; updated_at: string }>>

- Defined in src/webhook-event-check.ts:106
Parameters
- app: Application
Returns Promise<Response<{ created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; installations_count: number; name: string; node_id: string; owner: AppsGetAuthenticatedResponseOwner; permissions: AppsGetAuthenticatedResponsePermissions; slug: string; updated_at: string }>>

toBunyanFormat

toBunyanFormat(format: string): "short" | "long" | "simple" | "json" | "bunyan"

- Defined in src/logger.ts:46
Parameters
- format: string
Returns "short" | "long" | "simple" | "json" | "bunyan"

toBunyanLogLevel

toBunyanLogLevel(level: string): "error" | "trace" | "debug" | "info" | "warn" | "fatal"

- Defined in src/logger.ts:31
Parameters
- level: string
Returns "error" | "trace" | "debug" | "info" | "warn" | "fatal"

webhookEventCheck

webhookEventCheck(app: Application, eventName: string): Promise<undefined | false | true>

- Defined in src/webhook-event-check.ts:14
Check if an application is subscribed to an event.

Parameters
- app: Application
- eventName: string
Returns Promise<undefined | false | true>

Returns false if the app is not subscribed to an event. Otherwise, returns true. Returns undefined if the webhook-event-check feature is disabled or if Probot failed to retrieve the GitHub App's metadata.

Const wrapLogger

wrapLogger(logger: Logger, baseLogger?: Logger): LoggerWithTarget

- Defined in src/wrap-logger.ts:9
Parameters
- logger: Logger
- Optional baseLogger: Logger
Returns LoggerWithTarget

Object literals

Const serializers

serializers: object

err

err: (input: any) => any = bunyan.stdSerializers.err

Type declaration

- (input: any): any
- Parameters
  - input: any
  Returns any

req

req: (input: any) => any = bunyan.stdSerializers.req

Type declaration

- (input: any): any
- Parameters
  - input: any
  Returns any

event

event(event: WebhookEvent<any> | any): any

- Defined in src/serializers.ts:7
Parameters
- event: WebhookEvent<any> | any
Returns any

installation

installation(installation: Installation): string | Installation

- Defined in src/serializers.ts:24
Parameters
- installation: Installation
Returns string | Installation

repository

repository(repository: PayloadRepository): string

- Defined in src/serializers.ts:34
Parameters
- repository: PayloadRepository
Returns string

res

res(res: ExpressResponseWithDuration): ExpressResponseWithDuration | { duration: any; headers: OutgoingHttpHeaders; statusCode: number }

- Defined in src/serializers.ts:41
Parameters
- res: ExpressResponseWithDuration
Returns ExpressResponseWithDuration | { duration: any; headers: OutgoingHttpHeaders; statusCode: number }

Generated using TypeDoc

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ApplicationFunction

Type declaration

Parameters

app: Application

Returns void

Graphql

Type declaration

Parameters

query: string

Optional variables: Variables

Optional headers: Headers

Returns ReturnType<typeof graphql>

MergeOptions

OnCallback

Type parameters

T

Type declaration

Parameters

context: Context<T>

Returns Promise<void>

Resolver

Type declaration

Parameters

appFnId: string

opts: { basedir: string }

basedir: string

Returns string

Variables

Const BASE_KEY

Const BASE_REGEX

Const CONFIG_PATH

Const DEFAULT_BASE

Const ProbotOctokit

Let appMeta

Const cache

Const defaultAppFns

Const defaultOptions

Let didFailRetrievingAppMeta

Const domain

Const hint

Const isBase64

Const logger

Const octokitGetNextPage

Const octokitHasNextPage

Const welcomeMessage

Functions

GitHubAPI

Parameters

Default value options: Options = { Octokit: ProbotOctokit } as any

Returns GitHubAPI

addGraphQL

Parameters

client: GitHubAPI

Returns void

addLogging

Parameters

client: GitHubAPI

logger: Logger

Returns void

addPagination

Parameters

octokit: Octokit

Returns void

clearCache

Returns void

createDefaultCache

Returns Cache

Const createProbot

Parameters

options: Options

Returns Probot

Const createServer