github.githublistenerprops
Home > @runlightyear/github > GitHubListenerProps
GitHubListenerProps interface
Signature:interface GitHubListenerProps<Payload>
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | The name of this listener. | |
| run | GitHubListenerRunFunc<Payload> | The function to run when this listener is triggered. | |
| title | string | The title of this listener. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apps? | Array<AppName> | An array of the system apps used by this listener. | |
| authName? | string | ||
| customAppName? | string | ||
| customApps? | Array<string> | An array of the custom apps used by this listener. | |
| owner? | string | The account owner of the repository. The name is not case sensitive. | |
| repo? | string | The name of the repository without the .git extension. The name is not case sensitive. | |
| secrets? | Array<string> | An array of the secrets on this listener. Secrets are like variables, but they are stored more securely in the database and they are redacted in the console logs. Secrets are required to have a value by default. If you append a "?" to the end of the name, the secret will be optional. For example: ["requiredSecret", "optionalSecret?"] | |
| variables? | Array<string> | An array of the variables on this listener. Variables are required to have a value by default. If you append a "?" to the end of the name, the variable will be optional. For example: ["requiredVar", "optionalVar?"] |