FieldTypeDefinition interface exported

Last updated: 2026-03-03T19:04:25.123Z

Metrics

LOC: 13 Complexity: 1 Params: 0

Signature

interface FieldTypeDefinition

Summary

Metadata entry describing a single field type with its category, generator, and params.

Source Code

export interface FieldTypeDefinition {
  readonly type: FieldType;
  readonly category: FieldCategory;
  readonly description: string;
  /**
   * Key referencing a generator factory in the generator registry.
   * Types that share a generator use the same key with different params
   * (e.g. money, price, amount → "money" with different min/max).
   * If omitted, `generate()` falls back to a generic text generator.
   */
  readonly generator?: string;
  readonly params?: GeneratorParams;
}

No outgoing dependencies.

No incoming dependencies.