safe-flat - npm Package Compare versions

Comparing version 2.0.3 to 2.1.0

CHANGELOG.md

@@ -0,1 +1,9 @@
+# [2.1.0](https://github.com/jessie-codes/safe-flat/compare/2.0.3...2.1.0) (2023-11-30)
+
+### Features
+
+* Adds type definitions to both flatten and unflatten fns. ([4618622](https://github.com/jessie-codes/safe-flat/commit/46186224042b0f7a0dfb8dac37c7dd568bbab632)), closes [#50](https://github.com/jessie-codes/safe-flat/issues/50)
+
+
+
 ## [2.0.3](https://github.com/jessie-codes/safe-flat/compare/2.0.2...2.0.3) (2023-11-30)
@@ -2,0 +10,0 @@

package.json

 {
   "name": "safe-flat",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "Safely flatten a nested JavaScript object.",
@@ -52,3 +52,4 @@ "main": "src/index.js",
     }
-  }
+  },
+  "types": "types/index.d.ts"
 }

README.md

@@ -22,3 +22,3 @@ # safe-flat
 
-Flats an object to one level deep. Optionally takes a custom `delimiter`, otherwise uses `.` by default. Circular references within the object will be replaced with `[Circular]`.
+Flattens an object to one level deep. Optionally takes a custom `delimiter`, otherwise uses `.` by default. Circular references within the object will be replaced with `[Circular]`.
 
@@ -70,3 +70,3 @@ ``` javascript
 
-Unflats an object back to its original nested form. Optionally takes a custom `delimiter`, otherwise uses `.` by default. Circular references denoted by `[Circular]` are treated as Strings.
+Unflattens an object back to its original nested form. Optionally takes a custom `delimiter`, otherwise uses `.` by default. Circular references denoted by `[Circular]` are treated as Strings.
 
@@ -73,0 +73,0 @@ ``` javascript

No alert changes

Improved metrics

Total package byte prevSize

25510

increased by5.26%

Number of package files

16

increased by6.67%

Lines of code

372

increased by5.38%

No dependency changes