@siberiacancode/reactuse 0.2.9 → 0.2.11

package/dist/types/hooks/useCookies/useCookies.d.ts

@@ -1,7 +1,10 @@
 import { RemoveCookieParams, SetCookieParams } from '../useCookie/useCookie';
-export declare const getParsedCookies: () => {
-    [k: string]: any;
-};
+/** The cookies params type */
+export type CookieParams = Record<string, any>;
+export interface UseCookiesOptions<Value> {
+    deserializer?: (value: string) => Value[keyof Value];
+    serializer?: (value: Value[keyof Value]) => string;
+}
 export declare const clearCookies: () => void;
 /**
  * @name useCookies
@@ -10,18 +13,15 @@ export declare const clearCookies: () => void;
  *
  * @overload
  * @template {object} Value The type of the cookie values
- * @param {string} key The key of the cookie
  * @returns {UseCookieReturn<Value>} The value and the set function
  *
  * @example
  * const { value, set, remove, getAll, clear } = useCookies();
  */
-export declare const useCookies: <Value>() => {
+export declare const useCookies: <Value extends CookieParams>(options?: UseCookiesOptions<Value>) => {
     value: Value;
-    set: (key: string, value: Value, options?: SetCookieParams) => void;
-    remove: (key: string, options?: RemoveCookieParams) => void;
-    getAll: () => {
-        [k: string]: any;
-    };
+    set: <Key extends keyof Value>(key: Key, value: Value[Key], options?: SetCookieParams) => void;
+    remove: <Key extends keyof Value>(key: Key, options?: RemoveCookieParams) => void;
+    getAll: () => any;
     clear: () => void;
 };

package/dist/types/hooks/useShare/useShare.d.ts

@@ -14,7 +14,7 @@ export interface UseShareReturn {
     /** Whether the Web Share API is supported in the current environment */
     supported: boolean;
     /** Function to trigger the native share dialog */
-    share: (shareParams: ShareData) => Promise<void>;
+    trigger: (shareParams: ShareData) => Promise<void>;
 }
 /**
  * @name useShare
@@ -30,6 +30,6 @@ export interface UseShareReturn {
  * const { share, supported } = useShare();
  */
 export declare const useShare: (params?: UseShareParams) => {
-    share: (shareParams: ShareData) => Promise<void>;
+    trigger: (shareParams: ShareData) => Promise<void>;
     supported: boolean;
 };

package/dist/types/hooks/useUrlSearchParam/useUrlSearchParam.d.ts

@@ -0,0 +1,70 @@
+/** The url search params mode type */
+export type UrlSearchParamMode = 'hash-params' | 'hash' | 'history';
+/** The use url search param options type */
+export interface UseUrlSearchParamOptions<Value> {
+    /** The initial value of the search param */
+    initialValue?: Value;
+    /** The mode to use for writing to the URL */
+    mode?: UrlSearchParamMode;
+    /** The mode to use for writing to the URL */
+    write?: 'push' | 'replace';
+    /** The deserializer function to be invoked */
+    deserializer?: (value: string) => Value;
+    /** The serializer function to be invoked */
+    serializer?: (value: Value) => string;
+}
+/** The use url search params set options type */
+export interface UseUrlSearchParamsActionOptions {
+    /** The mode to use for writing to the URL */
+    write?: 'push' | 'replace';
+}
+/** The use url search param return type */
+export interface UseUrlSearchParamReturn<Value> {
+    /** Current search param value */
+    value: Value | undefined;
+    /** Function to remove the search param */
+    remove: (options?: UseUrlSearchParamsActionOptions) => void;
+    /** Function to update search param */
+    set: (value: Value, options?: UseUrlSearchParamsActionOptions) => void;
+}
+export declare const URL_SEARCH_PARAMS_EVENT = "reactuse-url-search-params-event";
+export declare const getUrlSearchParams: (mode?: UrlSearchParamMode) => URLSearchParams;
+export declare const createQueryString: (searchParams: URLSearchParams, mode: UrlSearchParamMode) => string;
+export declare const dispatchUrlSearchParamsEvent: () => boolean;
+export interface UseUrlSearchParam {
+    <Value>(key: string, options: UseUrlSearchParamOptions<Value> & {
+        initialValue: Value;
+    }): UseUrlSearchParamReturn<Value>;
+    <Value>(key: string, options?: UseUrlSearchParamOptions<Value>): UseUrlSearchParamReturn<Value | undefined>;
+    <Value>(key: string, initialValue: Value): UseUrlSearchParamReturn<Value>;
+    <Value>(key: string): UseUrlSearchParamReturn<Value | undefined>;
+}
+/**
+ * @name useUrlSearchParam
+ * @description - Hook that provides reactive URLSearchParams for a single key
+ * @category Browser
+ *
+ * @overload
+ * @template Value The type of the url param values
+ * @param {string} key The key of the url param
+ * @param {UseUrlSearchParamOptions<Value> & { initialValue: Value }} options The options object with required initialValue
+ * @param {Value} options.initialValue The initial value for the url param
+ * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')
+ * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL
+ * @param {(value: Value) => string} [options.serializer] Custom serializer function to convert value to string
+ * @param {(value: string) => Value} [options.deserializer] Custom deserializer function to convert string to value
+ * @returns {UseUrlSearchParamReturn<Value>} The object with value and function for change value
+ *
+ * @example
+ * const { value, set } = useUrlSearchParam('page', { initialValue: 1 });
+ *
+ * @overload
+ * @template Value The type of the url param values
+ * @param {string} key The key of the url param
+ * @param {Value} [initialValue] The initial value for the url param
+ * @returns {UseUrlSearchParamReturn<Value>} The object with value and function for change value
+ *
+ * @example
+ * const { value, set } = useUrlSearchParam('page', 1);
+ */
+export declare const useUrlSearchParam: UseUrlSearchParam;

package/dist/types/hooks/useUrlSearchParams/useUrlSearchParams.d.ts

@@ -1,8 +1,4 @@
-export declare const getUrlSearchParams: (mode?: UrlSearchParamsMode) => URLSearchParams;
-export declare const createQueryString: (searchParams: URLSearchParams, mode: UrlSearchParamsMode) => string;
-export declare const URL_SEARCH_PARAMS_EVENT = "reactuse-url-search-params-event";
-export declare const dispatchUrlSearchParamsEvent: () => boolean;
-export declare const setUrlSearchParams: <Params extends UrlParams>(mode: UrlSearchParamsMode, params: Partial<Params>, write?: "push" | "replace") => URLSearchParams;
+import { createQueryString, dispatchUrlSearchParamsEvent, getUrlSearchParams } from '../useUrlSearchParam/useUrlSearchParam';
 /** The url params type */
 export type UrlParams = Record<string, any>;
 /** The url search params mod */
@@ -12,17 +8,31 @@ export interface UseUrlSearchParamsSetOptions {
     /** The mode to use for writing to the URL */
     write?: 'push' | 'replace';
 }
+export type UseUrlSearchParamsInitialValue<Value> = (() => Value) | Value;
 /** The use url search params options type */
-export interface UseUrlSearchParamsOptions {
+export interface UseUrlSearchParamsOptions<Value> {
+    initialValue?: UseUrlSearchParamsInitialValue<string | URLSearchParams | Value>;
     /** The mode to use for writing to the URL */
     mode?: UrlSearchParamsMode;
     /** The mode to use for writing to the URL  */
     write?: 'push' | 'replace';
+    deserializer?: (value: string) => Value[keyof Value];
+    serializer?: (value: Value[keyof Value]) => string;
 }
 /** The use url search params return type */
-export interface UseUrlSearchParamsReturn<Params extends UrlParams> {
-    value: Params;
-    set: (params: Partial<Params>) => void;
+export interface UseUrlSearchParamsReturn<Value> {
+    /** The value of the url search params */
+    value: Value;
+    /** The set function */
+    set: (value: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => void;
+}
+export interface UseUrlSearchParams {
+    <Value>(key: string, options: UseUrlSearchParamsOptions<Value> & {
+        initialValue: UseUrlSearchParamsInitialValue<Value>;
+    }): UseUrlSearchParamsReturn<Value>;
+    <Value>(options?: UseUrlSearchParamsOptions<Value>): UseUrlSearchParamsReturn<Value | undefined>;
+    <Value>(initialValue: UseUrlSearchParamsInitialValue<Value>): UseUrlSearchParamsReturn<Value>;
+    <Value>(key: string): UseUrlSearchParamsReturn<Value | undefined>;
 }
 /**
  * @name useUrlSearchParams
@@ -31,11 +41,24 @@ export interface UseUrlSearchParamsReturn<Params extends UrlParams> {
  *
  * @overload
  * @template Value The type of the url param values
- * @param {UrlSearchParamsMode} mode The URL mode
- * @param {UseUrlSearchParamsOptions<Value>} [options] The URL mode
+ * @param {UseUrlSearchParamsOptions<Value> & { initialValue: UseUrlSearchParamsInitialValue<Value> }} options The options object with required initialValue
+ * @param {UseUrlSearchParamsInitialValue<Value>} [options.initialValue] The initial value for the url params
+ * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')
+ * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL
+ * @param {(value: Value[keyof Value]) => string} [options.serializer] Custom serializer function to convert value to string
+ * @param {(value: string) => Value[keyof Value]} [options.deserializer] Custom deserializer function to convert string to value
+ * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value
+ *
+ * @example
+ * const { value, set } = useUrlSearchParams({ initialValue: { page: 1 } });
+ *
+ * @overload
+ * @template Value The type of the url param values
+ * @param {UseUrlSearchParamsInitialValue<Value>} [initialValue] The initial value for the url params
  * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value
  *
  * @example
- * const { value, set } = useUrlSearchParams('history');
+ * const { value, set } = useUrlSearchParams({ page: 1 });
  */
-export declare const useUrlSearchParams: <Params extends UrlParams, SearchParams extends string | UrlParams | URLSearchParams = UrlParams>(initialValue?: SearchParams, options?: UseUrlSearchParamsOptions) => UseUrlSearchParamsReturn<Params>;
+export declare const useUrlSearchParams: UseUrlSearchParams;
+export { createQueryString, dispatchUrlSearchParamsEvent, getUrlSearchParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",