mobx-keystone
    Preparing search index...

    Interface ModelPropTransform<TOriginal, TTransformed>

    A model prop transform.

    interface ModelPropTransform<TOriginal, TTransformed> {
        transform(
            params: {
                cachedTransformedValue: TTransformed | undefined;
                originalValue: TOriginal;
                setOriginalValue(value: TOriginal): void;
            },
        ): TTransformed;
        untransform(
            params: {
                cacheTransformedValue: () => void;
                transformedValue: TTransformed;
            },
        ): TOriginal;
    }

    Type Parameters

    • TOriginal
    • TTransformed
    Index

    Methods

    transform untransform

    Methods

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

      Parameters

      Returns TTransformed

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

      Parameters

      • params: { cacheTransformedValue: () => void; transformedValue: TTransformed }

      Returns TOriginal

    Settings

    Member Visibility

    On This Page

    Methods