@awesomeeng/awesome-utils - npm Package Compare versions

Comparing version 1.5.1 to 1.6.0

docs/API.md

@@ -222,6 +222,6 @@ ## Classes
 you to quickly move between different types of date like objects.  It
-will parse nubmers as a unix epoch, a string of numbers as a unix epoch,
+will parse numbers as a unix epoch, a string of numbers as a unix epoch,
 JS Date object as a Date Object, or a String as a `Date.parse()` call.
 
-Basically, it does its best to retunr a Date Object or an exception.
+Basically, it does its best to return a Date Object or an exception.
 
@@ -439,3 +439,3 @@ **Kind**: instance method of [<code>DateUtils</code>](#DateUtils)
 Returns true oif the given object is a "plain" javascript object, meaning it
-doesnt inherit from some other type of js object like an array, date, error, etc.
+doesn't inherit from some other type of js object like an array, date, error, etc.
 
@@ -442,0 +442,0 @@ **Kind**: instance method of [<code>ObjectUtils</code>](#ObjectUtils)

package.json

 {
-  "name": "@awesomeeng/awesome-utils",
-  "version": "1.5.1",
-  "author": "the awesome engineering company",
-  "license": "MIT",
-  "contributors": [
-    "Glen R. Goodwin"
-  ],
-  "main": "./src/AwesomeUtils.js",
-  "engines": {
-    "node": ">=10.5.0"
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "eslint": "^6.8.0",
-    "jsdoc-to-markdown": "^5.0.3",
-    "mocha": "^6.2.3"
-  },
-  "optionalDependencies": {},
-  "scripts": {
-    "lint": "eslint src test",
-    "docs": "jsdoc2md src/** --separators > docs/API.md",
-    "test": "mocha test",
-    "tests": "mocha test"
-  },
-  "description": "Javascript Utility functions for enterprise nodejs applications.",
-  "directories": {
-    "doc": "docs",
-    "test": "test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/awesomeeng/awesome-utils.git"
-  },
-  "keywords": [
-    "awesome",
-    "awesomeeng",
-    "awesome",
-    "engineering",
-    "utilities",
-    "utility",
-    "utils",
-    "util"
-  ],
-  "bugs": {
-    "url": "https://github.com/awesomeeng/awesome-utils/issues"
-  },
-  "homepage": "https://github.com/awesomeeng/awesome-utils#readme"
-}
+	"name": "@awesomeeng/awesome-utils",
+	"version": "1.6.0",
+	"author": "the awesome engineering company",
+	"license": "MIT",
+	"contributors": [
+		"Glen R. Goodwin"
+	],
+	"main": "./src/AwesomeUtils.js",
+	"types": "./types/AwesomeUtils.d.ts",
+	"engines": {
+		"node": ">=10.5.0"
+	},
+	"devDependencies": {
+		"eslint": "^8.8.0",
+		"jsdoc-to-markdown": "^7.1.1",
+		"mocha": "^9.2.0",
+		"typescript": "^4.5.5"
+	},
+	"scripts": {
+		"build": "tsc",
+    	"lint": "eslint src test",
+		"docs": "jsdoc2md src/** --separators > docs/API.md",
+		"test": "mocha test",
+		"tests": "mocha test"
+	},
+	"description": "Javascript Utility functions for enterprise nodejs applications.",
+	"directories": {
+		"doc": "docs",
+		"test": "test"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/awesomeeng/awesome-utils.git"
+	},
+	"keywords": [
+		"awesome",
+		"awesomeeng",
+		"awesome",
+		"engineering",
+		"utilities",
+		"utility",
+		"utils",
+		"util"
+	],
+	"bugs": {
+		"url": "https://github.com/awesomeeng/awesome-utils/issues"
+	},
+	"homepage": "https://github.com/awesomeeng/awesome-utils#readme"
+}

RELEASE_NOTES.md

 # AwesomeUtils Release Notes
 
+#### **Version 1.6.0**
+
+ - Adds typescript typings for easier usage.
+
 #### **Version 1.5.1**
@@ -4,0 +8,0 @@

src/AwesomeUtils.js

@@ -0,19 +1,37 @@
+const ANSI = require("./ANSI.js");
+const Array = require("./Array.js");
+const Class = require("./Class.js");
+const Comparator = require("./Comparator.js");
+const Date = require("./Date.js");
+const FS = require("./FS.js");
+const MimeTypes = require("./MimeTypes.js");
+const Module = require("./Module.js");
+const Net = require("./Net.js");
+const Object = require("./Object.js");
+const Parser = require("./Parser.js");
+const Promise = require("./Promise.js");
+const Random = require("./Random.js");
+const Request = require("./Request.js");
+const Sequence = require("./Sequence.js");
+const VM = require("./VM.js");
+const Workers = require("./Workers.js");
+
 module.exports = {
-	ANSI: require("./ANSI.js"),
-	Array: require("./Array.js"),
-	Class: require("./Class.js"),
-	Comparator: require("./Comparator.js"),
-	Date: require("./Date.js"),
-	FS: require("./FS.js"),
-	MimeTypes: require("./MimeTypes.js"),
-	Module: require("./Module.js"),
-	Net: require("./Net.js"),
-	Object: require("./Object.js"),
-	Parser: require("./Parser.js"),
-	Promise: require("./Promise.js"),
-	Random: require("./Random.js"),
-	Request: require("./Request.js"),
-	Sequence: require("./Sequence.js"),
-	VM: require("./VM.js"),
-	Workers: require("./Workers.js")
+	ANSI,
+	Array,
+	Class,
+	Comparator,
+	Date,
+	FS,
+	MimeTypes,
+	Module,
+	Net,
+	Object,
+	Parser,
+	Promise,
+	Random,
+	Request,
+	Sequence,
+	VM,
+	Workers,
 };

src/Date.js

@@ -156,6 +156,6 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com
 	 * you to quickly move between different types of date like objects.  It
-	 * will parse nubmers as a unix epoch, a string of numbers as a unix epoch,
+	 * will parse numbers as a unix epoch, a string of numbers as a unix epoch,
  	 * JS Date object as a Date Object, or a String as a `Date.parse()` call.
  	 *
- 	 * Basically, it does its best to retunr a Date Object or an exception.
+ 	 * Basically, it does its best to return a Date Object or an exception.
  	 *
@@ -162,0 +162,0 @@ * @param  {Date|number|string}

src/Object.js

@@ -14,3 +14,3 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com
 	 * Returns true oif the given object is a "plain" javascript object, meaning it
-	 * doesnt inherit from some other type of js object like an array, date, error, etc.
+	 * doesn't inherit from some other type of js object like an array, date, error, etc.
 	 *
@@ -17,0 +17,0 @@ * @param  {Object}  obj

src/Parser.js

@@ -12,2 +12,6 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com
 
+	// We do this so typescript can get the typings.
+	/**
+	 * @type Class
+	 */
 	get AbstractParser() {
@@ -74,3 +78,3 @@ return AbstractParser;
 	set pos(n) {
-		return this.position = n;
+		this.position = n;
 	}
@@ -83,3 +87,3 @@
 	set index(n) {
-		return this.position = n;
+		this.position = n;
 	}
@@ -86,0 +90,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

179021

increased by20.45%

Number of package files

69

increased by130%

Lines of code

4326

increased by17.62%

Worsened metrics

Dev dependency count

4

increased by33.33%

No dependency changes