AdjustParams Interface

Used to define per key adjustments in an IMergeTreeAnnotateAdjustMsg

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/merge-tree/legacy.

For more information about our API support guarantees, see here.

Signature

export interface AdjustParams

Properties

Property	Alerts	Modifiers	Type	Description
delta	Beta		number	The adjustment delta which will be summed with the current value if it is a number, or summed with zero if the current value is not a number.
max	Beta	optional	number | undefined	An optional maximum value for the computed value of the key this adjustment is applied to. The maximum will be applied after the value is applied.
min	Beta	optional	number | undefined	An optional minimum value for the computed value of the key this adjustment is applied to. The minimum will be applied after the value is applied.

Property Details

delta

The adjustment delta which will be summed with the current value if it is a number, or summed with zero if the current value is not a number.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

delta: number;

Type: number

max

An optional maximum value for the computed value of the key this adjustment is applied to. The maximum will be applied after the value is applied.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

max?: number | undefined;

Type: number | undefined

min

An optional minimum value for the computed value of the key this adjustment is applied to. The minimum will be applied after the value is applied.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

min?: number | undefined;

Type: number | undefined