object-grep - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

package.json

 {
   "name": "object-grep",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A javascript tool for searching text in keys and content inspired by linux grep",
@@ -20,7 +20,6 @@ "main": "./dist/index.js",
     "grep",
-    "grep-js",
-    "object-grep",
-    "find-in-object",
-    "search-in-object",
-    "search-by-object"
+    "search in object",
+    "find in object",
+    "javascript",
+    "node.js"
   ],
@@ -27,0 +26,0 @@ "author": "Ruslan Krokhin <[e-mail]>",

README.md

@@ -1,8 +0,22 @@
-# object-grep
-A javascript tool for searching text in keys and content inspired by linux grep
+# [object-grep](https://ulitcos.github.io/object-grep/)
+A javascript tool for searching inside objects inspired by linux grep
 
-## install
-```
+## installation
+
+```bash
 npm i object-grep
 ```
+or
+```bash
+yarn add object-grep
+```
+
+## arguments
+
+**targetObject**: [`object` | `array` | `function` | `string`] - a target object where all keys and property contents will be recursively checked for matching searchExpr
+
+**searchExpr**: [`string` | `regexp`] - expression for checking for compliance
+
+**depth limit**?: [`number`] - the number of levels to check. objectGrep works synchronously, which can cause the browser to freeze if the object being checked is very large. The default value is 100
+
 ## usage
@@ -53,1 +67,5 @@
 
+## chrome extension
+
+You can also install a [browser extension](https://github.com/ulitcos/object-grep-chrome-extension) and use object-grep on any site without any extra effort
+

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

27109

increased by5.15%

Number of lines in readme file

71

increased by33.96%

No dependency changes