@usine/config/label
Classes
Section titled “Classes”DeclaredLabel
Section titled “DeclaredLabel”A label the factory creates in every managed repository.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DeclaredLabel(…
args):DeclaredLabel
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”
readonlycolor:Option<string&Brand<"GitHubLabelColor">>
description
Section titled “description”
readonlydescription:Option<string>
readonlyname:string&Brand<"GitHubLabelName">
Type Aliases
Section titled “Type Aliases”GitHubLabelColor
Section titled “GitHubLabelColor”GitHubLabelColor = typeof
GitHubLabelColor.Type
Six hex digits without a leading hash, as GitHub stores label colors.
GitHubLabelName
Section titled “GitHubLabelName”GitHubLabelName = typeof
GitHubLabelName.Type
GitHub trims label names and caps them at 50 characters. A name outside that contract never matches the catalog and would be re-created every cycle.
Variables
Section titled “Variables”canonicalLabelName
Section titled “canonicalLabelName”
constcanonicalLabelName: (name) =>string
Compare label names on this key: GitHub matches them case-insensitively.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name |
string |
Returns
Section titled “Returns”string
GitHubLabelColor
Section titled “GitHubLabelColor”
constGitHubLabelColor:Schema.brand<Schema.String,"GitHubLabelColor">
Six hex digits without a leading hash, as GitHub stores label colors.
GitHubLabelName
Section titled “GitHubLabelName”
constGitHubLabelName:Schema.brand<Schema.String,"GitHubLabelName">
GitHub trims label names and caps them at 50 characters. A name outside that contract never matches the catalog and would be re-created every cycle.