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

A model property.

interface ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, THasSetter, TFromSnapshotOverride, TToSnapshotOverride> {
    $creationValueType: TPropCreationValue;
    $fromSnapshotOverride: TFromSnapshotOverride;
    $hasSetter: THasSetter;
    $isId: TIsId;
    $isRequired: TIsRequired;
    $toSnapshotOverride: TToSnapshotOverride;
    $transformedCreationValueType: TTransformedCreationValue;
    $transformedValueType: TTransformedValue;
    $valueType: TPropValue;
    _defaultFn: (() => TPropValue) | typeof noDefaultValue;
    _defaultValue: TPropValue | typeof noDefaultValue;
    _fromSnapshotProcessor?: ((sn) => unknown);
    _isId: boolean;
    _setter: boolean | "assign";
    _toSnapshotProcessor?: ((sn) => unknown);
    _transform: undefined | {
        transform: ((original, model, propName, setOriginalValue) => unknown);
        untransform: ((transformed, model, propName) => unknown);
    };
    _typeChecker: undefined | TypeChecker | LateTypeChecker;
    withSetter(): ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, string, TFromSnapshotOverride, TToSnapshotOverride>;
    withSetter(mode): ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, string, TFromSnapshotOverride, TToSnapshotOverride>;
    withSnapshotProcessor<FS, TS, This>(processor): ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, THasSetter, FS, TS>;
    withTransform<TTV>(transform): 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

$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

_defaultFn

_defaultFn: (() => TPropValue) | typeof noDefaultValue

Type declaration

- (): TPropValue
- Returns TPropValue

_defaultValue

_defaultValue: TPropValue | typeof noDefaultValue

`Optional` _fromSnapshotProcessor

_fromSnapshotProcessor?: ((sn) => unknown)

Type declaration

- (sn): unknown
- Parameters
  - sn: unknown
  Returns unknown

_isId

_isId: boolean

_setter

_setter: boolean | "assign"

`Optional` _toSnapshotProcessor

_toSnapshotProcessor?: ((sn) => unknown)

Type declaration

- (sn): unknown
- Parameters
  - sn: unknown
  Returns unknown

_transform

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

Type declaration

transform: ((original, model, propName, setOriginalValue) => unknown)
- - (original, model, propName, setOriginalValue): unknown
  - Parameters
    - original: unknown
    - model: object
    - propName: PropertyKey
    - setOriginalValue: ((newOriginalValue) => void)
      (newOriginalValue): void
      Parameters
      newOriginalValue: unknown
      Returns void
    Returns unknown
untransform: ((transformed, model, propName) => unknown)
- - (transformed, model, propName): unknown
  - Parameters
    - transformed: unknown
    - model: object
    - propName: PropertyKey
    Returns unknown

_typeChecker

_typeChecker: undefined | TypeChecker | LateTypeChecker

Methods

withSetter

withSetter(): ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, string, TFromSnapshotOverride, TToSnapshotOverride>
Returns ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, string, TFromSnapshotOverride, TToSnapshotOverride>
withSetter(mode): 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, TS, This>(processor): ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, THasSetter, FS, TS>
Type Parameters
- FS = TFromSnapshotOverride
- TS = TToSnapshotOverride
- This extends AnyModelProp = ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, THasSetter, TFromSnapshotOverride, TToSnapshotOverride>
Parameters
- processor: {
  fromSnapshot?(sn): IsNeverType<This["$fromSnapshotOverride"], SnapshotInOf<This["$creationValueType"]>, This["$fromSnapshotOverride"]>;
  toSnapshot?(sn): TS;
  }
  - fromSnapshot?:function
    - fromSnapshot(sn): IsNeverType<This["$fromSnapshotOverride"], SnapshotInOf<This["$creationValueType"]>, This["$fromSnapshotOverride"]>
    - Parameters
      sn: FS
      Returns IsNeverType<This["$fromSnapshotOverride"], SnapshotInOf<This["$creationValueType"]>, This["$fromSnapshotOverride"]>
  - toSnapshot?:function
    - toSnapshot(sn): TS
    - Parameters
      sn: IsNeverType<This["$toSnapshotOverride"], SnapshotOutOf<This["$valueType"]>, This["$toSnapshotOverride"]>
      Returns TS
Returns ModelProp<TPropValue, TPropCreationValue, TTransformedValue, TTransformedCreationValue, TIsRequired, TIsId, THasSetter, FS, TS>

withTransform

withTransform<TTV>(transform): ModelProp<TPropValue, TPropCreationValue, TTV | Extract<TPropValue, undefined | null>, TTV | Extract<TPropCreationValue, undefined | null>, TIsRequired, TIsId, THasSetter, TFromSnapshotOverride, TToSnapshotOverride>
Sets a transform for the property instance value.
Type Parameters
- TTV
Parameters
- transform: ModelPropTransform<NonNullable<TPropValue>, TTV>
  Transform to be used.
Returns ModelProp<TPropValue, TPropCreationValue, TTV | Extract<TPropValue, undefined | null>, TTV | Extract<TPropCreationValue, undefined | null>, TIsRequired, TIsId, THasSetter, TFromSnapshotOverride, TToSnapshotOverride>
Typeparam
TTV Transformed value type.

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

Type Parameters

Index

Properties

Methods

Properties

$creationValueType

$fromSnapshotOverride

$hasSetter

$isId

$isRequired

$toSnapshotOverride

$transformedCreationValueType

$transformedValueType

$valueType

_defaultFn

Type declaration

Returns TPropValue

_defaultValue

Optional _fromSnapshotProcessor

Type declaration

Parameters

Returns unknown

_isId

_setter

Optional _toSnapshotProcessor

Type declaration

Parameters

Returns unknown

_transform

Type declaration

transform: ((original, model, propName, setOriginalValue) => unknown)

Parameters

Parameters

Returns void

Returns unknown

untransform: ((transformed, model, propName) => unknown)

Parameters

Returns unknown

_typeChecker

Methods

withSetter

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

Parameters

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

Deprecated

withSnapshotProcessor

Type Parameters

Parameters

fromSnapshot?:function

Parameters

Returns IsNeverType<This["$fromSnapshotOverride"], SnapshotInOf<This["$creationValueType"]>, This["$fromSnapshotOverride"]>

toSnapshot?:function

Parameters

Returns TS

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

withTransform

Type Parameters

Parameters

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

Typeparam

Settings

Member Visibility

Theme

On This Page

`Optional` _fromSnapshotProcessor

`Optional` _toSnapshotProcessor