Skip to content

Function: createGithubIssuesBuilder() ​

ts
function createGithubIssuesBuilder<TExternal, TExternalState>(options): GithubIssuesTrackerNode<TExternal, TExternalState>;

Defined in: github/src/builders/create-github-issues-builder.ts:20

Compiles a passive GithubIssuesTrackerNode from GithubIssuesOptions (github.issues).

Validates that options.repo is a non-empty owner/repo slug and freezes the resulting tracker AST node and optional label array.

Type Parameters ​

Type ParameterDefault typeDescription
TExternalGithubIssueRecordExternal issue record type (defaults to GithubIssueRecord).
TExternalState extends stringstringExternal tracker state string union.

Parameters ​

ParameterTypeDescription
optionsGithubIssuesOptionsRepository, token, and optional label filter configuration.

Returns ​

GithubIssuesTrackerNode<TExternal, TExternalState>

Frozen passive GitHub Issues tracker AST node.

Throws ​

If options.repo is not a non-empty 'owner/repo' slug.

Released under the MIT License.