react-f0rm 0.2.2 → 0.3.0

package/dist/form-d06e6444.d.ts

@@ -1,201 +0,0 @@
-import { EventEmitter } from '@for-fun/event-emitter';
-
-type PathValue$1 = (string | number)[];
-type Name$1 = string | PathValue$1;
-type Path = {
-    value: PathValue$1;
-    key: string;
-};
-
-type PathValue = (string | number)[];
-type Name = string | PathValue;
-interface Form<T extends Record<string, any> = any> {
-    emitter: EventEmitter;
-    revalidateOnChange: boolean;
-    initialValues: T;
-    values: Map<string, any>;
-    errors: Map<string, string>;
-    touched: Set<string>;
-    validators: Map<string, () => void>;
-    validating: Set<string>;
-    validate?: (values: T) => Record<string, string> | Promise<Record<string, string>>;
-    isSubmitting: boolean;
-    submitCount: number;
-    isSubmitSuccessful: boolean | undefined;
-}
-type Options<T extends Record<string, any> = any> = {
-    initialValues?: T;
-    validateOnSubmit?: boolean;
-    validateOnChange?: boolean;
-    validateOnBlur?: boolean;
-    revalidateOnChange?: boolean;
-    revalidateOnBlur?: boolean;
-    validate?: (values: T) => Record<string, string> | Promise<Record<string, string>>;
-};
-/**
- * Create form instance
- * @param options
- * @return form instance
- */
-declare function create<T extends Record<string, any> = any>(options?: Options<T>): Form<T>;
-/**
- * Get form values
- * @param form
- */
-declare function getValues(form: Form): any;
-/**
- * Get field value
- * @param form
- * @param name
- */
-declare function getValue(form: Form, name: Name): any;
-/**
- * Get field value by path
- * @param form
- * @param path
- */
-declare function getValueByPath({ initialValues, values }: Form, path: Path): any;
-/**
- * Set field value
- * @param form
- * @param name
- * @param value
- */
-declare function setValue(form: Form, name: Name, value: any): void;
-/**
- * Set field value
- * @param form
- * @param path
- * @param value
- */
-declare function setValueByPath({ emitter, values }: Form, path: Path, value: any): void;
-/**
- * Get field error
- * @param form
- * @param name
- */
-declare function getError(form: Form, name: Name): string | undefined;
-/**
- * Get field error by path
- * @param form
- * @param path
- */
-declare function getErrorByPath({ errors }: Form, path: Path): string | undefined;
-/**
- * Get all errors
- * @param form
- * @return array of error strings
- */
-declare function getErrors({ errors }: Form): string[];
-/**
- * Get first error string
- * @param form
- * @return first error string or undefined
- */
-declare function getFirstError({ errors }: Form): string | undefined;
-declare function unsetValidatingByPath({ emitter, validating }: Form, { key }: Path): void;
-declare function setValidatingByPath({ emitter, validating }: Form, { key }: Path): void;
-/**
- * Set field error
- * @param form
- * @param name
- * @param error
- */
-declare function setError(form: Form, name: Name, error: string | undefined): void;
-/**
- * Set field error
- * @param form
- * @param path
- * @param error
- */
-declare function setErrorByPath({ emitter, errors }: Form, path: Path, error: string | undefined): void;
-/**
- * Clear errors
- * @param form
- */
-declare function clearErrors({ emitter, errors }: Form): void;
-/**
- * Set field touched state
- * @param form
- * @param name
- */
-declare function setTouched(form: Form, name: Name): void;
-/**
- * Set field touched state
- * @param form
- * @param path
- */
-declare function setTouchedByPath({ emitter, touched }: Form, { key }: Path): void;
-/**
- * Check if field has been touched
- * @param form
- * @param name
- */
-declare function hasTouched(form: Form, name: Name): boolean;
-/**
- * Check if field has been touched
- * @param form
- * @param path
- */
-declare function hasTouchedByPath({ touched }: Form, path: Path): boolean;
-/**
- * Is dirty -- any value differs from initialValues
- * @param form
- */
-declare function isDirty({ initialValues, values }: Form): boolean;
-/**
- * Is touched -- any field has been touched
- * @param form
- */
-declare function isTouched({ touched }: Form): boolean;
-/**
- * Remove field
- * @param form
- * @param name
- */
-declare function removeField(form: Form, name: Name): void;
-/**
- * Remove field
- * @param form
- * @param path
- */
-declare function removeFieldByPath(form: Form, { key }: Path): void;
-/**
- * Set form initialValues
- * @param form
- * @param initialValues
- */
-declare function setInitialValues(form: Form, initialValues: any): void;
-/**
- * Reset form
- * @param form
- * @param initialValues
- */
-declare function reset(form: Form, initialValues?: any): void;
-/**
- * @param form
- */
-declare function hasErrors({ errors }: Form): boolean;
-/**
- * Trigger all fields validate.
- * @param form
- */
-declare function trigger(form: Form): void;
-/**
- * Validate and throw if any field error.
- * @param form
- * @return resolve if no error; reject and stop validate if has an error
- */
-declare function ensureValidate(form: Form): Promise<void>;
-/**
- * Validate and return if any field error.
- * @param form
- * @return error message string or void
- */
-declare function validate(form: Form): Promise<void | string>;
-declare function setIsSubmitting(form: Form, value: boolean): void;
-declare function incrementSubmitCount(form: Form): void;
-declare function setSubmitSuccessful(form: Form, value: boolean): void;
-
-export { reset as A, hasErrors as B, trigger as C, ensureValidate as D, validate as E, setIsSubmitting as G, incrementSubmitCount as H, setSubmitSuccessful as I, create as c, getValue as d, getValueByPath as e, setValueByPath as f, getValues as g, getError as h, getErrorByPath as i, getErrors as j, getFirstError as k, setValidatingByPath as l, setError as m, setErrorByPath as n, clearErrors as o, setTouched as p, setTouchedByPath as q, hasTouched as r, setValue as s, hasTouchedByPath as t, unsetValidatingByPath as u, isDirty as v, isTouched as w, removeField as x, removeFieldByPath as y, setInitialValues as z };
-export type { Form as F, Name as N, Options as O, Path as P, Name$1 as a, PathValue as b };