Function: createGithubWebhookStreamBuilder()
ts
function createGithubWebhookStreamBuilder<TEvent>(options): GithubWebhookStreamNode<TEvent>;Defined in: github/src/builders/create-github-webhook-stream-builder.ts:23
Compiles a passive GithubWebhookStreamNode from GithubWebhookStreamOptions (github.webhookStream).
Defaults port to 3000 and path to '/webhooks/github' when omitted and deeply freezes the subscribed events list.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
TEvent | GithubWebhookEvent | Webhook event payload type (defaults to GithubWebhookEvent). |
Parameters
| Parameter | Type | Description |
|---|---|---|
options | GithubWebhookStreamOptions | Webhook listener, secret, and event filter options. |
Returns
GithubWebhookStreamNode<TEvent>
Frozen passive GitHub webhook stream source AST node.
Throws
If options.events is not a non-empty array of event names.