BeadsProvider
Defined in: providers/beads.ts:30
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 BeadsProvider(
config?):BeadsProvider
Defined in: providers/beads.ts:37
Parameters
Section titled “Parameters”config?
Section titled “config?”BeadsProviderConfig = ...
Returns
Section titled “Returns”BeadsProvider
Properties
Section titled “Properties”config
Section titled “config”
readonlyconfig:BeadsProviderConfig
Defined in: providers/beads.ts:37
displayName
Section titled “displayName”
readonlydisplayName:"Beads"='Beads'
Defined in: providers/beads.ts:32
Provider display name
Implementation of
Section titled “Implementation of”
readonlyname:"beads"='beads'
Defined in: providers/beads.ts:31
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/beads.ts:243
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/beads.ts:94
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/beads.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”deleteIssue()
Section titled “deleteIssue()”deleteIssue(
id):Promise<void>
Defined in: providers/beads.ts:124
Delete an issue (if supported)
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”getAvailableLabels()
Section titled “getAvailableLabels()”getAvailableLabels():
Promise<string[]>
Defined in: providers/beads.ts:293
Get all available labels across all issues
Returns
Section titled “Returns”Promise<string[]>
Implementation of
Section titled “Implementation of”TriageProvider.getAvailableLabels
getBlockedIssues()
Section titled “getBlockedIssues()”getBlockedIssues():
Promise<TriageIssue[]>
Defined in: providers/beads.ts:217
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/beads.ts:65
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/beads.ts:202
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/beads.ts:264
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/beads.ts:39
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/beads.ts:131
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/beads.ts:254
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/beads.ts:106
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/beads.ts:235
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/beads.ts:70
Update an existing issue
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<TriageIssue>