probot | probot

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

serializers

Type aliases

ApplicationFunction

ApplicationFunction: function

Type declaration

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

MergeOptions

MergeOptions: merge.Options

OnCallback

OnCallback<T>: function

Type parameters

Type declaration

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

Resolver

Resolver: function

Type declaration

- (appFnId: string, opts: object): string
- Parameters
  - appFnId: string
  - opts: object
  Returns string

Variables

Const ProbotOctokit

ProbotOctokit: Static = Octokit.plugin(throttlePlugin).plugin(retryPlugin).plugin(enterpriseCompatibility)

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')})})

Functions

GitHubAPI

GitHubAPI(options?: Options): GitHubAPI

- Defined in github/index.ts:23
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 github/graphql.ts:18
Parameters
- client: GitHubAPI
Returns void

addLogging

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

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

addPagination

addPagination(octokit: Octokit): void

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

clearCache

clearCache(): void

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

Returns void

createDefaultCache

createDefaultCache(): Cache

- Defined in cache.ts:11
Returns Cache

Const createProbot

createProbot(options: Options): Probot

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

Const createServer

createServer(args: ServerArgs): Application

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

Const createWebhookProxy

createWebhookProxy(opts: WebhookProxyOptions): EventSource | undefined

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

Private findPrivateKey

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

- Defined in 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

Const logRequest

logRequest(__namedParameters: object): express.RequestHandler

- Defined in middleware/logging.ts:9
Parameters
- __namedParameters: object
Returns express.RequestHandler

Const logRequestErrors

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

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

Const resolve

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

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

Const wrapLogger

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

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

Object literals

Const serializers

serializers: object

err

err: function = bunyan.stdSerializers.err

Type declaration

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

req

req: function = bunyan.stdSerializers.req

Type declaration

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

event

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

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

installation

installation(installation: Installation): string | Installation

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

repository

repository(repository: PayloadRepository): string

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

res

res(res: ExpressResponseWithDuration): ExpressResponseWithDuration | object

- Defined in serializers.ts:41
Parameters
- res: ExpressResponseWithDuration
Returns ExpressResponseWithDuration | object

Generated using TypeDoc

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ApplicationFunction

Type declaration

Parameters

app: Application

Returns void

MergeOptions

OnCallback

Type parameters

T

Type declaration

Parameters

context: Context<T>

Returns Promise<void>

Resolver

Type declaration

Parameters

appFnId: string

opts: object

Returns string

Variables

Const ProbotOctokit

Const logger

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

Parameters

args: ServerArgs

Returns Application

Const createWebhookProxy

Parameters

opts: WebhookProxyOptions

Returns EventSource | undefined

Private findPrivateKey

Parameters

Optional filepath: undefined | string

Returns string | null

Const logRequest

Parameters

__namedParameters: object

Returns express.RequestHandler

Const logRequestErrors

Parameters

err: Error

req: Request

res: Response

next: NextFunction

Returns void

Const resolve