-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.d.ts
55 lines (48 loc) · 1.43 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
export type Validation<T> = {
errorMessage: string;
validator: FormuaValidator<T>;
};
export type FormuaValidator<T> = IndependentValidator<T> | DependentValidator<T>;
export type IndependentValidator<T> = (value: T) => boolean;
export type DependentValidator<T> = (fields: Record<string, string | boolean>, value: T) => boolean;
type TransformationMap = {
[key: string]: (value: string) => any;
};
type ValidationsMap = {
[key: string]: Validation<any>;
};
export type FormuaParams = {
form?: HTMLFormElement | HTMLElement | Element | null;
validations?: ValidationsMap;
transforms?: TransformationMap;
/**
* use legacy listeners
* @default false
*/
legacyListeners?: boolean;
};
export class FormData {
constructor(data?: Record<string, any>);
data: Record<string, any>;
get(key): any;
getAll(): Record<string, any>;
has(key): boolean;
set(key, value): void;
select(...keys: string[]): Record<string, any>;
drop(...keys: string[]): Record<string, any>;
keys(): string[];
values(): any[];
entries(): Record<string, any>;
toString(): string;
toJSON(): Record<string, any>;
hashcode(): string;
}
type FormuaResult = {
formData: FormData;
pureData: FormData;
formErrors: Record<string, string>;
isFormValid: boolean;
validateForm: () => { isValid: boolean; errors: Record<string, string> };
validatedErrors: Record<string, string>;
};
export function Formua(params?: FormuaParams): FormuaResult;