mazey 5.6.3 → 5.6.5

package/lib/index.d.ts

@@ -3024,29 +3024,17 @@ declare function removeEvent(type: string, fn?: MazeyFn): void;
  * Usage:
  *
  * ```javascript
- * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
+ * import { setSessionJSON, getSessionJSON } from "mazey";
  *
- * setSessionStorage("test", "123");
- * const ret1 = getSessionStorage("test");
- * setLocalStorage("test", "123");
- * const ret2 = getLocalStorage("test");
- * console.log(ret1, ret2);
- *
- * // Wrap the helpers with a project-specific key prefix.
- * const projectName = "mazey";
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
- *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
+ * setSessionJSON("preferences", { theme: "dark" });
+ * const preferences = getSessionJSON("preferences");
+ * console.log(JSON.stringify(preferences));
  * ```
  *
  * Output:
  *
  * ```text
- * 123 123
+ * {"theme":"dark"}
  * ```
  *
  * @param {string} key Storage key.
@@ -3054,72 +3042,48 @@ declare function removeEvent(type: string, fn?: MazeyFn): void;
  * @returns {void} This function does not return a value.
  * @category Store
  */
-declare function setSessionStorage<T>(key: string, value?: T | null): void;
+declare function setSessionJSON<T>(key: string, value?: T | null): void;
 /**
  * Read a value from `sessionStorage`, parsing JSON when possible.
  *
  * Usage:
  *
  * ```javascript
- * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
- *
- * setSessionStorage("test", "123");
- * const ret1 = getSessionStorage("test");
- * setLocalStorage("test", "123");
- * const ret2 = getLocalStorage("test");
- * console.log(ret1, ret2);
- *
- * // Wrap the helpers with a project-specific key prefix.
- * const projectName = "mazey";
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
+ * import { setSessionJSON, getSessionJSON } from "mazey";
  *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
+ * setSessionJSON("preferences", { theme: "dark" });
+ * const preferences = getSessionJSON("preferences");
+ * console.log(JSON.stringify(preferences));
  * ```
  *
  * Output:
  *
  * ```text
- * 123 123
+ * {"theme":"dark"}
  * ```
  *
  * @param {string} key Storage key.
  * @returns The parsed value, raw stored value, or `null` when no value exists.
  * @category Store
  */
-declare function getSessionStorage<T>(key: string): T | null;
+declare function getSessionJSON<T>(key: string): T | null;
 /**
  * Serialize a value as JSON and store it in `localStorage`.
  *
  * Usage:
  *
  * ```javascript
- * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
- *
- * setSessionStorage("test", "123");
- * const ret1 = getSessionStorage("test");
- * setLocalStorage("test", "123");
- * const ret2 = getLocalStorage("test");
- * console.log(ret1, ret2);
- *
- * // Wrap the helpers with a project-specific key prefix.
- * const projectName = "mazey";
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
+ * import { setLocalJSON, getLocalJSON } from "mazey";
  *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
+ * setLocalJSON("preferences", { theme: "dark" });
+ * const preferences = getLocalJSON("preferences");
+ * console.log(JSON.stringify(preferences));
  * ```
  *
  * Output:
  *
  * ```text
- * 123 123
+ * {"theme":"dark"}
  * ```
  *
  * @param {string} key Storage key.
@@ -3127,43 +3091,59 @@ declare function getSessionStorage<T>(key: string): T | null;
  * @returns {void} This function does not return a value.
  * @category Store
  */
-declare function setLocalStorage<T>(key: string, value?: T | null): void;
+declare function setLocalJSON<T>(key: string, value?: T | null): void;
 /**
  * Read a value from `localStorage`, parsing JSON when possible.
  *
  * Usage:
  *
  * ```javascript
- * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
- *
- * setSessionStorage("test", "123");
- * const ret1 = getSessionStorage("test");
- * setLocalStorage("test", "123");
- * const ret2 = getLocalStorage("test");
- * console.log(ret1, ret2);
- *
- * // Wrap the helpers with a project-specific key prefix.
- * const projectName = "mazey";
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
+ * import { setLocalJSON, getLocalJSON } from "mazey";
  *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
+ * setLocalJSON("preferences", { theme: "dark" });
+ * const preferences = getLocalJSON("preferences");
+ * console.log(JSON.stringify(preferences));
  * ```
  *
  * Output:
  *
  * ```text
- * 123 123
+ * {"theme":"dark"}
  * ```
  *
  * @param {string} key Storage key.
  * @returns The parsed value, raw stored value, or `null` when no value exists.
  * @category Store
  */
-declare function getLocalStorage<T>(key: string): T | null;
+declare function getLocalJSON<T>(key: string): T | null;
+/**
+ * Deprecated alias of {@link setSessionJSON}.
+ *
+ * @deprecated Use `setSessionJSON` instead.
+ * @category Store
+ */
+declare const setSessionStorage: typeof setSessionJSON;
+/**
+ * Deprecated alias of {@link getSessionJSON}.
+ *
+ * @deprecated Use `getSessionJSON` instead.
+ * @category Store
+ */
+declare const getSessionStorage: typeof getSessionJSON;
+/**
+ * Deprecated alias of {@link setLocalJSON}.
+ *
+ * @deprecated Use `setLocalJSON` instead.
+ * @category Store
+ */
+declare const setLocalStorage: typeof setLocalJSON;
+/**
+ * Deprecated alias of {@link getLocalJSON}.
+ *
+ * @deprecated Use `getLocalJSON` instead.
+ * @category Store
+ */
+declare const getLocalStorage: typeof getLocalJSON;
 /**
  * Get a cookie value by name.
  *
@@ -4247,5 +4227,5 @@ declare const mazeyCon: Console;
  */
 declare const timeCon: Console;
 
-export { addClass, addEvent, addStyle, assignDefined, calLongestCommonSubsequence, calLongestCommonSubstring, calculateCAGR, camelCase2Underscore, camelCaseToKebabCase, cancelBubble, clearHTML, clearHtml, convert10To26, convertCamelToKebab, convertCamelToUnder, convertHttpToHttps, convertKebabToCamel, convertObjectToQuery, convertToHtmlBreaks, convertUnderToCamel, cutCHSString, cutZHString, debounce, deepCopy, deepCopyObject, deepFreeze, delCookie, derivePackageMetadata, detectVisitorType, doFn, extractElementText, fireEvent, floatFixed, floatToPercent, formatByteSize, formatDate, formatDistanceToNow, formatDurationFromMs, formatLocalDateTime, genBrowserAttrs, genCustomConsole, genHashCode, genRndNumString, genStyleString, genUniqueNumString, generateCalendarVersion, generateRndNum, generateUniqueNum, getAllQueryParams, getBrowserInfo, getCLS, getCookie, getCurrentVersion, getDateDifference, getDefineListeners, getDomain, getFCP, getFID, getFP, getFileSize, getFriendlyInterval, getHashQueryParam, getLCP, getLocalStorage, getPageMeta, getPerformance, getQueryParam, getScriptQueryParam, getSessionStorage, getSystemTheme, getTTFB, getUrlFileType, getUrlHost, getUrlParam, getUrlPath, hasClass, inRate, invokeEvent, invokeFn, isArray, isBool, isBoolean, isBrowser, isFunction, isHit, isJSONString, isJsonString, isNonEmptyArray, isNonEmptyObject, isNumber, isPureObject, isSafePWAEnv, isStandalonePWA, isString, isSupportWebp, isSupportedEntryType, isThisHour, isThisMonth, isThisWeek, isThisYear, isToday, isUdfOrNul, isValidCssSelector, isValidData, isValidDate, isValidEmail, isValidHttpUrl, isValidPhoneNumber, isValidUrl, listenMediaQueryChanges, loadCSS, loadImage, loadScript, loadScriptIfUndefined, longestComSubsequence, longestComSubstring, mNow, mTrim, mazeyCon, newLine, onURLChange, parseGitHubRepository, parseJsonSafe, parseLocalDateTime, removeClass, removeCookie, removeEvent, removeHTML, removeHtml, repeatUntilConditionMet, replaceHttp, resolveElementTarget, resolveLanguagePreference, resolveThemePreference, sanitizeInput, setClass, setCookie, setImgSizeBySrc, setImgWidHeiBySrc, setLanguagePreference, setLocalStorage, setSessionStorage, setThemePreference, sha256Hex, sleep, subYears, throttle, timeCon, toJavaScriptGlobalName, truncateZHString, unsanitize, unsanitizeInput, updateQueryParam, waitTime, watchServiceWorkerUpdates, windowLoaded, zAxiosIsValidRes };
+export { addClass, addEvent, addStyle, assignDefined, calLongestCommonSubsequence, calLongestCommonSubstring, calculateCAGR, camelCase2Underscore, camelCaseToKebabCase, cancelBubble, clearHTML, clearHtml, convert10To26, convertCamelToKebab, convertCamelToUnder, convertHttpToHttps, convertKebabToCamel, convertObjectToQuery, convertToHtmlBreaks, convertUnderToCamel, cutCHSString, cutZHString, debounce, deepCopy, deepCopyObject, deepFreeze, delCookie, derivePackageMetadata, detectVisitorType, doFn, extractElementText, fireEvent, floatFixed, floatToPercent, formatByteSize, formatDate, formatDistanceToNow, formatDurationFromMs, formatLocalDateTime, genBrowserAttrs, genCustomConsole, genHashCode, genRndNumString, genStyleString, genUniqueNumString, generateCalendarVersion, generateRndNum, generateUniqueNum, getAllQueryParams, getBrowserInfo, getCLS, getCookie, getCurrentVersion, getDateDifference, getDefineListeners, getDomain, getFCP, getFID, getFP, getFileSize, getFriendlyInterval, getHashQueryParam, getLCP, getLocalJSON, getLocalStorage, getPageMeta, getPerformance, getQueryParam, getScriptQueryParam, getSessionJSON, getSessionStorage, getSystemTheme, getTTFB, getUrlFileType, getUrlHost, getUrlParam, getUrlPath, hasClass, inRate, invokeEvent, invokeFn, isArray, isBool, isBoolean, isBrowser, isFunction, isHit, isJSONString, isJsonString, isNonEmptyArray, isNonEmptyObject, isNumber, isPureObject, isSafePWAEnv, isStandalonePWA, isString, isSupportWebp, isSupportedEntryType, isThisHour, isThisMonth, isThisWeek, isThisYear, isToday, isUdfOrNul, isValidCssSelector, isValidData, isValidDate, isValidEmail, isValidHttpUrl, isValidPhoneNumber, isValidUrl, listenMediaQueryChanges, loadCSS, loadImage, loadScript, loadScriptIfUndefined, longestComSubsequence, longestComSubstring, mNow, mTrim, mazeyCon, newLine, onURLChange, parseGitHubRepository, parseJsonSafe, parseLocalDateTime, removeClass, removeCookie, removeEvent, removeHTML, removeHtml, repeatUntilConditionMet, replaceHttp, resolveElementTarget, resolveLanguagePreference, resolveThemePreference, sanitizeInput, setClass, setCookie, setImgSizeBySrc, setImgWidHeiBySrc, setLanguagePreference, setLocalJSON, setLocalStorage, setSessionJSON, setSessionStorage, setThemePreference, sha256Hex, sleep, subYears, throttle, timeCon, toJavaScriptGlobalName, truncateZHString, unsanitize, unsanitizeInput, updateQueryParam, waitTime, watchServiceWorkerUpdates, windowLoaded, zAxiosIsValidRes };
 export type { DerivePackageMetadataOptions, DerivedPackageMetadata, FormatByteSizeOptions, GitHubRepositoryDetails, InvestmentReturnRate, IsSafePWAEnvOptions, LocalDateTimePrecision, PackageManager, PackageManifest, PackageManifestAuthor, PreferenceResult, ResolveElementTargetOptions, ResolvedTheme, ServiceWorkerUpdateCallbacks, ServiceWorkerUpdateWatcher, ThemePreference, VisitorType };