Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / EffectLaneFold

Class: EffectLaneFold ​

Defined in: packages/core/dist/index.d.ts

Constructors ​

Constructor ​

ts
new EffectLaneFold(entries, resolutions?): EffectLaneFold;

Defined in: packages/core/dist/index.d.ts

Parameters ​

ParameterType
entriesreadonly JournalEntry[]
resolutions?ResolutionFold

Returns ​

EffectLaneFold

Methods ​

canonicalIntent() ​

ts
canonicalIntent(logicalKey): 
  | EffectMachine
  | undefined;

Defined in: packages/core/dist/index.d.ts

The consumed intent holding logicalKey in the CURRENT epoch.

Parameters ​

ParameterType
logicalKeystring

Returns ​

| EffectMachine | undefined


classificationOf() ​

ts
classificationOf(seq): 
  | EffectLaneClassification
  | undefined;

Defined in: packages/core/dist/index.d.ts

Parameters ​

ParameterType
seqnumber

Returns ​

| EffectLaneClassification | undefined


currentEpoch() ​

ts
currentEpoch(): 
  | EffectEpochState
  | undefined;

Defined in: packages/core/dist/index.d.ts

Returns ​

| EffectEpochState | undefined


declarations() ​

ts
declarations(): EffectDeclarationState[];

Defined in: packages/core/dist/index.d.ts

Returns ​

EffectDeclarationState[]


epochs() ​

ts
epochs(): EffectEpochState[];

Defined in: packages/core/dist/index.d.ts

Returns ​

EffectEpochState[]


machineAt() ​

ts
machineAt(intentSeq): 
  | EffectMachine
  | undefined;

Defined in: packages/core/dist/index.d.ts

Parameters ​

ParameterType
intentSeqnumber

Returns ​

| EffectMachine | undefined


machines() ​

ts
machines(): EffectMachine[];

Defined in: packages/core/dist/index.d.ts

Returns ​

EffectMachine[]


openMachines() ​

ts
openMachines(): EffectMachine[];

Defined in: packages/core/dist/index.d.ts

Consumed machines that have not reached a terminal.

Returns ​

EffectMachine[]


standaloneQuarantines() ​

ts
standaloneQuarantines(): StandaloneQuarantine[];

Defined in: packages/core/dist/index.d.ts

Sweep-recorded quarantines with no machine (kill 25's remainder).

Returns ​

StandaloneQuarantine[]


standaloneRefusals() ​

ts
standaloneRefusals(): StandaloneRefusal[];

Defined in: packages/core/dist/index.d.ts

Returns ​

StandaloneRefusal[]