query-debounce v2.4.1

Query Debounce

Query Debounce is a custom hook designed to facilitate the management of multiple inputs that can be debounced in the form of an object, making it easier to manage numerous query parameters to avoid unnecessary repeated calls to the server (API).

Features

• Facilitates debouncing for multiple inputs (state object).
• Can retrieve values without debounce (callback on set value).
• Provides progress status for change, loading, or success.
• Returns are available for set value, set value bulk, get, watch, actual aatch, clear, and register.

Installation

With npm

npm install query-debounce

With yarn

yarn add query-debounce

With pnpm

pnpm add query-debounce

Quickstart

import { useQueryDebounce } from "query-debounce";
const App = () => {
  const { register, getValues, getValidValues, watch } = useQueryDebounce({
    defaultValues: {
      name: "",
      status: "",
    },
    wait: 500,
  });

  // Get all values
  console.log(getValues());
  // Get all valid values
  console.log(getValidValues());
  // Get value by key
  console.log(watch("name"));

  return (
    <div>
      <label htmlFor="name">Name:</label>
      <input id="name" type="text" {...register("name")} />
      <label htmlFor="status">status:</label>
      <input id="status" type="text" {...register("status")} />
    </div>
  );
};

export default App;

Documentation

useQueryDebounce: (options) => Return

Query Debounce is a custom hook for creating debounced states.

Options

The options for useQueryDebounce are as follows:

• defaultValues

• onProgress

• onSuccess

• wait

defaultValues: DefaultValue | () => TDefaultValue

defaultValues is used to set default values for an object or a function that returns data.

onProgress: (status, totalTimer) => void

onProgress is used to capture the progress during the debounce wait process.

Props

status: loading | success

Fetching the value of progress status.

totalTimer

Fetching the total wait timer.

onSuccess: (data) => void

onSuccess will be called when the setValue process succeeds.

Props

data: TDefaultValue

Fetching data in the form of an object.

wait: number

wait is used to set the waiting time before the setValue is executed, default value: 500ms.

Returns

The return from useQueryDebounce is as follows:

• getValues

• getValidValues

• getActualValues

• setValue

• setBulkValues

• clearValues

• register

• actualWatch

• watch

• reset

getValues: () => TDefaultValue

getValues is used to fetch all values of the object.

getValidValues: () => Partial<TDefaultValue>

getValidValues is used to fetch all valid values of the object.

getActualValues: () => Partial<TDefaultValue>

getUnbouncedValue is used to fetch all values without debounce of the object..

setValue: (key, value, callback) => void

setValue is used to set a value.

Props

key: keyof TDefaultValue

key is the key of the object for which you want to set a value.

value: Partial<TDefaultValue>[keyof TDefaultValue]

value is the value you want to set according to the key.

callback?: (data: Partial<TDefaultValue>) => void

callback is used to fetch all values before setting a new value.

setBulkValues: (values, callback) => void

setBulkValues is used to set multiple values at once.

Props

values: Partial<TDefaultValue>

values is the object for which you want to set the bulk values.

callback?: (data: Partial<TDefaultValue>) => void

callback is used to fetch all values before setting a new value.

clearValues: (key) => void

clearValues is used to delete values that have been stored based on the key.

Props

key: keyof TDefaultValue | Array<keyof TDefaultValue>

key is the key of the object that you want to delete.

register: (key) => { onChange}

register is used to associate this registration with the returned onChange object for the registered input

Props

key: keyof TDefaultValue

key is the key of the object you want to register.

Return

onChange: (event: React.ChangeEvent<HTMLInputElement>) => void

onChange is used to perform a value change

actualWatch: (key, calback) => void

watch is used to fetch actual values based on the key.

watch: (key, calback) => void

watch is used to fetch values based on the key.

Props

key: keyof TDefaultValue

key is the key of the object you want to retrieve.

calback?: ((data: Partial<TDefaultValue>) => void) | undefined)

callback is used to fetch all values within the watch function.

reset: () => void

reset is used to reset the value to the default values.

Good luck, have fun!

Let me know if u have feedback, thanks