Search
Preparing search index...
The search index is not available
probot
Options
All
Public
Public/Protected
All
Inherited
Menu
probot
types
Module types
Index
Interfaces
Options
Type Aliases
Application
Function
Application
Function
Options
Deprecated
Logger
Middleware
Options
Probot
Webhooks
Server
Options
State
Type Aliases
Application
Function
Application
Function
:
(
(
app
:
Probot
, options
:
ApplicationFunctionOptions
)
=>
void
)
Type declaration
(
app
:
Probot
, options
:
ApplicationFunctionOptions
)
:
void
Parameters
app:
Probot
options:
ApplicationFunctionOptions
Returns
void
Application
Function
Options
Application
Function
Options
:
{
getRouter
?:
any
}
Type declaration
[
key:
string
]:
unknown
get
Router
?:
function
get
Router
(
path
?:
string
)
:
Router
Parameters
Optional
path:
string
Returns
Router
Deprecated
Logger
Deprecated
Logger
:
LogFn
&
Logger
Middleware
Options
Middleware
Options
:
{
probot
:
Probot
;
webhooksPath
?:
string
}
Type declaration
[
key:
string
]:
unknown
probot
:
Probot
Optional
webhooks
Path
?:
string
Probot
Webhooks
Probot
Webhooks
:
Webhooks
<
Omit
<
Context
,
keyof
WebhookEvent
>
>
Server
Options
Server
Options
:
{
Probot
:
typeof
Probot
;
host
?:
string
;
log
?:
Logger
;
loggingOptions
?:
LoggingOptions
;
port
?:
number
;
webhookPath
?:
string
;
webhookProxy
?:
string
}
Type declaration
Probot
:
typeof
Probot
Optional
host
?:
string
Optional
log
?:
Logger
Optional
logging
Options
?:
LoggingOptions
Optional
port
?:
number
Optional
webhook
Path
?:
string
Optional
webhook
Proxy
?:
string
State
State
:
{
Octokit
:
typeof
ProbotOctokit
;
appId
?:
number
;
baseUrl
?:
string
;
cache
?:
LRUCache
<
number
,
string
>
;
githubToken
?:
string
;
host
?:
string
;
log
:
Logger
;
octokit
:
InstanceType
<
typeof
ProbotOctokit
>
;
port
?:
number
;
privateKey
?:
string
;
webhooks
:
{
secret
?:
string
}
}
Type declaration
Octokit
:
typeof
ProbotOctokit
Optional
app
Id
?:
number
Optional
base
Url
?:
string
Optional
cache
?:
LRUCache
<
number
,
string
>
Optional
github
Token
?:
string
Optional
host
?:
string
log
:
Logger
octokit
:
InstanceType
<
typeof
ProbotOctokit
>
Optional
port
?:
number
Optional
private
Key
?:
string
webhooks
:
{
secret
?:
string
}
Optional
secret
?:
string
Modules
apps/default
apps/setup
auth
bin/read-
cli-
options
bin/read-
env-
options
context
create-
node-
middleware
create-
probot
get-
router
helpers/alias-
log
helpers/get-
error-
handler
helpers/get-
log
helpers/is-
production
helpers/resolve-
app-
function
helpers/webhook-
proxy
index
manifest-
creation
octokit/get-
authenticated-
octokit
octokit/get-
octokit-
throttle-
options
octokit/get-
probot-
octokit-
with-
defaults
octokit/get-
webhooks
octokit/octokit-
plugin-
probot-
request-
logging
octokit/octokit-
webhooks-
transform
octokit/probot-
octokit
probot
run
server/logging-
middleware
server/server
types
version
Options
Application
Function
Application
Function
Options
Deprecated
Logger
Middleware
Options
Probot
Webhooks
Server
Options
State
Generated using
TypeDoc