@usine/core/cycle-budget
Classes
Section titled “Classes”CycleBudgetAsk
Section titled “CycleBudgetAsk”An Item-level request for an operator reset before further Runs can open.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CycleBudgetAsk(…
args):CycleBudgetAsk
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”counts
Section titled “counts”
readonlycounts: readonly [LoopCycleCount,LoopCycleCount]
readonlyid:string&Brand<"EventId"> &Brand<"CycleBudgetAskId">
itemKey
Section titled “itemKey”
readonlyitemKey:string&Brand<"ItemKey">
readonlylimit:number&Brand<"CycleLimit">
readonlyloop:string&Brand<"LoopName">
repository
Section titled “repository”
readonlyrepository:string&Brand<"RepositoryName">
Accessors
Section titled “Accessors”completedCycles
Section titled “completedCycles”Get Signature
Section titled “Get Signature”get completedCycles():
number&Brand<"CycleCount">
The furthest completed round; each Loop participates at most once per round.
Returns
Section titled “Returns”number & Brand<"CycleCount">
LoopCycleCount
Section titled “LoopCycleCount”A Loop’s charged Runs and settled Runs in the current cycle budget.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LoopCycleCount(…
args):LoopCycleCount
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”admitted
Section titled “admitted”
readonlyadmitted:number&Brand<"CycleCount">
completed
Section titled “completed”
readonlycompleted:number&Brand<"CycleCount">
readonlyloop:string&Brand<"LoopName">
Type Aliases
Section titled “Type Aliases”CycleBudgetAskId
Section titled “CycleBudgetAskId”CycleBudgetAskId = typeof
CycleBudgetAskId.Type
Identifies the Event and budget generation that first exhausted an Item’s allowance.
CycleCount
Section titled “CycleCount”CycleCount = typeof
CycleCount.Type
Number of admitted or completed rounds for one Loop on an Item.
CycleGeneration
Section titled “CycleGeneration”CycleGeneration = typeof
CycleGeneration.Type
Identifies one Item allowance between explicit operator resets.
CycleLimit
Section titled “CycleLimit”CycleLimit = typeof
CycleLimit.Type
Maximum Runs one Loop may open for an Item between operator resets.
Variables
Section titled “Variables”CycleBudgetAskId
Section titled “CycleBudgetAskId”
constCycleBudgetAskId:Schema.brand<Schema.brand<Schema.NonEmptyString,"EventId">,"CycleBudgetAskId">
Identifies the Event and budget generation that first exhausted an Item’s allowance.
CycleCount
Section titled “CycleCount”
constCycleCount:Schema.brand<Schema.Int,"CycleCount">
Number of admitted or completed rounds for one Loop on an Item.
CycleGeneration
Section titled “CycleGeneration”
constCycleGeneration:Schema.brand<Schema.Int,"CycleGeneration">
Identifies one Item allowance between explicit operator resets.
CycleLimit
Section titled “CycleLimit”
constCycleLimit:Schema.brand<Schema.Int,"CycleLimit">
Maximum Runs one Loop may open for an Item between operator resets.
DEFAULT_CYCLE_LIMIT
Section titled “DEFAULT_CYCLE_LIMIT”
constDEFAULT_CYCLE_LIMIT:number&Brand
The safe default for unattended rounds on an Item.