functional-models
    Preparing search index...

    Function TextProperty

    • A simple text property. If it's possible to put ALOT of text in this field consider using the BigTextProperty

      Type Parameters

      • T extends string | null | undefined = string

      Parameters

      • config: PropertyConfig<T> = {}

        Additional Configurations

      • additionalMetadata: {} = {}

        Additional Metadata

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

    Settings

    Member Visibility