ranged-date - npm Package Compare versions

Comparing version 2.0.2 to 2.1.0

CHANGELOG.md

 # Changelog
 
+## <a name="2.1.0"></a> [2.1.0](https://github.com/jpcx/ranged-date/tree/2.1.0) (2019-06-15)
+
+| __[Changes since 2.0.2](https://github.com/jpcx/ranged-date/compare/2.0.2...2.1.0)__ | [Release Notes](https://github.com/jpcx/ranged-date/releases/tag/2.1.0) | [README](https://github.com/jpcx/ranged-date/tree/2.1.0/README.md) |
+| --- | --- | --- |
+
+| [Source Code (zip)](https://github.com/jpcx/ranged-date/archive/2.1.0.zip) | [Source Code (tar.gz)](https://github.com/jpcx/ranged-date/archive/2.1.0.tar.gz) |
+| --- | --- |
+
+__Features:__
+
++ __docs:__ Added documentation for cert-is errors.
++ __npm:__  Added documentationjs fix script.
+            Added dependency update script.
+            Made postinstall migration warning more visible.
+
 ## <a name="2.0.2"></a> [2.0.2](https://github.com/jpcx/ranged-date/tree/2.0.2) (2019-06-13)
@@ -4,0 +19,0 @@

index.js

 'use strict'
 
+/**
+ * Value certification module. Certifies that parameters passed to ranged-date
+ * are of expected types and ranges.
+ *
+ * @private
+ * @module cert-is
+ * @external
+ * @see {@link https://github.com/jpcx/cert-is}
+ */
 const cert = require('cert-is')
@@ -20,3 +29,3 @@
  */
-const inRange = (t, l, u) => cert(t, l, u).isType('number') && t > l && t < u
+const inRange = (t, l, u) => t > l && t < u
 /**
@@ -35,4 +44,3 @@ * Returns the difference of a number and the current date in ms as years from the current date.
  */
-const yrDist = target =>
-  cert(target).isType('number') && (target - Date.now()) / +'31536e6'
+const yrDist = target => (target - Date.now()) / +'31536e6'
 /**
@@ -54,5 +62,3 @@ * Returns the given number only if it falls within a given range in years from the current date.
 const bound = (target, yrBack, yrFwd) =>
-  cert(target, yrBack, yrFwd).isType('number') &&
-  inRange(yrDist(target), -yrBack, yrFwd) &&
-  target
+  inRange(yrDist(target), -yrBack, yrFwd) && target
 /**
@@ -62,7 +68,10 @@ * Returns time in ms if number itself, seconds equivalent, or microseconds equivalent falls within a given range in years from the current date.
  * @private
- * @param   {number} target - Number being tested.
- * @param   {number} yrBack   - Years before current date as lower bound.
- * @param   {number} yrFwd    - Years after current date as upper bound.
- * @param   {ranged-date~exclude} exclude - Specifies range exclusions, if any.
- * @returns {(number|boolean)} Converted ms or false if outside range.
+ * @param   {number}  target     - Number being tested.
+ * @param   {number}  yrBack     - Years before current date as lower bound.
+ * @param   {number}  yrFwd      - Years after current date as upper bound.
+ * @param   {Object}  exclusions - Specifies interpretation exclusions, if any.
+ * @param   {boolean} [exclusions.us=false] - Exclude microseconds interpretation.
+ * @param   {boolean} [exclusions.ms=false] - Exclude milliseconds interpretation.
+ * @param   {boolean} [exclusions.s=false]  - Exclude seconds interpretation.
+ * @returns {(number|boolean)}  Converted ms or false if outside range.
  * @example
@@ -106,3 +115,2 @@ * // returns current time in ms
 const check = (target, yrBack, yrFwd, exclusions) =>
-  cert(target, yrBack, yrFwd).isType('number') &&
   isFinite(target) &&
@@ -122,7 +130,7 @@ ((!exclusions.ms && bound(target, yrBack, yrFwd)) ||
  * @param   {Object}  exclusions - Specifies interpretation exclusions, if any.
- * @param   {boolean} exclusions.us - Exclude microseconds interpretation.
- * @param   {boolean} exclusions.ms - Exclude milliseconds interpretation.
- * @param   {boolean} exclusions.s  - Exclude seconds interpretation.
+ * @param   {boolean} [exclusions.us=false] - Exclude microseconds interpretation.
+ * @param   {boolean} [exclusions.ms=false] - Exclude milliseconds interpretation.
+ * @param   {boolean} [exclusions.s=false]  - Exclude seconds interpretation.
  * @returns {(number|boolean)} Converted time in ms or false if outside range.
- * @throws  {(cert-is.TypeAssertionError|cert-is.RangeAssertionError)} Throws an assertion error if parameter requirements are not met.
+ * @throws  {(module:cert-is.TypeAssertionError|module:cert-is.RangeAssertionError)} Throws an assertion error if parameter requirements are not met.
  * @example
@@ -161,2 +169,5 @@ * // All return current time in ms
     .isGT(0)
+  cert(exclusions)
+    .message('ranged-date exclusions must be specified with an object')
+    .isType(Object)
   cert(exclusions.s, exclusions.ms, exclusions.us)
@@ -175,1 +186,17 @@ .message('ranged-date exclusions must be booleans')
 }
+
+/**
+ * Thrown by {@link https://github.com/jpcx/cert-is cert-is} in response to a type assertion error.
+ *
+ * @public
+ * @typedef {Error} module:cert-is.TypeAssertionError
+ * @external
+ */
+
+/**
+ * Thrown by {@link https://github.com/jpcx/cert-is cert-is} in response to a range assertion error.
+ *
+ * @public
+ * @typedef {Error} module:cert-is.RangeAssertionError
+ * @external
+ */

package.json

 {
   "name": "ranged-date",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Converts a given string, number, or Date object to the number of milliseconds since the Unix epoch, provided that it can be recognized as millisecond, second, or microsecond time within a specified range from the current date.",
@@ -11,5 +11,6 @@ "engines": {
     "test": "mocha",
-	"prepare": "npm test && documentation readme index.js -s Documentation -a public --github && npm run-script fixReadme",
-	"fixReadme": "node -e \"const ver = require('./package.json').version; const fs = require('fs'); const readme = fs.readFileSync('./README.md', 'utf8'); fs.writeFileSync('./README.md', readme.replace(/\\/blob\\/[0-9a-z]+?\\//g, '/blob/' + ver + '/'), 'utf8')\"",
-    "postinstall": "node -e \"console.log('Breaking changes introduced from 1.x.x to 2.x.x. Please see the readme at <https://github.com/jpcx/ranged-date/tree/2.0.0/README.md>')\""
+    "update": "rm -rf node_modules && rm package-lock.json && ncu -u && npm i -d && npx npm-force-resolutions && rm -rf node_modules && npm i -d",
+    "prepack": "npm run-script update && npm run-script write-public-api-docs && npm test",
+    "write-public-api-docs": "documentation readme index.js -s API -a public --github && node scripts/postDocJS.js",
+    "postinstall": "node -e \"console.log('\\n\\n\\x1b[1m\\x1b[33mranged-date:\\n------------\\nBreaking changes introduced from 1.x.x to 2.x.x. Please see the readme at <https://github.com/jpcx/ranged-date/tree/2.0.0/README.md>\\n\\x1b[0m')\""
   },
@@ -42,7 +43,12 @@ "keywords": [
     "standard": "^12.0.1",
-    "documentation": "^11.0.1"
+    "documentation": "^11.0.1",
+    "npm-force-resolutions": "0.0.2"
   },
   "dependencies": {
-    "cert-is": "^0.3.0"
+    "cert-is": "^0.3.2"
+  },
+  "resolutions": {
+    "js-yaml": "^3.13.1",
+    "diff": "^3.5.0"
   }
 }

README.md

@@ -5,2 +5,14 @@ # ranged-date
 
+[![NPM](https://img.shields.io/npm/l/ranged-date.svg)](https://www.npmjs.com/package/ranged-date/)
+[![NPM](https://img.shields.io/node/v/ranged-date.svg)](https://www.npmjs.com/package/ranged-date/)
+[![NPM](https://img.shields.io/npm/dm/ranged-date.svg)](https://www.npmjs.com/package/ranged-date/)
+[![NPM](https://img.shields.io/github/last-commit/jpcx/ranged-date.svg)](https://www.npmjs.com/package/ranged-date/)
+[![NPM](https://img.shields.io/david/jpcx/ranged-date.svg)](https://www.npmjs.com/package/ranged-date/)
+[![NPM](https://img.shields.io/david/dev/jpcx/ranged-date.svg)](https://www.npmjs.com/package/ranged-date/)
+
+**MIGRATION NOTICE:**
+
+-   _ranged-date 2.0.0: back and forward ranges are now mandatory (were 0.5 each by default in 1.x.x)._
+-   _ranged-date 2.0.0: Date Objects with values outside of the specified range will return false (would return Date Object in 1.x.x)._
+
 Converts a given string, number, or Date object to the number of milliseconds since the Unix epoch, provided that it can be recognized as millisecond, second, or microsecond time within a specified range from the current date.
@@ -15,7 +27,2 @@
 
-**MIGRATION NOTICE:**
-
--   _ranged-date 2.0.0: back and forward ranges are now mandatory (were 0.5 each by default in 1.x.x)._
--   _ranged-date 2.0.0: Date Objects with values outside of the specified range will return false (would return Date Object in 1.x.x)._
-
 ## Getting Started
@@ -38,3 +45,3 @@
 
-## Documentation
+## API
 
@@ -46,8 +53,8 @@ <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 -   [ranged-date](#ranged-date)
-    -   [Parameters](#parameters)
-    -   [Examples](#examples)
+-   [module:cert-is.TypeAssertionError](#modulecert-istypeassertionerror)
+-   [module:cert-is.RangeAssertionError](#modulecert-israngeassertionerror)
 
 ### ranged-date
 
-[index.js:142-167](https://github.com/jpcx/ranged-date/blob/2.0.2/index.js#L142-L167 "Source code on GitHub")
+[index.js:150-178](https://github.com/jpcx/ranged-date/blob/2.1.0/index.js#L150-L178 "Source code on GitHub")
 
@@ -62,5 +69,5 @@ Converts a given string, number, or Date object to the number of milliseconds since the Unix epoch, provided that it can be recognized as millisecond, second, or microsecond time within a specified range from the current date.
 -   `exclusions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Specifies interpretation exclusions, if any.
-    -   `exclusions.us` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Exclude microseconds interpretation.
-    -   `exclusions.ms` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Exclude milliseconds interpretation.
-    -   `exclusions.s` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Exclude seconds interpretation.
+    -   `exclusions.us` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Exclude microseconds interpretation. (optional, default `false`)
+    -   `exclusions.ms` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Exclude milliseconds interpretation. (optional, default `false`)
+    -   `exclusions.s` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Exclude seconds interpretation. (optional, default `false`)
 
@@ -90,6 +97,22 @@ #### Examples
 
--   Throws **(cert-is.TypeAssertionError | cert-is.RangeAssertionError)** Throws an assertion error if parameter requirements are not met.
+-   Throws **([module:cert-is.TypeAssertionError](#modulecert-istypeassertionerror) \| [module:cert-is.RangeAssertionError](#modulecert-israngeassertionerror))** Throws an assertion error if parameter requirements are not met.
 
 Returns **([number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** Converted time in ms or false if outside range.
 
+### module:cert-is.TypeAssertionError
+
+[index.js:150-178](https://github.com/jpcx/ranged-date/blob/2.1.0/index.js#L150-L178 "Source code on GitHub")
+
+Thrown by [cert-is](https://github.com/jpcx/cert-is) in response to a type assertion error.
+
+Type: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
+
+### module:cert-is.RangeAssertionError
+
+[index.js:150-178](https://github.com/jpcx/ranged-date/blob/2.1.0/index.js#L150-L178 "Source code on GitHub")
+
+Thrown by [cert-is](https://github.com/jpcx/cert-is) in response to a range assertion error.
+
+Type: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
+
 ## Versioning
@@ -96,0 +119,0 @@

New alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24279

30.41%

Number of package files

7

16.67%

Lines of code

395

32.55%

Number of lines in readme file

123

23%

Worsened metrics

Dev dependency count

4

33.33%

Number of low supply chain risk alerts

2

100%

Dependency changes

• Updated

  cert-is@^0.3.2