@bigbinary/neeto-commons-frontend 2.0.99 → 2.0.101

package/react-utils.d.ts

@@ -93,20 +93,6 @@ type OptionsType = {
  *
  * on the screen.
  *
- * This hook will accept two arguments an element and an options object. Passing an
- *
- * element using ref requires you to pass ref.current as an argument or pass an
- *
- * element that you accessed via getElementById/querySelector etc. Since it uses
- *
- * Intersection Observer API you can pass observer options such as root,
- *
- * rootMargin, threshold, etc as the second argument. You can read more about
- *
- * Intersection Observer API and the supported options from
- *
- * MDN Intersection Observer API.
- *
  * @example 
  *
  * const ref = useRef(null);
@@ -133,9 +119,7 @@ export function useIsElementVisibleInDom(target: Element | null, options?: Optio
  *
  * until the updates are stopped. We can use this to limit the number of API calls
  *
- * triggered from a user input like search box.
- *
- * This hook accepts a value and a delay as an argument. The value returned by the
+ * triggered from a user input like search box. The value returned by the
  *
  * hook will only reflect the latest value when the hook has not been called for
  *
@@ -162,9 +146,7 @@ export function useDebounce<T>(value: T, delay?: number): T;
  *
  * function will be executed only when the dependencies stops changing for a while.
  *
- * This hook accepts a function as an argument. It will return a debounced version
- *
- * of that function. The debounced function comes with a cancel method which can
+ * The debounced function comes with a cancel method which can
  *
  * be used to cancel the delayed function invocation.
  *
@@ -196,12 +178,6 @@ export function useFuncDebounce<F extends Function>(func: F, delay?: number): F
  *
  * operations on the localStorage, prefer the vanilla localStorage API functions.
  *
- * This hook is very similar to useState. The only difference is that you must
- *
- * pass the storage key in the 1st parameter so that we can default to that value
- *
- * on page load instead of specified initial value.
- *
  * @example 
  *
  * // here "theme" is the storage key and "light" is the initial value
@@ -228,12 +204,6 @@ export function useLocalStorage<T>(key: string, initialValue?: T): [T, (value: T
  *
  * A hook used to detect clicks outside of a specified element.
  *
- * This hook will accept two arguments: a ref and a handler. The ref is a reference
- *
- * to the element for which we want to detect outside clicks and handler is the
- *
- * action we want to perform when we click outside the element.
- *
  * @example 
  *
  * const ref = useRef();
@@ -278,6 +248,12 @@ export function usePrevious<T>(value: T): T;
  *
  * if the dependencies change.
  *
+ * @example 
+ *
+ * useUpdateEffect(() => {
+ *   setTitle(value)
+ * }, [value]);
+ * @endexample
 */
 export function useUpdateEffect(effect: () => void, deps: any[]): void;
 /**
@@ -292,6 +268,18 @@ export function useUpdateEffect(effect: () => void, deps: any[]): void;
  *
  * for more details.
  *
+ * @example 
+ *
+ * const App = () => {
+ *   const isError = useDisplayErrorPage();
+ * 
+ *   if (isError) {
+ *     return <ErrorPage />;
+ *   }
+ * 
+ *   return <Main />;
+ * };
+ * @endexample
 */
 export function useDisplayErrorPage(): boolean;
 /**
@@ -325,12 +313,6 @@ type TimerType = {
  *
  * application to be manually refreshed.
  *
- * This hook accepts a single argument timerIntervalInSeconds, which is the
- *
- * number of seconds after which the component will re-render. The default value is
- *
- * 60 seconds.
- *
  * All invocations of useTimer hooks are attached to a single setInterval call
  *
  * which ticks every 1 second. So using that hook in multiple components won't
@@ -362,8 +344,6 @@ type ZustandConfigType = (set: (data: any) => void, get: () => any, api: any) =>
  *
  * overwritten.
  *
- * Usage:
- *
  * @example 
  *
  * const useStore = create(
@@ -414,15 +394,9 @@ export declare type ZustandStoreHook = UseBoundStore<StoreApi<any>> & {
  *
  * will not submit when Shift + Enter is pressed. Shift + Enter can be used to
  *
- * add new lines to text area in the form.
- *
- * The hook accepts a callback, onSubmit, which will be called with no arguments
- *
- * when Enter key press is detected.
+ * add new lines to text area in the form. The hook returns a ref. This need to be
  *
- * The hook returns a ref. This need to be attached to the input element to be
- *
- * listened to.
+ * attached to the input element to be listened to.
  *
  * @example 
  *
@@ -460,6 +434,8 @@ export function withTitle(Component: () => JSX.Element, title?: string): (props)
  *
  * send notifications and then register the browser with the notification service.
  *
+ * The VAPID public key.
+ *
  * After the user logs in, we need to ask the user permissions to send
  *
  * notifications and then register the browser with the notification service.
@@ -550,14 +526,12 @@ export async function destroyBrowserSubscription(): Promise<void>;
  *
  * This function can be used to handle onClick actions that redirects to a URL.
  *
- * It opens up the URL in a new tab if ctrl/cmd + click event is recieved.
+ * It opens up the URL in a new tab if ctrl/cmd + click event is received.
  *
  * Otherwise, simply redirects to the provided URL in the same tab. URL can be
  *
  * passed as string or a history location object can be passed instead.
  *
- * Usage:
- *
  * @example 
  *
  * handleMetaClick(history, "/dashboard", e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise simply redirects to "/dashboard".
@@ -571,14 +545,12 @@ export function handleMetaClick(history: History, params: string | object, event
  *
  * This function can be used to handle onClick actions that redirects to a URL.
  *
- * It opens up the URL in a new tab if ctrl/cmd + click event is recieved.
+ * It opens up the URL in a new tab if ctrl/cmd + click event is received.
  *
  * Otherwise, simply redirects to the provided URL in the same tab. URL can be
  *
  * passed as string or a history location object can be passed instead.
  *
- * Usage:
- *
  * @example 
  *
  * handleMetaClick(history, "/dashboard", e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise simply redirects to "/dashboard".
@@ -592,14 +564,12 @@ export function handleMetaClick(history: History, params: string | object): (eve
  *
  * This function can be used to handle onClick actions that redirects to a URL.
  *
- * It opens up the URL in a new tab if ctrl/cmd + click event is recieved.
+ * It opens up the URL in a new tab if ctrl/cmd + click event is received.
  *
  * Otherwise, simply redirects to the provided URL in the same tab. URL can be
  *
  * passed as string or a history location object can be passed instead.
  *
- * Usage:
- *
  * @example 
  *
  * handleMetaClick(history, "/dashboard", e); //Opens "/dashboard" in a new tab if metaKey/CtrlKey is pressed. Otherwise simply redirects to "/dashboard".
@@ -615,8 +585,6 @@ export function handleMetaClick(history: History): (params: string | object, eve
  *
  * ctrlKey pressed.
  *
- * Usage:
- *
  * @example 
  *
  * isMetaKeyPressed(event); //returns true if "event.metaKey || event.ctrlKey" is true, otherwise returns false.
@@ -636,8 +604,6 @@ type ConfigType = {
  *
  * corresponding handler will be invoked.
  *
- * This hook accepts 3 arguments hotkey, handler & config.
- *
  * @example 
  *
  * // openSidebar function will only be called if the user is focused inside the textarea and performs the key combination.
@@ -662,8 +628,6 @@ export function useHotKeys(hotkey: string | string[], handler: (event: React.Key
  *
  * listen to other variable changes.
  *
- * This hook accepts a defaultValue and an optional array called dependencies.
- *
  * If dependencies is passed, the hook returns a state variable whose value will
  *
  * be updated to defaultValue in a useEffect that depends on the dependencies
@@ -713,10 +677,6 @@ export function useRegisterNavigationCheckpoint(): (key: string, path: string) =
  *
  * This hook returns the registered navigation checkpoint.
  *
- * This hook accepts key and will return the checkpoint path corresponding to the
- *
- * key from a Zustand store.
- *
  * @example 
  *
  * const navigationCheckpoint = useRegisterNavigationCheckpoint(CHECK_POINT_KEY);

package/utils.d.ts

@@ -10,8 +10,6 @@ export function resetAuthTokens(): void;
  *
  * event as the second, and executes the given function with event.target.value
  *
- * Usage:
- *
  * @example 
  *
  * const onChange = val => console.log(`Value = ${val}`);
@@ -30,8 +28,6 @@ export function withEventTargetValue(func: (value: string) => void, event: React
  *
  * event as the second, and executes the given function with event.target.value
  *
- * Usage:
- *
  * @example 
  *
  * const onChange = val => console.log(`Value = ${val}`);
@@ -48,8 +44,6 @@ export function withEventTargetValue(func: (value: string) => void): (event: Rea
  *
  * This function returns the subdomain of the current URL.
  *
- * Usage:
- *
  * @example 
  *
  * // Let the current url be "https://spinkart.example.com".
@@ -63,10 +57,6 @@ export function getSubdomain(): string;
  *
  * Curried: false
  *
- * Returns the specified hardcoded data after some delay for simulating an API
- *
- * call.
- *
  * This function will simulate an API call and retrieve the hardcoded success/error
  *
  * responses after some delay based on the given error probability. This function
@@ -85,18 +75,6 @@ export function simulateApiCall<T>(result: T, error?: any, errorProbability?: nu
  *
  * Copies the given string to clipboard and shows a success toaster message.
  *
- * This function accepts a string as an argument and copies it to the clipboard.
- *
- * Also, it accepts two optional arguments: a boolean flag to indicate whether a
- *
- * toaster should be shown and a message to be shown in the toaster. By default the
- *
- * show toaster flag is set to true and the toaster message is set to "Copied to
- *
- * clipboard!". You can override these defaults by passing the appropriate values
- *
- * to the function.
- *
  * @example 
  *
  * copyToClipboard("https://spinkart.example.com", {
@@ -162,12 +140,6 @@ export const dateFormat: typeof timeFormat;
  *
  * locale.
  *
- * The function also accepts options, which will be forwarded to
- *
- * Number.prototype.toLocaleString, which can be used for additional
- *
- * configurations like rounding, currency, units etc.
- *
  * @example 
  *
  * toLocale(1000000); // "1,000,000" when locale is "en-US"
@@ -207,8 +179,6 @@ type QueryParamsType = {
  *
  * This function returns all the query parameters of the current URL as an object.
  *
- * Usage:
- *
  * @example 
  *
  * // Let the current url be "https://example.com?search=something&sort=date".
@@ -224,7 +194,7 @@ export function getQueryParams(options?: qsOptionsType): QueryParamsType;
  *
  * This function joins the given strings with hyphen.
  *
- * Usage:
+ * Any number of string arguments.
  *
  * @example 
  *
@@ -240,12 +210,6 @@ export function joinHyphenCase(...args: string[]): string;
  *
  * stated wait time in milliseconds has elapsed since the last time it was invoked.
  *
- * It accepts the function to be debounced as the first argument, the delay in
- *
- * milliseconds as the second argument.
- *
- * Usage:
- *
  * @example 
  *
  * const searchForProducts = debounce(async key => {
@@ -263,8 +227,6 @@ export function debounce<F extends Function>(func: F, delay?: number): F;
  *
  * This function will return true if the current user has the given permission.
  *
- * Usage:
- *
  * @example 
  *
  * hasPermission("user.view_settings");
@@ -279,7 +241,7 @@ export function hasPermission(permission: string): boolean;
  *
  * permissions.
  *
- * Usage:
+ * permissions: Any number of permission strings.
  *
  * @example 
  *
@@ -295,7 +257,7 @@ export function hasAnyPermission(...permissions: string[]): boolean;
  *
  * permissions.
  *
- * Usage:
+ * permissions: Any number of permission strings.
  *
  * @example 
  *
@@ -311,12 +273,10 @@ type ChannelNameWithParams = {
  *
  * Curried: false
  *
- * This function will create subscription were consumer is subscribed to rails
+ * This function will create subscription where consumer is subscribed to rails
  *
  * action cable channel.
  *
- * Usage:
- *
  * @example 
  *
  * const subscription = createSubscription(