index.d.ts 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. import type { InternalRuleItem, InternalValidateMessages, RuleItem, RuleType, Rules, SyncErrorType, ValidateCallback, ValidateMessages, ValidateOption, Values } from './interface';
  2. export * from './interface';
  3. /**
  4. * Encapsulates a validation schema.
  5. *
  6. * @param descriptor An object declaring validation rules
  7. * for this schema.
  8. */
  9. declare class Schema {
  10. static register: (type: string, validator: any) => void;
  11. static warning: (type: string, errors: SyncErrorType[]) => void;
  12. static messages: InternalValidateMessages;
  13. static validators: {
  14. string: import("./interface").ExecuteValidator;
  15. method: import("./interface").ExecuteValidator;
  16. number: import("./interface").ExecuteValidator;
  17. boolean: import("./interface").ExecuteValidator;
  18. regexp: import("./interface").ExecuteValidator;
  19. integer: import("./interface").ExecuteValidator;
  20. float: import("./interface").ExecuteValidator;
  21. array: import("./interface").ExecuteValidator;
  22. object: import("./interface").ExecuteValidator;
  23. enum: import("./interface").ExecuteValidator;
  24. pattern: import("./interface").ExecuteValidator;
  25. date: import("./interface").ExecuteValidator;
  26. url: import("./interface").ExecuteValidator;
  27. hex: import("./interface").ExecuteValidator;
  28. email: import("./interface").ExecuteValidator;
  29. required: import("./interface").ExecuteValidator;
  30. any: import("./interface").ExecuteValidator;
  31. };
  32. rules: Record<string, RuleItem[]>;
  33. _messages: InternalValidateMessages;
  34. constructor(descriptor: Rules);
  35. define(rules: Rules): void;
  36. messages(messages?: ValidateMessages): InternalValidateMessages;
  37. validate(source: Values, option?: ValidateOption, callback?: ValidateCallback): Promise<Values>;
  38. validate(source: Values, callback: ValidateCallback): Promise<Values>;
  39. validate(source: Values): Promise<Values>;
  40. getType(rule: InternalRuleItem): RuleType;
  41. getValidationMethod(rule: InternalRuleItem): import("./interface").ExecuteValidator | ((rule: InternalRuleItem, value: any, callback: (error?: string | Error) => void, source: Values, options: ValidateOption) => void | import("./interface").SyncValidateResult);
  42. }
  43. export default Schema;