Skip to main content

Interface: ModelPropTransform<TOriginal, TTransformed>

A model prop transform.

Type Parameters​

Type Parameter
TOriginal
TTransformed

Methods​

transform()​

transform(params): TTransformed;

Converts the stored/original value into the transformed value exposed by the model prop.

Parameters​

ParameterType
params{ cachedTransformedValue: TTransformed | undefined; originalValue: TOriginal; setOriginalValue: void; }
params.cachedTransformedValueTTransformed | undefined
params.originalValueTOriginal
params.setOriginalValue

Returns​

TTransformed


untransform()​

untransform(params): TOriginal;

Converts the transformed model value back into the original stored value.

Parameters​

ParameterType
params{ cacheTransformedValue: () => void; transformedValue: TTransformed; }
params.cacheTransformedValue() => void
params.transformedValueTTransformed

Returns​

TOriginal