Skip to content

@livefolio/sdk / Tolerance

Type Alias: Tolerance

Tolerance = object

Defined in: tactical/types.ts:157

Hysteresis band applied to a Comparison with op: 'gt' or op: 'lt'. Once the comparison has flipped, it will not flip back until the left operand exits the tolerance band around the right operand.

mode: 'absolute' defines a ±value band around right. mode: 'relative' defines a ±value% band (i.e. value is a percentage).

A Tolerance requires the parent Comparison to carry a stable id so the runtime can persist the last-known state across rebalance periods.

Properties

mode

mode: "absolute" | "relative"

Defined in: tactical/types.ts:161

'absolute' uses raw units; 'relative' uses a percentage of right.


value

value: number

Defined in: tactical/types.ts:159

Half-width of the hysteresis band.

Released under the MIT License.