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

A model property.

interface ModelProp<
    TPropValue,
    TPropCreationValue,
    TTransformedValue,
    TTransformedCreationValue,
    TIsRequired,
    TIsId extends boolean = false,
    THasSetter = never,
    TFromSnapshotOverride = never,
    TToSnapshotOverride = never,
> {
    _defaultFn: () => TPropValue | typeof noDefaultValue;
    _defaultValue: TPropValue | typeof noDefaultValue;
    _fromSnapshotProcessor?: (sn: unknown) => unknown;
    _isId: boolean;
    _setter: boolean | "assign";
    _toSnapshotProcessor?: (sn: unknown) => unknown;
    _transform:
        | undefined
        | {
            transform: (
                original: unknown,
                model: object,
                propName: PropertyKey,
                setOriginalValue: (newOriginalValue: unknown) => void,
            ) => unknown;
            untransform: (
                transformed: unknown,
                model: object,
                propName: PropertyKey,
            ) => unknown;
        };
    _typeChecker: undefined
    | TypeChecker
    | LateTypeChecker;
    $creationValueType: TPropCreationValue;
    $fromSnapshotOverride: TFromSnapshotOverride;
    $hasSetter: THasSetter;
    $isId: TIsId;
    $isRequired: TIsRequired;
    $toSnapshotOverride: TToSnapshotOverride;
    $transformedCreationValueType: TTransformedCreationValue;
    $transformedValueType: TTransformedValue;
    $valueType: TPropValue;
    withSetter(): ModelProp<
        TPropValue,
        TPropCreationValue,
        TTransformedValue,
        TTransformedCreationValue,
        TIsRequired,
        TIsId,
        string,
        TFromSnapshotOverride,
        TToSnapshotOverride,
    >;
    withSetter(
        mode: "assign",
    ): ModelProp<
        TPropValue,
        TPropCreationValue,
        TTransformedValue,
        TTransformedCreationValue,
        TIsRequired,
        TIsId,
        string,
        TFromSnapshotOverride,
        TToSnapshotOverride,
    >;
    withSnapshotProcessor<
        FS = TFromSnapshotOverride,
        TS = TToSnapshotOverride,
        This extends
            AnyModelProp = ModelProp<
            TPropValue,
            TPropCreationValue,
            TTransformedValue,
            TTransformedCreationValue,
            TIsRequired,
            TIsId,
            THasSetter,
            TFromSnapshotOverride,
            TToSnapshotOverride,
        >,
    >(
        processor: {
            fromSnapshot?: (
                sn: FS,
            ) => IsNeverType<
                This["$fromSnapshotOverride"],
                SnapshotInOf<This["$creationValueType"]>,
                This["$fromSnapshotOverride"],
            >;
            toSnapshot?: (
                sn: IsNeverType<
                    This["$toSnapshotOverride"],
                    SnapshotOutOf<This["$valueType"]>,
                    This["$toSnapshotOverride"],
                >,
            ) => TS;
        },
    ): ModelProp<
        TPropValue,
        TPropCreationValue,
        TTransformedValue,
        TTransformedCreationValue,
        TIsRequired,
        TIsId,
        THasSetter,
        FS,
        TS,
    >;
    withTransform<TTV>(
        transform: ModelPropTransform<NonNullable<TPropValue>, TTV>,
    ): ModelProp<
        TPropValue,
        TPropCreationValue,
        TTV
        | Extract<TPropValue, undefined | null>,
        TTV | Extract<TPropCreationValue, undefined | null>,
        TIsRequired,
        TIsId,
        THasSetter,
        TFromSnapshotOverride,
        TToSnapshotOverride,
    >;
}

Type Parameters

  • TPropValue
  • TPropCreationValue
  • TTransformedValue
  • TTransformedCreationValue
  • TIsRequired
  • TIsId extends boolean = false
  • THasSetter = never
  • TFromSnapshotOverride = never
  • TToSnapshotOverride = never

Properties

_defaultFn _defaultValue _fromSnapshotProcessor? _isId _setter _toSnapshotProcessor? _transform _typeChecker $creationValueType $fromSnapshotOverride $hasSetter $isId $isRequired $toSnapshotOverride $transformedCreationValueType $transformedValueType $valueType

Methods

withSetter withSnapshotProcessor withTransform

Properties

_defaultFn

_defaultFn: () => TPropValue | typeof noDefaultValue

_defaultValue

_defaultValue: TPropValue | typeof noDefaultValue

Optional_fromSnapshotProcessor

_fromSnapshotProcessor?: (sn: unknown) => unknown

_isId

_isId: boolean

_setter

_setter: boolean | "assign"

Optional_toSnapshotProcessor

_toSnapshotProcessor?: (sn: unknown) => unknown

_transform

_transform:
    | undefined
    | {
        transform: (
            original: unknown,
            model: object,
            propName: PropertyKey,
            setOriginalValue: (newOriginalValue: unknown) => void,
        ) => unknown;
        untransform: (
            transformed: unknown,
            model: object,
            propName: PropertyKey,
        ) => unknown;
    }

_typeChecker

_typeChecker: undefined | TypeChecker | LateTypeChecker

$creationValueType

$creationValueType: TPropCreationValue

$fromSnapshotOverride

$fromSnapshotOverride: TFromSnapshotOverride

$hasSetter

$hasSetter: THasSetter

$isId

$isId: TIsId

$isRequired

$isRequired: TIsRequired

$toSnapshotOverride

$toSnapshotOverride: TToSnapshotOverride

$transformedCreationValueType

$transformedCreationValueType: TTransformedCreationValue

$transformedValueType

$transformedValueType: TTransformedValue

$valueType

$valueType: TPropValue

Methods

withSetter

withSnapshotProcessor

withTransform

Settings

Member Visibility

On This Page

Properties
Methods