effex-monorepo
    Preparing search index...

    Variable Field

    Field: {
        Array: <F extends Field<any, any>>(
            element: F,
            config?: FieldConfig,
        ) => ArrayField<F>;
        FieldTypeId: symbol;
        isArrayField: <A, I>(
            field: Field<A, I>,
        ) => field is ArrayField<Field<any, any>>;
        isField: (value: unknown) => value is Field<any, any>;
        isLeafField: <A, I>(field: Field<A, I>) => field is LeafField<A, I>;
        isMapField: <A, I>(
            field: Field<A, I>,
        ) => field is MapField<unknown, Field<any, any>>;
        isStructField: <A, I>(
            field: Field<A, I>,
        ) => field is StructField<Record<string, Field<any, any>>>;
        make: {
            <A, I>(schema: Schema<A, I>, config?: FieldConfig): LeafField<A, I>;
            <F extends Record<string, Field<any, any>>>(
                fields: F,
                config?: FieldConfig,
            ): StructField<F>;
        };
        Map: <K, F extends Field<any, any>>(
            key: Schema<K>,
            element: F,
            config?: FieldConfig,
        ) => MapField<K, F>;
    }

    Type Declaration

    • Array: <F extends Field<any, any>>(element: F, config?: FieldConfig) => ArrayField<F>
    • FieldTypeId: symbol
    • isArrayField: <A, I>(field: Field<A, I>) => field is ArrayField<Field<any, any>>

      Check if a field is an array field.

    • isField: (value: unknown) => value is Field<any, any>

      Check if a value is a Field.

    • isLeafField: <A, I>(field: Field<A, I>) => field is LeafField<A, I>

      Check if a field is a leaf field.

    • isMapField: <A, I>(field: Field<A, I>) => field is MapField<unknown, Field<any, any>>

      Check if a field is a map field.

    • isStructField: <A, I>(
          field: Field<A, I>,
      ) => field is StructField<Record<string, Field<any, any>>>

      Check if a field is a struct field.

    • make: {
          <A, I>(schema: Schema<A, I>, config?: FieldConfig): LeafField<A, I>;
          <F extends Record<string, Field<any, any>>>(
              fields: F,
              config?: FieldConfig,
          ): StructField<F>;
      }
    • Map: <K, F extends Field<any, any>>(
          key: Schema<K>,
          element: F,
          config?: FieldConfig,
      ) => MapField<K, F>