redact-phi - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

package.json

 {
   "name": "redact-phi",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Assists in the redaction of PHI in structured or semi-structured data, supporting excel (XSLX), CSV or JSON.",
@@ -15,2 +15,3 @@ "main": "main.js",
     "redact",
+    "fake",
     "csv",
@@ -17,0 +18,0 @@ "phi",

README.md

 ![Build Status](https://gitlab.com/dbash-public/redact-phi/badges/main/pipeline.svg)
+![tracker](https://pastepixel.com/image/Vy6gnHSabtYh96HeFBsQ.png)
 # redact-PHI
@@ -74,6 +75,6 @@
 - `redactWith` - (string) The strategy used to redact a value, there are four options:
-  - faker function - e.g. `name.firstName` or `internet.email`
-  - faker template - e.g. `{{address.streetAddress(true)}}`
-  - custom JavaScript - If you require a more complicated redacted value you can call a JavaScript function you've defined in your `.js` file (see `example.js`)
-  - constant value - You can simply enter a string, if you wish to replace every value in this column with a constant, e.g. `John Doe`
+  - faker function - [Available functions](https://rawgit.com/Marak/faker.js/master/examples/browser/index.html) : `name.firstName` or `internet.email`
+  - faker template - Faker methods in a [mustache](https://mustache.github.io/) template : `{{address.streetAddress(true)}}` or `{{address.city}}, {{address.state}} {{address.zip}}`
+  - custom JavaScript - For more complicated redacted values you can call a JavaScript function defined in your `.js` file (see `example.js`)
+  - constant value - If you wish to replace every value in this column with a constant, e.g. `John Doe`
 
@@ -80,0 +81,0 @@ - `tracked` - Tracking preserves the relationships within your data while de-identifying.  With tracking enabled, the redaction engine tracks a column's original value and reuses the redacted value if the original is re-encountered.  To see this in-action, run `redact /example/example.csv` and note how columns with tracking enabled (`id`,`ssn`,`email`) are redacted with the same value in `example_redacted.csv`.

No alert changes

Improved metrics

Total package byte prevSize

17929

increased by1.35%

Number of lines in readme file

98

increased by1.03%

No dependency changes