@paragrav/rhf-utils 0.0.139 → 0.0.140

package/dist/types/submit/useResetFormOnSubmitted.d.ts

@@ -1,36 +0,0 @@
-/**
- * Configuration options for {@link useResetFormOnSubmitted}.
- */
-export type UseResetFormOnSubmittedOptions = undefined | {
-    /**
-     * Reset values on successful submit.
-     * - `defaults`: reset current values to defaults
-     * - `current`: reset defaults to current values
-     */
-    success?: {
-        values: 'defaults' | 'current';
-    };
-    /**
-     * Reset values to defaults on submit error.
-     */
-    error?: {
-        values: 'defaults';
-    };
-};
-/**
- * Control resetting of values and (some) state (e.g., `isDirty`) after form submitted.
- *
- * `isDirty` and other state is reset, but submit-related state is preserved, as well as errors.
- *
- * Use cases:
- * - on success:
- *   - `defaults`: reset current values to defaults (e.g., clear form)
- *   - `current`: reset defaults to current values (e.g., keep values)
- * - on error:
- *   - reset current values to default values (e.g., submitOnChange reset)
- *
- * See `Rules` section: https://react-hook-form.com/api/useform/reset/
- * Specifically: "- It's recommended to reset inside useEffect after submission."
- */
-declare const useResetFormOnSubmitted: (options: UseResetFormOnSubmittedOptions) => void;
-export default useResetFormOnSubmitted;

package/dist/types/submit/useSubmitFormOnChange.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-
-declare const useSubmitFormOnChange: (formRef: React.RefObject<HTMLFormElement>, options?: {
-    /** Disable behavior. (Default behavior is enabled for sake of simplicity of general usage.) */
-    disabled?: boolean;
-    /** Milliseconds to debounce form submission. (Default is none.) */
-    debounce?: number;
-}) => void;
-export default useSubmitFormOnChange;

package/dist/types/utils/PassthroughChildren.d.ts

@@ -1,7 +0,0 @@
-/**
- * Component for simply passing through children.
- *
- * (Useful for conditional wrapping of children.)
- */
-declare const PassthroughChildren: React.FC<React.PropsWithChildren>;
-export default PassthroughChildren;

package/dist/types/utils/createContext.d.ts

@@ -1,12 +0,0 @@
-import { default as React } from 'react';
-
-/**
- * Create a strictly-typed context that throws error if no provider is found.
- * @returns A tuple with a function to get the context and the context provider.
- */
-declare function createContext<T = unknown>(): {
-    readonly Provider: React.Provider<T | undefined>;
-    readonly useMaybe: () => T | undefined;
-    readonly useRequired: () => T & ({} | null);
-};
-export default createContext;

package/dist/types/utils/fixedForwardRef.d.ts

@@ -1,7 +0,0 @@
-import { default as React } from 'react';
-
-/**
- * @see https://www.totaltypescript.com/forwardref-with-generic-components
- */
-declare function fixedForwardRef<T, P = object>(render: (props: P, ref: React.Ref<T>) => React.ReactNode): (props: P & React.RefAttributes<T>) => React.ReactNode;
-export default fixedForwardRef;

package/dist/types/utils/isEmptyObject.d.ts

@@ -1,2 +0,0 @@
-declare const isEmptyObject: (obj: Record<string, unknown>) => boolean;
-export default isEmptyObject;

package/dist/types/utils/timeoutAsync.d.ts

@@ -1,6 +0,0 @@
-/**
- * Awaitable `setTimeout`.
- * @param timeout milliseconds
- * @returns `Promise<void>`
- */
-export declare const timeoutAsync: (timeout: number) => Promise<void>;

package/dist/types/utils/types.d.ts

@@ -1 +0,0 @@
-export type MaybePromise<T> = T | Promise<T>;

package/dist/types/utils/useDebouncedOnChangeValue.d.ts

@@ -1,14 +0,0 @@
-/**
- * React hook to debounce onChange event callback.
- *
- * Returns debounced state setter (uses ref internally).
- *
- * When debounce delay has elapsed after setting value,
- * onChange callback is called with latest value.
- *
- * @returns `[setValueDebounced]`
- */
-export declare const useDebouncedOnChangeValue: <TValue>({ onChange, delay, }: {
-    onChange: (value: TValue) => void;
-    delay: number;
-}) => readonly [(value: TValue) => void];

package/dist/types/utils/useImperativeForwardedRef.d.ts

@@ -1,11 +0,0 @@
-import { default as React } from 'react';
-
-/**
- * Create a ref and point forwarded ref to it.
- *
- * Use case: forwarded refs are optional, but sometimes you need the ref.
- *
- * @param forwardedRef Forwarded `ref` prop.
- */
-declare const useImperativeForwardedRef: <TRef>(forwardedRef?: React.ForwardedRef<TRef>) => React.RefObject<TRef>;
-export default useImperativeForwardedRef;

package/dist/types/utils/useRefIfValueWasTrue.d.ts

@@ -1,2 +0,0 @@
-declare const useRefIfValueWasTrue: (value: boolean) => readonly [boolean, () => void];
-export default useRefIfValueWasTrue;

package/dist/types/utils/useThrowAsyncError.d.ts

@@ -1,5 +0,0 @@
-/**
- * React cannot handle async errors in event handlers or useEffects.
- */
-declare const useThrowAsyncError: () => (error: unknown) => void;
-export default useThrowAsyncError;

package/dist/types/utils/useToggle.d.ts

@@ -1,4 +0,0 @@
-import { default as React } from 'react';
-
-declare const useToggle: (defaultValue?: boolean) => [boolean, React.DispatchWithoutAction];
-export default useToggle;