Skip to content

@paraharness/github ​

Variables ​

VariableDescription
defaultGithubHttpTransportDefault @octokit/rest-backed HTTP transport targeting https://api.github.com.
githubFrozen @paraharness/github DSL namespace singleton (github.issues, github.webhookStream, github.createOrUpdatePr).
githubExecutorsDefault frozen RuntimeExecutorRegistrySlice for @paraharness/github.

Functions ​

FunctionDescription
createGithubCreateOrUpdatePrBuilderCreates an immutable fluent GithubCreateOrUpdatePrBuilder (github.createOrUpdatePr).
createGithubExecutorsCreates a RuntimeExecutorRegistrySlice registering all @paraharness/github runtime executors.
createGithubIssuesBuilderCompiles a passive GithubIssuesTrackerNode from GithubIssuesOptions (github.issues).
createGithubWebhookStreamBuilderCompiles a passive GithubWebhookStreamNode from GithubWebhookStreamOptions (github.webhookStream).
executeGithubCreateOrUpdatePrStepStateless domain step executor for GithubCreateOrUpdatePrNode (github:create-or-update-pr).

Classes ​

ClassDescription
GithubIssuesTrackerAdapterRuntime TrackerAdapter implementation for GithubIssuesTrackerNode (github:issues).
GithubWebhookStreamSourceRuntime StreamSource implementation for GithubWebhookStreamNode (github:webhook-stream).

Interfaces ​

InterfaceDescription
GithubCreateOrUpdatePrBuilderFluent builder for a GithubCreateOrUpdatePrNode domain step (github.createOrUpdatePr).
GithubCreateOrUpdatePrNodePassive AST node creating or updating a GitHub pull request (github.createOrUpdatePr).
GithubCreateOrUpdatePrOptionsConfiguration options for the GitHub pull-request step builder (github.createOrUpdatePr).
GithubHttpRequestOptionsRequest options passed to GithubHttpTransport.request(...).
GithubHttpTransportPluggable HTTP transport abstraction for GitHub REST API requests.
GithubIssueRecordNormalized GitHub issue record emitted by GithubIssuesTrackerAdapter.poll().
GithubIssuesOptionsConfiguration options for the GitHub Issues tracker builder (github.issues).
GithubIssuesTrackerNodePassive AST node configuring a GitHub Issues tracker adapter (github.issues).
GithubNamespacePublic DSL builder namespace for @paraharness/github (github.*).
GithubWebhookBranchRefBranch reference descriptor nested inside a GitHub pull request webhook payload.
GithubWebhookEventDefault typed GitHub webhook delivery event payload emitted by github.webhookStream(...).
GithubWebhookPullRequestPayloadPull request payload nested inside a GitHub pull_request webhook event.
GithubWebhookRepositoryPayloadRepository metadata nested inside a GitHub webhook delivery payload.
GithubWebhookStreamNodePassive AST node configuring a GitHub webhook event stream source (github.webhookStream).
GithubWebhookStreamOptionsConfiguration options for the GitHub webhook event stream builder (github.webhookStream).

Released under the MIT License.