Type aliases
AdditionalOptions
AdditionalOptions: { env: Record<string, string | undefined> }
Type declaration
-
env: Record<string, string | undefined>
ApplicationFunctionOptions
ApplicationFunctionOptions: { getRouter?: undefined | ((path?: undefined | string) => express.Router) }
Type declaration
-
[key: string]: unknown
-
Optional getRouter?: undefined | ((path?: undefined | string) => express.Router)
Constructor
Constructor<T>: {}
Type parameters
CreateProbotOptions
Create
ProbotOptions: { defaults?: Options; env?: NodeJS.ProcessEnv; overrides?: Options }
Type declaration
-
Optional defaults?: Options
-
Optional env?: NodeJS.ProcessEnv
-
Optional overrides?: Options
DeprecatedLogger
DeprecatedLogger: LogFn & Logger
FactoryOptions
FactoryOptions: { octokit: InstanceType<typeof ProbotOctokit>; octokitOptions: ConstructorParameters<typeof ProbotOctokit> & { auth?: Record<string, unknown>; throttle?: Record<string, unknown> } }
Type declaration
-
[key: string]: unknown
-
octokit: InstanceType<typeof ProbotOctokit>
-
octokitOptions: ConstructorParameters<typeof ProbotOctokit> & { auth?: Record<string, unknown>; throttle?: Record<string, unknown> }
GetLogOptions
Get
LogOptions: { level?: LogLevel } & Options
MergeOptions
MergeOptions: merge.Options
MiddlewareOptions
Middleware
Options: { probot: Probot }
Options
Options: { Octokit: typeof ProbotOctokit; appId?: undefined | number; baseUrl?: undefined | string; cache: LRUCache<number, string>; githubToken?: undefined | string; log: Logger; privateKey?: undefined | string; redisConfig?: Redis.RedisOptions | string }
Type declaration
-
Octokit: typeof ProbotOctokit
-
Optional appId?: undefined | number
-
Optional baseUrl?: undefined | string
-
cache: LRUCache<number, string>
-
Optional githubToken?: undefined | string
-
log: Logger
-
Optional privateKey?: undefined | string
-
Optional redisConfig?: Redis.RedisOptions | string
Optional Octokit
Octokit: typeof ProbotOctokit
Optional appId
appId: number | string
Optional baseUrl
baseUrl: undefined | string
Optional githubToken
githubToken: undefined | string
Optional host
host: undefined | string
Optional logLevel
logLevel: "trace" | "debug" | "info" | "warn" | "error" | "fatal"
Optional port
port: undefined | number
Optional privateKey
privateKey: undefined | string
Optional redisConfig
redisConfig: Redis.RedisOptions | string
Optional secret
secret: undefined | string
Optional webhookPath
webhookPath: undefined | string
ProbotWebhooks
Probot
Webhooks: Webhooks<WebhookEvent, Omit<Context, keyof WebhookEvent>>
Resolver
Resolver: (appFnId: string, opts: { basedir: string }) => string
Type declaration
-
- (appFnId: string, opts: { basedir: string }): string
-
Parameters
-
appFnId: string
-
opts: { basedir: string }
Returns string
ServerOptions
ServerOptions: { Probot: typeof Probot; host?: undefined | string; log?: Logger; port?: undefined | number; webhookPath?: undefined | string; webhookProxy?: undefined | string }
Type declaration
-
Probot: typeof Probot
-
Optional host?: undefined | string
-
Optional log?: Logger
-
Optional port?: undefined | number
-
Optional webhookPath?: undefined | string
-
Optional webhookProxy?: undefined | string
State
State: { Octokit: typeof ProbotOctokit; appId?: undefined | number; baseUrl?: undefined | string; cache?: LRUCache<number, string>; githubToken?: undefined | string; host?: undefined | string; log: Logger; octokit: InstanceType<typeof ProbotOctokit>; port?: undefined | number; privateKey?: undefined | string; webhooks: { path?: undefined | string; secret?: undefined | string } }
Type declaration
-
Octokit: typeof ProbotOctokit
-
Optional appId?: undefined | number
-
Optional baseUrl?: undefined | string
-
Optional cache?: LRUCache<number, string>
-
Optional githubToken?: undefined | string
-
Optional host?: undefined | string
-
log: Logger
-
octokit: InstanceType<typeof ProbotOctokit>
-
Optional port?: undefined | number
-
Optional privateKey?: undefined | string
-
webhooks: { path?: undefined | string; secret?: undefined | string }
-
Optional path?: undefined | string
-
Optional secret?: undefined | string
probot.log()
,app.log()
andcontext.log()
are aliasing.log.info()
. We will probably remove the aliasing in future.