@shlinkio/shlink-frontend-kit 0.5.0 → 0.5.2

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-import type { CardProps } from 'reactstrap';
-import type { ChangeEvent } from 'react';
-import type { DropdownToggleProps } from 'reactstrap/types/lib/DropdownToggle';
-import type { FC } from 'react';
-import type { InputType } from 'reactstrap/types/lib/Input';
+import { CardProps } from 'reactstrap';
+import { ChangeEvent } from 'react';
+import { DropdownToggleProps } from 'reactstrap/types/lib/DropdownToggle';
+import { FC } from 'react';
+import { InputType } from 'reactstrap/types/lib/Input';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { MutableRefObject } from 'react';
-import type { PropsWithChildren } from 'react';
-import type { ReactNode } from 'react';
+import { PropsWithChildren } from 'react';
+import { ReactNode } from 'react';
 
 declare type BooleanControlProps = PropsWithChildren<{
     checked?: boolean;
@@ -118,8 +118,15 @@ export declare type OrderingDropdownProps<T extends string = string> = {
 
 export declare const orderToString: <T>(order: Order<T>) => string | undefined;
 
+/** @deprecated Use parseQueryString instead */
 export declare const parseQuery: <T>(search: string) => T;
 
+/**
+ * Parses provided query string into an object.
+ * Parameters ending with "[]" will be considered arrays and returned as a single prop with all values.
+ */
+export declare const parseQueryString: <T>(search: string) => T;
+
 export declare const PRIMARY_DARK_COLOR = "#161b22";
 
 export declare const PRIMARY_LIGHT_COLOR = "white";
@@ -156,7 +163,16 @@ export declare type SimpleCardProps = Omit<CardProps, 'title'> & {
 
 export declare const sortList: <List>(list: List[], { field, dir }: Order<keyof List>) => List[];
 
-export declare const stringifyQuery: (query: any) => string;
+/** @deprecated Use stringifyQueryParams instead */
+export declare const stringifyQuery: (params: Record<string, unknown | unknown[] | undefined>) => string;
+
+/**
+ * Stringify an object of query parameters.
+ * Keys explicitly defined with undefined value will be skipped.
+ * Arrays will be appended multiple times with the "[]" suffix in the param name.
+ * All values are cast to string.
+ */
+export declare const stringifyQueryParams: (params: Record<string, unknown | unknown[] | undefined>) => string;
 
 export declare const stringToOrder: <T>(order: string) => Order<T>;
 
@@ -176,7 +192,7 @@ export declare const useOrder: <T>(initialOrder: Order<T>) => [Order<T>, (orderF
 
 export declare const useParsedQuery: <T>() => T;
 
-export declare const useTimeoutToggle: (initialValue?: boolean, delay?: number, setTimeout?: ((handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]) => number) & typeof globalThis.setTimeout, clearTimeout?: ((id: number | undefined) => void) & typeof globalThis.clearTimeout) => [boolean, () => void];
+export declare const useTimeoutToggle: (initialValue?: boolean, delay?: number, setTimeout?: ((handler: TimerHandler, timeout?: number, ...arguments: any[]) => number) & typeof globalThis.setTimeout, clearTimeout?: ((id: number | undefined) => void) & typeof globalThis.clearTimeout) => [boolean, () => void];
 
 export declare const useToggle: (initialValue?: boolean) => ToggleResult;