GitHubProvider
Defined in: providers/github.ts:22
Triage Provider Interface
All issue tracking backends must implement this interface. This allows commands to work with any provider transparently.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GitHubProvider(
config):GitHubProvider
Defined in: providers/github.ts:29
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”GitHubProvider
Properties
Section titled “Properties”displayName
Section titled “displayName”
readonlydisplayName:"GitHub Issues"='GitHub Issues'
Defined in: providers/github.ts:24
Provider display name
Implementation of
Section titled “Implementation of”
readonlyname:"github"='github'
Defined in: providers/github.ts:23
Provider name (e.g., ‘github’, ‘beads’, ‘jira’, ‘linear’)
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”addLabels()
Section titled “addLabels()”addLabels(
id,labels):Promise<void>
Defined in: providers/github.ts:169
Add labels to an issue
Parameters
Section titled “Parameters”string
labels
Section titled “labels”string[]
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”closeIssue()
Section titled “closeIssue()”closeIssue(
id,reason?):Promise<TriageIssue>
Defined in: providers/github.ts:105
Close an issue
Parameters
Section titled “Parameters”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<TriageIssue>
Implementation of
Section titled “Implementation of”createIssue()
Section titled “createIssue()”createIssue(
options):Promise<TriageIssue>
Defined in: providers/github.ts:43
Create a new issue
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<TriageIssue>
Implementation of
Section titled “Implementation of”getBlockedIssues()
Section titled “getBlockedIssues()”getBlockedIssues():
Promise<TriageIssue[]>
Defined in: providers/github.ts:160
Get blocked issues
Returns
Section titled “Returns”Promise<TriageIssue[]>
Implementation of
Section titled “Implementation of”TriageProvider.getBlockedIssues
getIssue()
Section titled “getIssue()”getIssue(
id):Promise<TriageIssue|null>
Defined in: providers/github.ts:64
Get an issue by ID
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<TriageIssue | null>
Implementation of
Section titled “Implementation of”getReadyWork()
Section titled “getReadyWork()”getReadyWork(
options?):Promise<ReadyWork[]>
Defined in: providers/github.ts:148
Get issues ready to work on (no blockers)
Parameters
Section titled “Parameters”options?
Section titled “options?”limit?
Section titled “limit?”number
priority?
Section titled “priority?”Returns
Section titled “Returns”Promise<ReadyWork[]>
Implementation of
Section titled “Implementation of”getStats()
Section titled “getStats()”getStats():
Promise<ProviderStats>
Defined in: providers/github.ts:177
Get provider statistics
Returns
Section titled “Returns”Promise<ProviderStats>
Implementation of
Section titled “Implementation of”isReady()
Section titled “isReady()”isReady():
Promise<boolean>
Defined in: providers/github.ts:34
Whether the provider is initialized and ready
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”listIssues()
Section titled “listIssues()”listIssues(
options?):Promise<TriageIssue[]>
Defined in: providers/github.ts:123
List issues with optional filters
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<TriageIssue[]>
Implementation of
Section titled “Implementation of”removeLabels()
Section titled “removeLabels()”removeLabels(
id,labels):Promise<void>
Defined in: providers/github.ts:173
Remove labels from an issue
Parameters
Section titled “Parameters”string
labels
Section titled “labels”string[]
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”reopenIssue()
Section titled “reopenIssue()”reopenIssue(
id,reason?):Promise<TriageIssue>
Defined in: providers/github.ts:114
Reopen an issue
Parameters
Section titled “Parameters”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<TriageIssue>
Implementation of
Section titled “Implementation of”searchIssues()
Section titled “searchIssues()”searchIssues(
query,options?):Promise<TriageIssue[]>
Defined in: providers/github.ts:165
Search issues by text
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<TriageIssue[]>
Implementation of
Section titled “Implementation of”updateIssue()
Section titled “updateIssue()”updateIssue(
id,options):Promise<TriageIssue>
Defined in: providers/github.ts:82
Update an existing issue
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<TriageIssue>