Validation

Validation(rules?: ValitionRuleSchema[]);

type Validator = (
  value: any,
  // The rule's properties, e.g, maxLength, min...
  props?: Record<string, any>,
  ...args: any[]
) => string | boolean | Promise<string | boolean>;

type ValitionRuleSchema = Validator | {
  validator?: Validator;
  // Rule name. If not provided, a name will be auto generated 
  name?: string;
  // The error message when the rule is invalid
  message?: string;
  // Used for specific form element types. When provided,
  // the rule only apply for the provided types
  // 'string' | 'number' | 'boolean' | 'date' | 'set' | 'enum'
  for?: string[];
  // If provided, the rule will be cascade to sub form element's rule
  cascade?: boolean;
  // Decide the current rule should be inherited from 
  // the parent form element or not
  inherit?: boolean;
};

addRules(rulesOrSchemas: (Rule | ValitionRuleSchema)[], options?: { from?: number }): Rule[];

{
  // The position that the rules will be added from
  from?: number;
}

addRule(ruleOrSchema: Rule | ValitionRuleSchema, options?: { from?: number }): Rule;

{
  // The position that the rule will be added from
  from?: number;
}

removeRules(removes: (Rule | string)[]): Rule[];

removeRule(remove: Rule | string): Rule;

reset(): void;

async validate(
  value: any,
  options: { excluded?: string[]; picks?: string[] } = {},
  ...args: any[]
): Promise<Validation>;

{
  // Array of rule names don't want to validate
  excluded?: string[]; 
  // Array of rule names want to validate
  picks?: string[];
}

getSchema(): (Validator | RuleSchema<string> | undefined)[] | null;