@jmondi/browser-storage - npm Package Compare versions

Comparing version 1.8.0-alpha.2 to 1.8.0

esm/index.d.ts

@@ -5,6 +5,2 @@ export type Serializer = {
 };
-/**
- * @deprecated use Serializer instead
- */
-export type StorageSerializer = Serializer;
 export type Adapter<SetConfig = unknown> = {
@@ -94,1 +90,5 @@ clear?(): void;
 }
+/**
+ * @deprecated use Serializer instead
+ */
+export type StorageSerializer = Serializer;

package.json

@@ -5,3 +5,3 @@ {
   "name": "@jmondi/browser-storage",
-  "version": "1.8.0-alpha.2",
+  "version": "1.8.0",
   "description": "Utilities for local and session browser storage.",
@@ -8,0 +8,0 @@ "keywords": [

README.md

@@ -11,3 +11,3 @@ # @jmondi/browser-storage
 ![npm bundle size](https://img.shields.io/bundlephobia/min/%40jmondi%2Fbrowser-storage)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40jmondi%2Fbrowser-storage)
+![npm gzip bundle size](https://img.shields.io/bundlephobia/minzip/%40jmondi%2Fbrowser-storage)
 
@@ -30,5 +30,5 @@
 
-### LocalStorage 
+### The LocalStorage class 
 
-Persists after closing browser:
+Persists after closing browser
 
@@ -39,9 +39,10 @@ ```typescript
 const storage = new LocalStorage();
-storage.set("user2", { email: "[e-mail]", name: "Hermoine" });
-console.log(storage.get("user2")); // { email: "[e-mail]", name: "Hermoine" }
+storage.set("user2", { email: "[e-mail]" });
+console.log(storage.get("user2")); 
+// { email: "[e-mail]" }
 ```
 
-### SessionStorage 
+### The SessionStorage class 
 
-Resets on browser close:
+Resets on browser close
 
@@ -56,3 +57,3 @@ ```typescript
 
-### Custom storage adapter:
+### Example Custom storage adapter
 
@@ -80,22 +81,2 @@ ```ts
 
-## Defining Storage Groups
-
-- Use `define` for individual keys:
-
-```typescript
-const storage = new BrowserStorage();
-const USER_COOKIE = storage.define<{ email: string }>("user_info");
-USER_COOKIE.set({ email: "[e-mail]" });
-```
-
-- Use `defineGroup` for key groups:
-
-```typescript
-const storage = new BrowserStorage();
-
-const GROUP = storage.defineGroup({ token: "refresh_token", user: "user_info" });
-GROUP.token.set("newtoken");
-GROUP.user.set({ email: "[e-mail]" });
-```
-
 ## Configuration
@@ -128,1 +109,37 @@
 ```
+
+## Advanced Usage / Organization Techniques
+
+With defined storage groups you can organize related data into named groups, simplifying access and management.
+
+### Defining Storage Key
+
+Use `define` for individual keys. In this example, 
+
+```typescript
+type UserInfo = { email: string };
+const storage = new LocalStorage(); // define is available on all BrowserStorage implementations
+
+const USER_INFO = storage.define<UserInfo>("user_info");
+
+USER_INFO.set({ email: "[e-mail]" });
+USER_INFO.get(); // gets the latest value
+USER_INFO.remove(); // removes the value
+```
+
+### Defining Storage Groups
+
+Use `defineGroup` for key groups.
+
+```typescript
+const storage = new LocalStorage(); // defineGroup is available on all BrowserStorage implementations
+
+const GROUP = storage.defineGroup({ token: "refresh_token", user: "user_info" });
+
+GROUP.token.set("newtoken");
+GROUP.token.get();
+GROUP.token.remove();
+GROUP.user.set({ email: "[e-mail]" });
+GROUP.user.get();
+GROUP.user.remove();
+```

script/index.d.ts

@@ -5,6 +5,2 @@ export type Serializer = {
 };
-/**
- * @deprecated use Serializer instead
- */
-export type StorageSerializer = Serializer;
 export type Adapter<SetConfig = unknown> = {
@@ -94,1 +90,5 @@ clear?(): void;
 }
+/**
+ * @deprecated use Serializer instead
+ */
+export type StorageSerializer = Serializer;

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26557

increased by1.91%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

140

increased by13.82%

No dependency changes