LabelModel
Defined in: packages/core/src/models/label.ts:18
Data operations for label types and build labels.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LabelModel(
db,tables?):LabelModel
Defined in: packages/core/src/models/label.ts:26
Parameters
Section titled “Parameters”Database adapter.
tables?
Section titled “tables?”LabelTables
Table handles.
Returns
Section titled “Returns”LabelModel
Methods
Section titled “Methods”attach()
Section titled “attach()”attach(
projectId,buildId,typeKey,value):Promise<BuildLabel>
Defined in: packages/core/src/models/label.ts:126
Attach a label value to a build.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
buildId
Section titled “buildId”string
typeKey
Section titled “typeKey”string
string
Returns
Section titled “Returns”Promise<BuildLabel>
createType()
Section titled “createType()”createType(
projectId,input):Promise<LabelType>
Defined in: packages/core/src/models/label.ts:79
Create a custom label type for a project.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
color?
Section titled “color?”string
string
linkTemplate?
Section titled “linkTemplate?”string
string
Returns
Section titled “Returns”Promise<LabelType>
getType()
Section titled “getType()”getType(
projectId,key):Promise<LabelType|null>
Defined in: packages/core/src/models/label.ts:67
Fetch a label type by key, or null if not found.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
Returns
Section titled “Returns”Promise<LabelType | null>
hasPersistent()
Section titled “hasPersistent()”hasPersistent(
projectId,buildId):Promise<boolean>
Defined in: packages/core/src/models/label.ts:173
Whether a build is marked as persistent.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
buildId
Section titled “buildId”string
Returns
Section titled “Returns”Promise<boolean>
latestBuildId()
Section titled “latestBuildId()”latestBuildId(
projectId,typeKey,value):Promise<string|null>
Defined in: packages/core/src/models/label.ts:150
Return the id of the latest build carrying a given label value, if any.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
typeKey
Section titled “typeKey”string
string
Returns
Section titled “Returns”Promise<string | null>
listForBuild()
Section titled “listForBuild()”listForBuild(
buildId):Promise<BuildLabel[]>
Defined in: packages/core/src/models/label.ts:143
List all labels attached to a build.
Parameters
Section titled “Parameters”buildId
Section titled “buildId”string
Returns
Section titled “Returns”Promise<BuildLabel[]>
listTypes()
Section titled “listTypes()”listTypes(
projectId):Promise<LabelType[]>
Defined in: packages/core/src/models/label.ts:60
List all label types for a project.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Returns
Section titled “Returns”Promise<LabelType[]>
persistentBuildIds()
Section titled “persistentBuildIds()”persistentBuildIds(
projectId):Promise<Set<string>>
Defined in: packages/core/src/models/label.ts:178
Ids of the project’s builds marked persistent (exempt from retention).
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Returns
Section titled “Returns”Promise<Set<string>>
removeType()
Section titled “removeType()”removeType(
projectId,key):Promise<void>
Defined in: packages/core/src/models/label.ts:115
Remove a custom label type, rejecting reserved or persistent types.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
Returns
Section titled “Returns”Promise<void>
seedFor()
Section titled “seedFor()”seedFor(
projectId):Promise<void>
Defined in: packages/core/src/models/label.ts:40
Seed the default label types for a project if missing.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Project ID.
Returns
Section titled “Returns”Promise<void>
updateType()
Section titled “updateType()”updateType(
projectId,key,input):Promise<LabelType|null>
Defined in: packages/core/src/models/label.ts:95
Update a custom label type’s name, template or color.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
color?
Section titled “color?”string | null
linkTemplate?
Section titled “linkTemplate?”string | null
string
Returns
Section titled “Returns”Promise<LabelType | null>