@ouroboros/browser 0.1.0 → 0.1.1

package/index.d.ts

@@ -2,3 +2,4 @@ export { default as clipboard } from './clipboard';
 export { default as cookies } from './cookies';
 export { default as hash } from './hash';
 export { default as pageVisibility } from './pageVisibility';
+export { default as safeLocalStorage } from './safeLocalStorage';

package/index.js

@@ -2,3 +2,4 @@ export { default as clipboard } from './clipboard';
 export { default as cookies } from './cookies';
 export { default as hash } from './hash';
 export { default as pageVisibility } from './pageVisibility';
+export { default as safeLocalStorage } from './safeLocalStorage';

package/index.ts

@@ -2,3 +2,4 @@ export { default as clipboard } from './clipboard';
 export { default as cookies } from './cookies';
 export { default as hash } from './hash';
 export { default as pageVisibility } from './pageVisibility';
+export { default as safeLocalStorage } from './safeLocalStorage';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ouroboros/browser",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"description": "Package to handle common browser functionality.",
 	"main": "index.js",
 	"types": "index.d.ts",
@@ -19,6 +19,7 @@
 		"clipboard",
 		"cookies",
 		"hash",
+		"local storage",
 		"page visibility"
 	],
 	"author": "Chris Nasr <chris@ouroboroscoding.com>",

package/safeLocalStorage.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Safe Local Storage
+ *
+ * Handles safely fetching values from localeStorage regardless if they exist
+ * or not
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-01-17
+ */
+/**
+ * Bool
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found. Assumes data is a boolean value
+ *
+ * @name bool
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {boolean}
+ */
+export declare function bool(name: string, defaultReturn?: boolean): boolean;
+/**
+ * json
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found. Assumes data is stored in JSON
+ *
+ * @name json
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {any}
+ */
+export declare function json(name: string, defaultReturn: any): any;
+/**
+ * String
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found
+ *
+ * @name string
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {string}
+ */
+export declare function string(name: string, defaultReturn: string): string;
+declare const safeLocaleStorage: {
+    bool: typeof bool;
+    json: typeof json;
+    string: typeof string;
+};
+export default safeLocaleStorage;

package/safeLocalStorage.js

@@ -0,0 +1,61 @@
+/**
+ * Safe Local Storage
+ *
+ * Handles safely fetching values from localeStorage regardless if they exist
+ * or not
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-01-17
+ */
+/**
+ * Bool
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found. Assumes data is a boolean value
+ *
+ * @name bool
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {boolean}
+ */
+export function bool(name, defaultReturn = false) {
+    const value = localStorage.getItem(name);
+    return value === null ? defaultReturn : (value === '' ? false : true);
+}
+/**
+ * json
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found. Assumes data is stored in JSON
+ *
+ * @name json
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {any}
+ */
+export function json(name, defaultReturn) {
+    const value = localStorage.getItem(name);
+    return value === null ? defaultReturn : JSON.parse(value);
+}
+/**
+ * String
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found
+ *
+ * @name string
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {string}
+ */
+export function string(name, defaultReturn) {
+    const value = localStorage.getItem(name);
+    return value === null ? defaultReturn : value;
+}
+// Default export
+const safeLocaleStorage = { bool, json, string };
+export default safeLocaleStorage;

package/safeLocalStorage.ts

@@ -0,0 +1,67 @@
+/**
+ * Safe Local Storage
+ *
+ * Handles safely fetching values from localeStorage regardless if they exist
+ * or not
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-01-17
+ */
+
+/**
+ * Bool
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found. Assumes data is a boolean value
+ *
+ * @name bool
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {boolean}
+ */
+export function bool(name: string, defaultReturn=false): boolean {
+	const value = localStorage.getItem(name);
+	return value === null ? defaultReturn : (
+		value === '' ? false : true
+	)
+}
+
+/**
+ * json
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found. Assumes data is stored in JSON
+ *
+ * @name json
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {any}
+ */
+export function json(name: string, defaultReturn: any): any {
+	const value = localStorage.getItem(name);
+	return value === null ? defaultReturn : JSON.parse(value);
+}
+
+/**
+ * String
+ *
+ * Fetches a value from local storage or returns the default if no value is
+ * found
+ *
+ * @name string
+ * @access public
+ * @param {string} name The name of the local var to fetch
+ * @param {string} defaultReturn The value to return if the var is not found
+ * @return {string}
+ */
+export function string(name: string, defaultReturn: string): string {
+	const value = localStorage.getItem(name);
+	return value === null ? defaultReturn : value;
+}
+
+// Default export
+const safeLocaleStorage = { bool, json, string };
+export default safeLocaleStorage;