Function ConstantValueProperty

ConstantValueProperty<TDataValue extends Arrayable<DataValue>>(
    valueType: string,
    value: TDataValue,
    config?: PropertyConfig<TDataValue>,
    additionalMetadata?: {},
): Readonly<
    {
        createGetter: (
            value: TDataValue,
            modelData: Readonly,
            modelInstance: ModelInstance<
                Readonly<{ [s: string]: any }>,
                object,
                object,
            >,
        ) => ValueGetter<
            TDataValue,
            Readonly<{ [s: string]: any }>,
            object,
            object,
        >;
        getChoices: () => readonly ChoiceTypes[];
        getConfig: () => object;
        getConstantValue: () => undefined | TDataValue;
        getDefaultValue: () => undefined | TDataValue;
        getPropertyType: () => string;
        getValidator: (
            valueGetter: ValueGetter<
                TDataValue,
                Readonly<{ [s: string]: any }>,
                object,
                object,
            >,
        ) => PropertyValidator<Readonly<{ [s: string]: any }>>;
    },
>
A property that has a fixed value that can never be changed. Can be useful for things like embedding the name of a model into JSONified objects.
Type Parameters
- TDataValue extends Arrayable<DataValue>
Parameters
- valueType: string
  The value type for this property.
- value: TDataValue
  The value to fix.
- config: PropertyConfig<TDataValue> = {}
- additionalMetadata: {} = {}
Returns Readonly<
    {
        createGetter: (
            value: TDataValue,
            modelData: Readonly,
            modelInstance: ModelInstance<
                Readonly<{ [s: string]: any }>,
                object,
                object,
            >,
        ) => ValueGetter<
            TDataValue,
            Readonly<{ [s: string]: any }>,
            object,
            object,
        >;
        getChoices: () => readonly ChoiceTypes[];
        getConfig: () => object;
        getConstantValue: () => undefined | TDataValue;
        getDefaultValue: () => undefined | TDataValue;
        getPropertyType: () => string;
        getValidator: (
            valueGetter: ValueGetter<
                TDataValue,
                Readonly<{ [s: string]: any }>,
                object,
                object,
            >,
        ) => PropertyValidator<Readonly<{ [s: string]: any }>>;
    },
>
- Defined in work/functional-models/functional-models/src/properties.ts:450

Function ConstantValueProperty

Type Parameters

Parameters

Settings