@usine/config/board
Classes
Section titled “Classes”LabelLaneSource
Section titled “LabelLaneSource”Places Items with this GitHub label in the lane; Board moves can write the label.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LabelLaneSource(…
args):LabelLaneSource
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”
readonlylabel:string&Brand<"GitHubLabelName">
A named Board column containing Items that match any of its configured sources.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Lane(…
args):Lane
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”
readonlyname:string&Brand<"LaneName">
sources
Section titled “sources”
readonlysources: readonly (LabelLaneSource|StateLaneSource)[]
StateLaneSource
Section titled “StateLaneSource”Places Items with this GitHub state in the lane; Board moves cannot change the state.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StateLaneSource(…
args):StateLaneSource
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”
readonlystate:"issue-open"|"issue-closed"|"pr-open"|"pr-closed"|"pr-merged"
Type Aliases
Section titled “Type Aliases”LaneItemState
Section titled “LaneItemState”LaneItemState = typeof
LaneItemState.Type
An issue or pull-request state that can place an Item in a Board lane.
LaneName
Section titled “LaneName”LaneName = typeof
LaneName.Type
The operator-visible name of one lane on a Project’s Board.
LaneSource
Section titled “LaneSource”LaneSource = typeof
LaneSource.Type
A GitHub label or Item state that routes matching Items to a Board lane.
Variables
Section titled “Variables”LaneItemState
Section titled “LaneItemState”
constLaneItemState:Schema.Literals<readonly ["issue-open","issue-closed","pr-open","pr-closed","pr-merged"]>
An issue or pull-request state that can place an Item in a Board lane.
LaneName
Section titled “LaneName”
constLaneName:Schema.brand<Schema.String,"LaneName">
The operator-visible name of one lane on a Project’s Board.
LaneSource
Section titled “LaneSource”
constLaneSource:Schema.Union<readonly [typeofLabelLaneSource, typeofStateLaneSource]>
A GitHub label or Item state that routes matching Items to a Board lane.