postal-mime - npm Package Compare versions

Comparing version 2.2.4 to 2.2.5

CHANGELOG.md

 # Changelog
 
+## [2.2.5](https://github.com/postalsys/postal-mime/compare/v2.2.4...v2.2.5) (2024-04-11)
+
+
+### Bug Fixes
+
+* **types:** Fixed Address type ([57908e4](https://github.com/postalsys/postal-mime/commit/57908e428929904ee312d9e95343a9fbf52542b4))
+
 ## [2.2.4](https://github.com/postalsys/postal-mime/compare/v2.2.3...v2.2.4) (2024-04-11)
@@ -4,0 +11,0 @@

package.json

 {
     "name": "postal-mime",
-    "version": "2.2.4",
+    "version": "2.2.5",
     "description": "Email parser for browser environments",
@@ -5,0 +5,0 @@ "main": "./src/postal-mime.js",

postal-mime.d.ts

@@ -6,4 +6,5 @@ export type RawEmail = string | ArrayBuffer | Uint8Array | Blob | Buffer | ReadableStream;
 export type Address = {
-	address: string;
 	name: string;
+    address?: string;
+    group?: Address[]
 };
@@ -10,0 +11,0 @@

README.md

@@ -140,3 +140,3 @@ # postal-mime
 -   **opts** is an optional options object
-    -   **flattem** is a boolean value. If set to `true`, then ignores address groups and returns a flat array of addresses. By default (`flatten` is `false`) the result might include nested groups
+    -   **flatten** is a boolean value. If set to `true`, then ignores address groups and returns a flat array of addresses. By default (`flatten` is `false`) the result might include nested groups
 
@@ -147,2 +147,3 @@ The result is an array of objects
 -   **address** is the email address value
+-   **group** is an array of nested address objects. This is used when `flatten` is `false` (the default) and the address string contains address group syntax
 
@@ -149,0 +150,0 @@ ```js

No alert changes

Improved metrics

Total package byte prevSize

134053

increased by0.32%

Lines of code

3863

increased by0.03%

Number of lines in readme file

183

increased by0.55%

No dependency changes