@visulima/redact - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -0,1 +1,8 @@
+## @visulima/redact [1.0.1](https://github.com/visulima/visulima/compare/@visulima/redact@1.0.0...@visulima/redact@1.0.1) (2024-05-13)
+
+
+### Bug Fixes
+
+* **redact:** updated the readme with more details ([0b057cf](https://github.com/visulima/visulima/commit/0b057cf17fce339242d70c389e0138a6810a9d16))
+
 ## @visulima/redact 1.0.0 (2024-05-12)
@@ -2,0 +9,0 @@

dist/index.d.ts

@@ -16,3 +16,3 @@ type StringAnonymize = {
     logger?: {
-        debug: (...arguments_: any[]) => void;
+        debug: (message?: any, ...optionalParameters: any[]) => void;
     };
@@ -19,0 +19,0 @@ };

package.json

 {
     "name": "@visulima/redact",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Detect whether a terminal or browser supports ansi colors.",
@@ -105,2 +105,3 @@ "keywords": [
         "cross-env": "^7.0.3",
+        "dot-prop": "^9.0.0",
         "eslint": "^8.56.0",
@@ -114,6 +115,5 @@ "eslint-plugin-deprecation": "^2.0.0",
         "prettier": "^3.2.5",
-        "rimraf": "^5.0.5",
-        "dot-prop": "^9.0.0",
+        "rimraf": "^5.0.7",
         "secretlint": "8.1.1",
-        "semantic-release": "^23.0.8",
+        "semantic-release": "^23.1.1",
         "sort-package-json": "^2.10.0",
@@ -120,0 +120,0 @@ "tsup": "^8.0.2",

README.md

@@ -155,2 +155,72 @@ <div align="center">
 
+## API
+
+### redact(input, rules, options?)
+
+#### input
+
+Type: `any`
+
+The input value to redact.
+
+#### rules
+
+Type: `(Anonymize | StringAnonymize | number | string)[]`
+
+An array of rules to redact.
+
+#### options
+
+Type: `object`
+
+##### exclude
+
+Type: `(string | number)[]`
+
+Exclude a rule for the rules array.
+
+##### logger
+
+Type: `object`
+
+###### debug
+
+Type: `(message?: any, ...optionalParameters: any[]) => void`
+
+A function to log debug messages.
+
+### stringAnonymize(input, rules, options?)
+
+#### input
+
+Type: `string`
+
+The input value to redact.
+
+#### rules
+
+Type: `(Anonymize | StringAnonymize | number | string)[]`
+
+An array of rules to redact.
+
+#### options
+
+Type: `object`
+
+##### exclude
+
+Type: `(string | number)[]`
+
+Exclude a rule for the rules array.
+
+##### logger
+
+Type: `object`
+
+###### debug
+
+Type: `(message?: any, ...optionalParameters: any[]) => void`
+
+A function to log debug messages.
+
 ## Related
@@ -157,0 +227,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

157959

increased by0.8%

Number of lines in readme file

259

increased by37.04%

No dependency changes