UNPKG

@metapages/hash-query

Version:

Get/set URL parameters (state) in the hash string instead of the query string.

54 lines 5.47 kB
export type SetHashParamOpts = { modifyHistory?: boolean; }; export declare const blobToBase64String: (blob: Record<string, any>) => string; export declare const blobFromBase64String: (value: string | undefined) => any; export declare const stringToBase64String: (value: string) => string; export declare const stringFromBase64String: (value: string) => string; export declare const getUrlHashParams: (url: string | URL) => [string, Record<string, string>]; export declare const getUrlHashParamsFromHashString: (hash: string) => [string, Record<string, string>]; export declare const getHashParamValue: (url: string | URL, key: string) => string | undefined; export declare const getHashParamFromWindow: (key: string) => string | undefined; export declare const getHashParamsFromWindow: () => [string, Record<string, string>]; export declare const setHashParamInWindow: (key: string, value: string | undefined, opts?: SetHashParamOpts) => void; export declare const setHashParamValueInHashString: (hash: string, key: string, value: string | undefined) => string; export declare const createHashParamValuesInHashString: (hash: string, params: Record<string, string | undefined>) => string; export declare const setHashParamValueInUrl: (url: string | URL, key: string, value: string | undefined) => URL; export declare const setHashParamsInUrl: (url: string | URL, params: Record<string, string | undefined>) => URL; export declare const setHashParamValueJsonInUrl: <T>(url: string | URL, key: string, value: T | undefined) => URL; export declare const getHashParamValueJsonFromUrl: <T>(url: string | URL, key: string) => T | undefined; export declare const getHashParamValueJsonFromHashString: <T>(hash: string, key: string) => T | undefined; export declare const setHashParamValueJsonInWindow: <T>(key: string, value: T | undefined, opts?: SetHashParamOpts) => void; export declare const getHashParamValueJsonFromWindow: <T>(key: string) => T | undefined; export declare const setHashParamValueJsonInHashString: <T>(hash: string, key: string, value: T | undefined) => string; export declare const setHashParamValueFloatInUrl: (url: string | URL, key: string, value: number | undefined) => URL; export declare const getHashParamValueFloatFromUrl: (url: string | URL, key: string) => number | undefined; export declare const setHashParamValueFloatInWindow: (key: string, value: number | undefined, opts?: SetHashParamOpts) => void; export declare const getHashParamValueFloatFromWindow: (key: string) => number | undefined; export declare const setHashParamValueIntInUrl: (url: string | URL, key: string, value: number | undefined) => URL; export declare const getHashParamValueIntFromUrl: (url: string | URL, key: string) => number | undefined; export declare const setHashParamValueIntInWindow: (key: string, value: number | undefined, opts?: SetHashParamOpts) => void; export declare const getHashParamValueIntFromWindow: (key: string) => number | undefined; export declare const setHashParamValueBooleanInUrl: (url: string | URL, key: string, value: boolean | undefined) => URL; export declare const getHashParamValueBooleanFromUrl: (url: string | URL, key: string) => boolean | undefined; export declare const setHashParamValueBooleanInWindow: (key: string, value: boolean | undefined, opts?: SetHashParamOpts) => void; export declare const getHashParamValueBooleanFromWindow: (key: string) => boolean | undefined; export declare const setHashParamValueBase64EncodedInUrl: (url: string | URL, key: string, value: string | undefined) => URL; export declare const getHashParamValueBase64DecodedFromUrl: (url: string | URL, key: string) => string | undefined; export declare const setHashParamValueBase64EncodedInWindow: (key: string, value: string | undefined, opts?: SetHashParamOpts) => void; export declare const getHashParamValueBase64DecodedFromWindow: (key: string) => string | undefined; export declare const setHashParamValueUriEncodedInUrl: (url: string | URL, key: string, value: string | undefined) => URL; export declare const getHashParamValueUriDecodedFromUrl: (url: string | URL, key: string) => string | undefined; export declare const setHashParamValueUriEncodedInWindow: (key: string, value: string | undefined, opts?: SetHashParamOpts) => void; export declare const getHashParamValueUriDecodedFromWindow: (key: string) => string | undefined; type HashParamValueListener<T> = (value: T | undefined) => void; export declare const addEventListenerHashParamBase64: (key: string, onHashParamChange: HashParamValueListener<string>) => (() => void); export declare const addEventListenerHashParamBoolean: (key: string, onHashParamChange: HashParamValueListener<boolean>) => (() => void); export declare const addEventListenerHashParamFloat: (key: string, onHashParamChange: HashParamValueListener<number>) => (() => void); export declare const addEventListenerHashParamInt: (key: string, onHashParamChange: HashParamValueListener<number>) => (() => void); export declare const addEventListenerHashParamJson: <T>(key: string, onHashParamChange: HashParamValueListener<T>) => (() => void); export declare const addEventListenerHashParamUriEncoded: (key: string, onHashParamChange: HashParamValueListener<string>) => (() => void); export declare const deleteHashParamFromWindow: (key: string, opts?: SetHashParamOpts) => void; export declare const deleteHashParamFromUrl: (url: string | URL, key: string) => URL; export {}; //# sourceMappingURL=index.d.ts.map