@excentone/spfx-react
Version:
Contains custom ReactJs components and hooks intended to use when developing SharePoint Framework (SPFx) Web components.
8 lines (7 loc) • 502 B
TypeScript
import { QueryObject, IQueryParamsHookOptions } from "./useQueryParams.types";
/**
* `useQueryParams` provides a common interface for transforming query parameter values from string to a specific type.
* @param options The options to be passed to the custom hook.
* @returns An object containing the query parameter keys with the transformed values.
*/
export declare const useQueryParams: <TParams extends QueryObject>(options: IQueryParamsHookOptions<TParams & QueryObject>) => Partial<TParams>;