38 lines
1.9 KiB
TypeScript
38 lines
1.9 KiB
TypeScript
import type { InjectionKey, Ref } from 'vue';
|
|
import type { LocaleInstance } from '../../composables/locale.js';
|
|
import type { ValidationProps, ValidationRule } from '../../composables/validation.js';
|
|
export type ValidationRuleBuilderWithoutOptions = (err?: string) => ValidationRule;
|
|
export type ValidationRuleBuilderWithOptions<T> = (options: T, err?: string) => ValidationRule;
|
|
export type CustomValidationRuleBuilder = (...args: any[]) => ValidationRule;
|
|
export interface RuleAliases {
|
|
[name: string]: CustomValidationRuleBuilder;
|
|
required: ValidationRuleBuilderWithoutOptions;
|
|
email: ValidationRuleBuilderWithoutOptions;
|
|
number: ValidationRuleBuilderWithoutOptions;
|
|
integer: ValidationRuleBuilderWithoutOptions;
|
|
capital: ValidationRuleBuilderWithoutOptions;
|
|
maxLength: ValidationRuleBuilderWithOptions<number>;
|
|
minLength: ValidationRuleBuilderWithOptions<number>;
|
|
strictLength: ValidationRuleBuilderWithOptions<number>;
|
|
exclude: ValidationRuleBuilderWithOptions<string[]>;
|
|
notEmpty: ValidationRuleBuilderWithoutOptions;
|
|
pattern: ValidationRuleBuilderWithOptions<RegExp>;
|
|
}
|
|
export type RulesOptions = {
|
|
aliases?: Partial<RuleAliases>;
|
|
};
|
|
type ValidationRuleParams = [any, string?];
|
|
export type ValidationAlias = string | [string, ...ValidationRuleParams];
|
|
export type RulesInstance = {
|
|
resolve: (fn: () => ValidationProps['rules']) => Readonly<Ref<any[]>>;
|
|
aliases: RuleAliases;
|
|
};
|
|
export declare function createRules(options: RulesOptions | undefined, locale: LocaleInstance): {
|
|
resolve: (fn: () => ValidationProps['rules']) => import("vue").ComputedRef<([string, any, (string | undefined)?] | ValidationRule)[]>;
|
|
aliases: RuleAliases;
|
|
};
|
|
export declare const RulesSymbol: InjectionKey<RulesInstance>;
|
|
export declare function useRules(): RuleAliases;
|
|
export declare function useRules(fn: () => ValidationProps['rules']): Readonly<Ref<ValidationProps['rules']>> | Readonly<Ref<ValidationRule[]>>;
|
|
|