Interface ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, THasSetter, TFromSnapshotOverride, TToSnapshotOverride>

_defaultFn

_defaultValue

Optional_fromSnapshotProcessor

Optional_idGenerator

_isId

_setter

_setterValueTransform

Optional_toSnapshotProcessor

_transform

_typeChecker

$creationValueType

$fromSnapshotOverride

$hasSetter

$isId

$isRequired

$toSnapshotOverride

$transformedCreationValueType

$transformedValueType

$valueType

withSetter

• withSetter(): ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      string,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

  Adds a setter to the property. The setter will be named set${CapitalizedPropName} and will be available in the model instance.

  Returns ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      string,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

• withSetter(
      valueTransform: ModelPropSetterValueTransform<TTransformedValue>,
  ): ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      string,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

  Adds a setter with a transform to the property. The setter will be named set${CapitalizedPropName} and will be available in the model instance.

  Parameters

  • valueTransform: ModelPropSetterValueTransform<TTransformedValue>

  Returns ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      string,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

• withSetter(
      mode: "assign",
  ): ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      string,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

  Parameters

  • mode: "assign"

  Returns ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      string,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

  Deprecated

  Setter methods are preferred.

withSnapshotProcessor

• withSnapshotProcessor<
      FS = TFromSnapshotOverride,
      TS = TToSnapshotOverride,
      This extends
          AnyModelProp = ModelProp<
          TPropValue,
          TPropCreationValue,
          TTransformedValue,
          TTransformedCreationValue,
          TIsRequired,
          TIsId,
          THasSetter,
          TFromSnapshotOverride,
          TToSnapshotOverride,
      >,
  >(
      processor: {
          fromSnapshot?: (
              sn: FS,
          ) => IsNeverType<ModelPropFromSnapshotOverride<This>>;
          toSnapshot?: (sn: IsNeverType<This["$toSnapshotOverride"]>) => TS;
      },
  ): ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      THasSetter,
      FS,
      TS,
  >

  Sets snapshot processors for this property.

  fromSnapshot runs before assigning snapshot data into the model prop. toSnapshot runs when exporting model data back to snapshot form.

  Type Parameters

  • FS = TFromSnapshotOverride
  • TS = TToSnapshotOverride
  • This extends AnyModelProp = ModelProp<
        TPropValue,
        TPropCreationValue,
        TTransformedValue,
        TTransformedCreationValue,
        TIsRequired,
        TIsId,
        THasSetter,
        TFromSnapshotOverride,
        TToSnapshotOverride,
    >

  Parameters

  • processor: {
        fromSnapshot?: (
            sn: FS,
        ) => IsNeverType<ModelPropFromSnapshotOverride<This>>;
        toSnapshot?: (sn: IsNeverType<This["$toSnapshotOverride"]>) => TS;
    }

  Returns ModelProp<
      TPropValue,
      TPropCreationValue,
      TTransformedValue,
      TTransformedCreationValue,
      TIsRequired,
      TIsId,
      THasSetter,
      FS,
      TS,
  >

withTransform

• withTransform<TTV>(
      transform: ModelPropTransform<NonNullable<TPropValue>, TTV>,
  ): ModelProp<
      TPropValue,
      TPropCreationValue,
      TTV
      | Extract<TPropValue, null | undefined>,
      TTV | Extract<TPropCreationValue, null | undefined>,
      TIsRequired,
      TIsId,
      THasSetter,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

  Sets a transform for the property instance value.

  Type Parameters

  • TTV

    Transformed value type.

  Parameters

  • transform: ModelPropTransform<NonNullable<TPropValue>, TTV>

    Transform to be used.

  Returns ModelProp<
      TPropValue,
      TPropCreationValue,
      TTV
      | Extract<TPropValue, null | undefined>,
      TTV | Extract<TPropCreationValue, null | undefined>,
      TIsRequired,
      TIsId,
      THasSetter,
      TFromSnapshotOverride,
      TToSnapshotOverride,
  >

  Deprecated

  Prefer using tProp(types.codec(...)) or one of the built-in codec types (e.g. types.dateAsTimestamp, types.bigint, types.mapFromObject(...)) instead. Wrap with types.skipCheck(...) if you don't need runtime validation. Use .withTransform(...) only for one-off custom transforms without a codec equivalent.