StructFieldConfig

StructFieldConfig

@vendure/corecustom-field-types.ts

v3.1.0

Configures an individual field of a "struct" custom field. The individual fields share the same API as the top-level custom fields, with the exception that they do not support the readonly, internal, nullable, unique and requiresPermission options.

Example

const customFields: CustomFields = {
  Product: [
    {
      name: 'specifications',
      type: 'struct',
      fields: [
        { name: 'processor', type: 'string' },
        { name: 'ram', type: 'string' },
        { name: 'screenSize', type: 'float' },
      ],
    },
  ],
};

Signature

type StructFieldConfig = | StringStructFieldConfig
    | TextStructFieldConfig
    | IntStructFieldConfig
    | FloatStructFieldConfig
    | BooleanStructFieldConfig
    | DateTimeStructFieldConfig