fwsp-jsutils - npm Package Compare versions

Comparing version 1.0.8 to 1.0.9

index.js

 'use strict';
 
 const crypto = require('crypto');
+const jss = require('json-stringify-safe');
 
@@ -112,7 +113,3 @@ class Utils {
   static safeJSONStringify(obj) {
-    let data;
-    if ((typeof obj === 'object' && Object.prototype.toString.call(obj) !== '[object Array]')) {
-      data = JSON.stringify(obj);
-    }
-    return data;
+    return jss(obj);
   }
@@ -119,0 +116,0 @@

package.json

 {
   "name": "fwsp-jsutils",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "JavaScript Utils - useful dev utils",
-	"author": {
+  "author": {
     "name": "Carlos Justiniano",
@@ -14,2 +14,3 @@ "email": "[e-mail]"
   ],
+  "license": "MIT",
   "repository": {
@@ -20,5 +21,5 @@ "type": "git",
   "homepage": "https://github.com/flywheelsports/fwsp-jsutils",
-	"scripts": {
+  "scripts": {
     "test": "mocha specs --reporter spec"
-	},
+  },
   "engines": {
@@ -29,9 +30,10 @@ "node": ">=6.2.1"
   "dependencies": {
+    "json-stringify-safe": "5.0.1"
   },
   "devDependencies": {
-    "chai": "^3.5.0",
-    "eslint": "^1.9.0",
-    "jscs": "^2.5.1",
-    "jscs-jsdoc": "^1.2.0",
-    "mocha": "^2.4.5"
+    "chai": "3.5.0",
+    "eslint": "1.9.0",
+    "jscs": "2.5.1",
+    "jscs-jsdoc": "1.2.0",
+    "mocha": "2.4.5"
   },
@@ -38,0 +40,0 @@ "bin": {

README.md

 # JS Utils
-Handy JavaScript utils
+
+Flywheel JS utils is a library of useful JavaScript utilities.
+
+## Install
+You can install it via NPM:
+
+```shell
+$ npm -i fwsp-jsutils
+```
+
+## Usage
+
+```javascript
+const Utils = require('fwsp-jsutils');
+let hash = Utils.stringHash('This is a test');
+```
+
+## Tests
+
+Tests can be found in the `specs` folder.
+
+```shell
+$ npm test
+```
+
+## API
+
+### strip - strips white space characters - except for spaces
+
+```javascript
+ /**
+  * @name strip
+  * @summary strips white space characters - except for spaces
+  * @param {string} str - string to strip characters from
+  * @return {string} string - without white space characters
+  */
+  static strip(str)
+```
+
+### zeroPad - add preceeding zeros to maintain desired places
+
+```javascript
+  /**
+  * @name zeroPad
+  * @summary add preceeding zeros to maintain desired places
+  * @param {number} num - number to zero pad
+  * @param {number} places - place digits (length)
+  * @return {string} string with preceeding zeros
+  */
+  static zeroPad(num, places)
+```
+
+### stringHash - returns a hash value for a supplied string
+
+```javascript
+ /**
+   * @name stringHash
+   * @summary returns a hash value for a supplied string
+   * @see https://github.com/darkskyapp/string-hash
+   * @private
+   * @param {object} str - string to hash
+   * @return {number} hash - hash value
+   */
+  static stringHash(str)
+```  
+
+### shortID - generate a random id composed of alphanumeric characters
+
+```javascript
+  /**
+  * @name shortID
+  * @summary generate a random id composed of alphanumeric characters
+  * @see https://en.wikipedia.org/wiki/Base36
+  * @return {string} random string id
+  */
+  static shortID()
+```
+
+### UUID - Pseudo UUID
+
+```javascript
+  /**
+  * @name UUID
+  * @summary Pseudo UUID
+  * @return {string} uuid - unique string
+  */
+  static UUID()
+```
+
+### isObject - Determines whether a variable is an object
+
+```javascript
+  /**
+  * @name isObject
+  * @summary Determines whether a variable is an object
+  * @param {object} obj - variable being tested
+  * @return {boolean} - true if object else false
+  */
+  static isObject(obj)
+```
+
+### isArray - Determines whether a variable is an array
+
+```javascript
+  /**
+  * @name isArray
+  * @summary Determines whether a variable is an array
+  * @param {object} obj - variable being tested
+  * @return {boolean} - true if array else false
+  */
+  static isArray(obj)
+```
+
+### safeJSONStringify - Safe JSON stringify
+
+```javascript
+/**
+ * @name safeJSONParse
+ * @summary Safe JSON parse
+ * @private
+ * @param {string} str - string which will be parsed
+ * @return {object} obj - parsed object
+ *   Returns undefined if string can't be parsed into an object
+ */
+  static safeJSONStringify(obj)
+```
+
+### safeJSONParse - Safe JSON parse
+
+```javascript
+  /**
+   * @name safeJSONParse
+   * @summary Safe JSON parse
+   * @private
+   * @param {string} str - string which will be parsed
+   * @return {object} obj - parsed object
+   *   Returns undefined if string can't be parsed into an object
+   */
+  static safeJSONParse(str)
+```
+
+### shuffleArray - Uses the Durstenfeld shuffle algorithm
+
+```javascript
+  /**
+  * @name shuffleArray
+  * @summary Shuffles and array
+  * @description Uses the Durstenfeld shuffle algorithm
+  * @param {array} array - to shuffle
+  * @return {array} array - shuffled array
+  */
+  static shuffleArray(array)
+```
+
+### htmlEncode - Encode HTML text by converting characters to html codes
+
+```javascript
+  /**
+  * @name htmlEncode
+  * @summary Encode HTML text by converting characters to html codes
+  * @param {string} text - html text to encode
+  * @return {string} text - encoded html text
+  */
+  static htmlEncode(text)
+```
+
+### htmlDecode - Decode HTML text to original form
+
+```javascript
+  /**
+  * @name htmlDecode
+  * @summary Decode HTML text to original form
+  * @param {string} text - html text to encode
+  * @return {string} text - decoded html text
+  */
+  static htmlDecode(text)
+```
+
+### md5Hash - Hashes a key to produce an MD5 hash
+
+```javascript
+  /**
+  * @name md5Hash
+  * @summary Hashes a key to produce an MD5 hash
+  * @param {string} key - input key to hash
+  * @return {string} hash - hashed value
+  */
+  static md5Hash(key)
+```
+
+### getGeoDistance - Get the distance between to lat/lngs
+
+```javascript
+
+  /**
+  * @name getGeoDistance
+  * @summary Get the distance between to lat/lngs
+  * @notes http://stackoverflow.com/questions/27928/how-do-i-calculate-distance-between-two-latitude-longitude-points
+  * @param {number} lat1 - from lat
+  * @param {number} lng1 - from lng
+  * @param {number} lat2 - to lat
+  * @param {number} lng2 - to lng
+  * @return {number} value - distance in miles
+  */
+  static getGeoDistance(lat1, lng1, lat2, lng2) {
+```
+
+### getRandom - Returns a random number between 0 (inclusive) and 1 (exclusive)
+
+```javascript
+  /**
+  * @name getRandom
+  * @summary Returns a random number between 0 (inclusive) and 1 (exclusive)
+  * @return {number} num - number
+  */
+  static getRandom()
+```
+
+### getRandomArbitrary - Returns a random number between min (inclusive) and max (exclusive)
+
+```javascript
+  /**
+  * @name getRandomArbitrary
+  * @summary Returns a random number between min (inclusive) and max (exclusive)
+  * @return {number} num - number
+  */
+  static getRandomArbitrary(min, max)
+```
+
+### getRandomInt - Returns a random integer between min (included) and max (excluded)
+
+```javascript
+  /**
+  * @name getRandomInt
+  * @summary Returns a random integer between min (included) and max (excluded)
+  * @return {number} num - number
+  */
+  static getRandomInt(min, max)
+```
+
+### getRandomIntInclusive - Returns a random integer between min (included) and max (included)
+
+```javascript
+  /**
+  * @name getRandomIntInclusive
+  * @summary Returns a random integer between min (included) and max (included)
+  * @return {number} num - number
+  */
+  static getRandomIntInclusive(min, max)
+```

specs/safejson-spec.js

@@ -36,6 +36,10 @@ 'use strict';
   });
-  it('should return undefined when trying to stringify an invalid object', () => {
+  it('should return 34 when trying to stringify a number', () => {
     let str = Utils.safeJSONStringify(34);
-    expect(str).to.be.undefined;
+    expect(str).to.be.equal('34');
   });
+  it('should return empty array when trying to stringify an undefined', () => {
+    let str = Utils.safeJSONStringify();
+    expect(str).to.equal(undefined);
+  });
 });

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 License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23056

increased by43.65%

Number of package files

17

increased by6.25%

Number of low license alerts

0

decreased by-100%

Lines of code

398

increased by0.25%

Number of lines in readme file

252

increased by8300%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedjson-stringify-safe@5.0.1

• + Addedjson-stringify-safe@5.0.1(transitive)