mitsuketa - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

package.json

 {
   "name": "mitsuketa",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A Javascript library that enables you to handle deeply nested objects easily.",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "start": "index.js"
   },
@@ -26,3 +26,6 @@ "repository": {
   },
-  "homepage": "https://github.com/AndrewRedican/mitsuketa#readme"
+  "homepage": "https://github.com/AndrewRedican/mitsuketa#readme",
+  "dependencies": {
+    "validate": "^3.0.1"
+  }
 }

readme.md

@@ -1,2 +0,2 @@
-# Mitsuketa
+# Mitsuketa ![Build Status](https://travis-ci.org/AndrewRedican/mitsuketa.svg?branch=master)
 
@@ -18,32 +18,48 @@ A Javascript library that enables you to handle deeply nested objects easily.
 
-## List of Methods
+## Overview
 
-See documentation on github page.
+| Method   | Description                 | Parameters/Input  | Output  |
+| ------------- |-----------------------------| ------| :-----:|
+| [getType](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#gettype-identity-) | Gets `typeof` `identity` also makes distinction between `object`, `null`, and `array`               | identity | string |
+| [sameType](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#sametype-identitya-identityb-) | Compares two `identities` using `getType` method | identityA, identityB | `identity` or `false` |
+| [sameStructure](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#samestructure-identitya-identityb-) | Compares two `identities` using `sameType` then validates both have the same `keys`  | identityA, identityB | `identity` or `false` |
+| [identical](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#identical-identitya-identityb-) | Compares two `identities` using `sameStructure` then validates children or nested structures for `iterble identities` or actual `values`  | identityA, identityB | `identity` or `false` |
+| [isIterable](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#isiterable-identity-) | Checks if `identity` contains one or more keys or properties       | identity | boolean |
+| [containsKeys](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#containskeys-identity-keylist-)  | Checks if `identity` contains the specified properties | identity, keyList | boolean |
+| [trim](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#trim-identity-keylist-) | Removes properties from `identity` and only keeps the specified properties | identity, keyList | `identity` |
+| [locate](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#locate-collection-identity-) | Performs a deep search by iterating through the `collection`'s entire object tree an returns the path to the first `identical` match that is found as a string of dot . separated property names | collection, identity | string |
+| [deepGet](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#deepget-collection-identity-) | Uses `locate` and returns the `indentity`'s container if found in `collection` |    collection, identity | identity |
+| [locateAll](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#locateall-collection-identity-) | Uses `locate` and returns all the paths to all matches | collection, identity | array of string |
+| [deepFilter](https://github.com/AndrewRedican/mitsuketa/wiki/v1.1.0#deepfilter-collection-identity-) | Users `locateAll` and returns an array of all an identites matched inside `collection`  | collection, identity | array of identities |
+| [length](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#length-identity-) | Returns the number of keys or properties contained in `identity` | identity | number |
+| [exists](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#exists-collection-identity-) | Performs deep search on `collection` for an `identical` match to `identity` | collection, identity | boolean |
+| [onlyExisting](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#onlyexisting-collection-identities-) | For each identity in `identities`, performs a deep search on `collection` using `exists`, to shorten the list `identities` to those that were found | collection, identities | identities |
+| [onlyMissing](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#onlymissing-collection-identities-) | For each identity in `identities`, performs a deep search on `collection` using `exists`, to shorten the list `identities` to those that were **not** found | collection, identities | identities |
+| [isFalsy](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#isfalsy-identity-) | Checks if identity has or false or false-like values. These include: null, undefined, '', false, and 0 | identity | `identity` or `false` |
+| [isTruthy](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#istruthy-identity-) | Checks if identity is non-falsy | identity | `identity` or `false` |
+| [foundTruthy](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#foundtruthy-collection-identity-) | Performs deep search on `collection`, and evaluate if `isTruthy` on the first identical match to `identity` | collection, identity | boolean |
+| [foundFalsy](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#foundfalsy-collection-identity-) | Performs deep search on `collection`, and evaluate if `isFalsy` on the first identical match to `identity` | collection, identity | boolean |
+| [onlyTruthy](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#onlytruthy-collection-identities-property-) | For each identity in `identities`, performs a deep search on `collection` using `exists`, and evaluates if `isTruthy` on the first identical match of `property` to shorten the list `identities` to those that were found and also truthy | collection, identities, property | identities |
+| [onlyFalsy](https://github.com/AndrewRedican/mitsuketa/wiki/v1.2.0#onlyfalsy-collection-identities-property-)  | For each identity in `identities`, performs a deep search on `collection` using `exists`, and evaluates if `isFalsy` on the first identical match of `property` to shorten the list `identities` to those that were found and also truthy | collection, identities, property | identities |
 
 
-### First Release - November 27, 2017
+## Built With
 
-    getType         
-    sameType         
-    sameStructure    
-    identical       
-    isIterable       
-    containsKeys     
-    trim             
-    locate           
-    deepGet          
-    locateAll        
-    deepFilter
+* Vanilla Javascript, ES5, ES6
 
-### Second Release - December 3, 2017
-       
-    exists           
-    onlyExisting     
-    onlyMissing      
-    length           
-    isFalsy          
-    isTruthy         
-    foundTruthy      
-    onlyTruthy       
-    foundFalsy       
-    onlyFalsy        
+## Authors
+
+* **Andrew Redican** [andrewredican](https://github.com/andrewredican)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
+
+## Acknowledgments
+
+* Got my inspiration from lodash.js
+
+## Help me improve!
+
+If you have a minute to spare, can you answer these two questions?
+https://www.surveymonkey.com/r/XJ37XSP

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

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40582

increased by85.62%

Number of package files

9

increased by125%

Lines of code

508

increased by15.45%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

65

increased by35.42%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedvalidate@^3.0.1

• + Addedcomponent-type@1.0.0(transitive)

• + Addedeivindfjeldstad-dot@0.0.1(transitive)

• + Addedtypecast@0.0.1(transitive)

• + Addedvalidate@3.1.0(transitive)