functional-models
    Preparing search index...

    Function Property

    • The base function that creates a fully loaded instance of a property. All standard issue properties use this function.

      Type Parameters

      • TValue extends Arrayable<DataValue>

        The typescript value that the property produces.

      • TData extends Readonly<{ [s: string]: any }> = Readonly<{ [s: string]: any }>

        The DataDescription that this property instance belongs to.

      • TModelExtensions extends object = object

        Any additional model extensions

      • TModelInstanceExtensions extends object = object

        Any additional model instance extensions

      Parameters

      • propertyType: string

        The property's value type.

      • config: PropertyConfig<TValue> = {}

        Configurations

      • additionalMetadata: {} = {}

        Additional metadata that you want to add to a given property.

      Returns Readonly<
          {
              createGetter: (
                  value: TValue,
                  modelData: TData,
                  modelInstance: ModelInstance<
                      TData,
                      TModelExtensions,
                      TModelInstanceExtensions,
                  >,
              ) => ValueGetter<
                  TValue,
                  TData,
                  TModelExtensions,
                  TModelInstanceExtensions,
              >;
              getChoices: () => readonly ChoiceTypes[];
              getConfig: () => object;
              getConstantValue: () => undefined | TValue;
              getDefaultValue: () => undefined | TValue;
              getPropertyType: () => string;
              getValidator: (
                  valueGetter: ValueGetter<
                      TValue,
                      TData,
                      TModelExtensions,
                      TModelInstanceExtensions,
                  >,
              ) => PropertyValidator<TData>;
          },
      >

    Settings

    Member Visibility