fjl-error-throwing - npm Package Compare versions

Comparing version 0.7.3 to 0.7.4

dist/amd/fjl.errorThrowing.js

@@ -19,3 +19,3 @@ define(['exports', './generated/version', 'fjl'], function (exports, _version, _fjl) {
      * @function module:fjlErrorThrowing.isCheckableType
-     * @param type {Type|String|Function}
+     * @param type {TypeRef}
      * @returns {Boolean}
@@ -30,4 +30,4 @@ */
      * @param contextName {String}
-     * @param type {Type|String|Function}
-     * @returns {Type} - Type passed in if `type` is checkable
+     * @param type {TypeRef}
+     * @returns {TypeRef} - Type passed in if `type` is checkable
      */
@@ -141,3 +141,3 @@ errorIfNotCheckableType = exports.errorIfNotCheckableType = (contextName, type) => {
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @param [messageSuffix=null] {String} - Optional.
@@ -159,3 +159,3 @@ * @returns {undefined}
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @returns {undefined}
@@ -186,3 +186,3 @@ * @uncurried
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @param [messageSuffix=null] {String} - Optional.
@@ -202,3 +202,3 @@ * @returns {undefined}
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @returns {undefined}
@@ -205,0 +205,0 @@ * @curried

dist/amd/generated/version.js

@@ -9,10 +9,10 @@ define(['exports'], function (exports) {
    * @memberOf module:fjlErrorThrowing
-   * @property version {String} - Semantic version string.
+   * @property {String} version - Semantic version string.
    * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
-   * @generated Sat Nov 11 2017 17:50:04 GMT-0500 (Eastern Standard Time) 
+   * @generated Sun Nov 12 2017 16:12:15 GMT-0500 (Eastern Standard Time) 
    */
 
-  let version = exports.version = '0.7.3';
+  let version = exports.version = '0.7.4';
 
   exports.default = version;
 });

dist/cjs/fjl.errorThrowing.js

@@ -24,3 +24,3 @@ 'use strict';
  * @function module:fjlErrorThrowing.isCheckableType
- * @param type {Type|String|Function}
+ * @param type {TypeRef}
  * @returns {Boolean}
@@ -37,4 +37,4 @@ */
  * @param contextName {String}
- * @param type {Type|String|Function}
- * @returns {Type} - Type passed in if `type` is checkable
+ * @param type {TypeRef}
+ * @returns {TypeRef} - Type passed in if `type` is checkable
  */
@@ -169,3 +169,3 @@ errorIfNotCheckableType = exports.errorIfNotCheckableType = function errorIfNotCheckableType(contextName, type) {
  * @param valueName {String} - String rep of value.
- * @param value {Any}
+ * @param value {*}
  * @param [messageSuffix=null] {String} - Optional.
@@ -187,3 +187,3 @@ * @returns {undefined}
  * @param valueName {String} - String rep of value.
- * @param value {Any}
+ * @param value {*}
  * @returns {undefined}
@@ -214,3 +214,3 @@ * @uncurried
  * @param valueName {String} - String rep of value.
- * @param value {Any}
+ * @param value {*}
  * @param [messageSuffix=null] {String} - Optional.
@@ -230,3 +230,3 @@ * @returns {undefined}
  * @param valueName {String} - String rep of value.
- * @param value {Any}
+ * @param value {*}
  * @returns {undefined}
@@ -233,0 +233,0 @@ * @curried

dist/cjs/generated/version.js

@@ -8,9 +8,9 @@ 'use strict';
  * @memberOf module:fjlErrorThrowing
- * @property version {String} - Semantic version string.
+ * @property {String} version - Semantic version string.
  * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
- * @generated Sat Nov 11 2017 17:50:04 GMT-0500 (Eastern Standard Time) 
+ * @generated Sun Nov 12 2017 16:12:15 GMT-0500 (Eastern Standard Time) 
  */
 
-var version = exports.version = '0.7.3';
+var version = exports.version = '0.7.4';
 
 exports.default = version;

dist/es6-module/fjl.errorThrowing.js

@@ -5,8 +5,8 @@ import { _isType, curry, curry4, intercalate, isArray, isFunction, isString, isset, length, map, typeOf } from 'fjl';
  * @memberOf module:fjlErrorThrowing
- * @property version {String} - Semantic version string.
+ * @property {String} version - Semantic version string.
  * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
- * @generated Sat Nov 11 2017 17:50:04 GMT-0500 (Eastern Standard Time) 
+ * @generated Sun Nov 12 2017 16:12:15 GMT-0500 (Eastern Standard Time) 
  */
 
-let version = '0.7.3';
+let version = '0.7.4';
 
@@ -13,0 +13,0 @@ /**

dist/iife/fjl.errorThrowing.js

@@ -7,8 +7,8 @@ this.fjl = this.fjl || {};
  * @memberOf module:fjlErrorThrowing
- * @property version {String} - Semantic version string.
+ * @property {String} version - Semantic version string.
  * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
- * @generated Sat Nov 11 2017 17:50:04 GMT-0500 (Eastern Standard Time) 
+ * @generated Sun Nov 12 2017 16:12:15 GMT-0500 (Eastern Standard Time) 
  */
 
-var version = '0.7.3';
+var version = '0.7.4';
 
@@ -15,0 +15,0 @@ /**

dist/iife/fjl.errorThrowing.min.js

@@ -1,1 +0,1 @@
-/**! fjl.errorThrowing.js 0.7.3 | License: ISC | md5checksum: cb52a8c0078643be3fea7e18ebfb056f | Built-on: Sat Nov 11 2017 17:50:05 GMT-0500 (Eastern Standard Time) **/this.fjl=this.fjl||{},this.fjl.errorThrowing=function(e,r){"use strict";var t=function(e){return r.isString(e)||r.isFunction(e)},o=function(e,o){if(!t(o))throw new Error(e+" expects Types to be checked against to be of type `String` or `Function`.  Type received `"+r.typeOf(o)+"`.  Value `"+o+"`.");return o},n=function(e){return o("getTypeName",e)&&r.isString(e)?e:e.name},f=function(e,t){return r._isType(n(e),t)||r.isFunction(e)&&r.isset(t)&&t instanceof e},u=function(e){return r.length(e)?r.intercalate(", ",r.map(function(e){return"`"+n(e)+"`"},e)):""},a=function(e){var t=e.contextName,o=e.valueName,n=e.value,f=e.expectedTypeName,a=e.foundTypeName,i=e.messageSuffix,p=r.isArray(f),y=p?"of type":"of one of the types",T=p?u(f):f;return(t?"`"+t+".":"`")+o+"` is not "+y+": "+T+".  Type received: "+a+".  Value: "+n+";"+(i?"  "+i+";":"")},i=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:f;return function(o,f,u,a){var i=arguments.length>4&&void 0!==arguments[4]?arguments[4]:null,p=n(o),y=r.typeOf(a);if(!t(o,a))throw new Error(e({contextName:f,valueName:u,value:a,expectedTypeName:p,foundTypeName:y,messageSuffix:i}))}},p=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:f;return function(o,f,u,a){var i=o.map(n),p=o.some(function(e){return t(e,a)}),y=r.typeOf(a);if(!p)throw new Error(e({contextName:f,valueName:u,value:a,expectedTypeName:i,foundTypeName:y}))}},y=i(a),T=p(a),c=r.curry(f),s=r.curry(y),l=r.curry4(T),N=function(e){return r.curry(i(e))},h=function(e){return r.curry4(p(e))},g={defaultTypeChecker$:f,defaultTypeChecker:c,getTypeName:n,multiTypesToString:u,defaultErrorMessageCall:a,errorIfNotType$:y,errorIfNotType:s,errorIfNotTypes$:T,errorIfNotTypes:l,getErrorIfNotTypeThrower$:i,getErrorIfNotTypeThrower:N,getErrorIfNotTypesThrower$:p,getErrorIfNotTypesThrower:h};return e.isCheckableType=t,e.errorIfNotCheckableType=o,e.getTypeName=n,e.defaultTypeChecker$=f,e.multiTypesToString=u,e.defaultErrorMessageCall=a,e.getErrorIfNotTypeThrower$=i,e.getErrorIfNotTypesThrower$=p,e.errorIfNotType$=y,e.errorIfNotTypes$=T,e.defaultTypeChecker=c,e.errorIfNotType=s,e.errorIfNotTypes=l,e.getErrorIfNotTypeThrower=N,e.getErrorIfNotTypesThrower=h,e.default=g,e.version="0.7.3",e}({},fjl);
+/**! fjl.errorThrowing.js 0.7.4 | License: ISC | md5checksum: 4ca078cefccc58a976f24f6be6f58027 | Built-on: Sun Nov 12 2017 16:12:16 GMT-0500 (Eastern Standard Time) **/this.fjl=this.fjl||{},this.fjl.errorThrowing=function(e,r){"use strict";var t=function(e){return r.isString(e)||r.isFunction(e)},o=function(e,o){if(!t(o))throw new Error(e+" expects Types to be checked against to be of type `String` or `Function`.  Type received `"+r.typeOf(o)+"`.  Value `"+o+"`.");return o},n=function(e){return o("getTypeName",e)&&r.isString(e)?e:e.name},f=function(e,t){return r._isType(n(e),t)||r.isFunction(e)&&r.isset(t)&&t instanceof e},u=function(e){return r.length(e)?r.intercalate(", ",r.map(function(e){return"`"+n(e)+"`"},e)):""},a=function(e){var t=e.contextName,o=e.valueName,n=e.value,f=e.expectedTypeName,a=e.foundTypeName,i=e.messageSuffix,p=r.isArray(f),y=p?"of type":"of one of the types",T=p?u(f):f;return(t?"`"+t+".":"`")+o+"` is not "+y+": "+T+".  Type received: "+a+".  Value: "+n+";"+(i?"  "+i+";":"")},i=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:f;return function(o,f,u,a){var i=arguments.length>4&&void 0!==arguments[4]?arguments[4]:null,p=n(o),y=r.typeOf(a);if(!t(o,a))throw new Error(e({contextName:f,valueName:u,value:a,expectedTypeName:p,foundTypeName:y,messageSuffix:i}))}},p=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:f;return function(o,f,u,a){var i=o.map(n),p=o.some(function(e){return t(e,a)}),y=r.typeOf(a);if(!p)throw new Error(e({contextName:f,valueName:u,value:a,expectedTypeName:i,foundTypeName:y}))}},y=i(a),T=p(a),c=r.curry(f),s=r.curry(y),l=r.curry4(T),N=function(e){return r.curry(i(e))},h=function(e){return r.curry4(p(e))},g={defaultTypeChecker$:f,defaultTypeChecker:c,getTypeName:n,multiTypesToString:u,defaultErrorMessageCall:a,errorIfNotType$:y,errorIfNotType:s,errorIfNotTypes$:T,errorIfNotTypes:l,getErrorIfNotTypeThrower$:i,getErrorIfNotTypeThrower:N,getErrorIfNotTypesThrower$:p,getErrorIfNotTypesThrower:h};return e.isCheckableType=t,e.errorIfNotCheckableType=o,e.getTypeName=n,e.defaultTypeChecker$=f,e.multiTypesToString=u,e.defaultErrorMessageCall=a,e.getErrorIfNotTypeThrower$=i,e.getErrorIfNotTypesThrower$=p,e.errorIfNotType$=y,e.errorIfNotTypes$=T,e.defaultTypeChecker=c,e.errorIfNotType=s,e.errorIfNotTypes=l,e.getErrorIfNotTypeThrower=N,e.getErrorIfNotTypesThrower=h,e.default=g,e.version="0.7.4",e}({},fjl);

dist/umd/fjl.errorThrowing.js

@@ -31,3 +31,3 @@ (function (global, factory) {
      * @function module:fjlErrorThrowing.isCheckableType
-     * @param type {Type|String|Function}
+     * @param type {TypeRef}
      * @returns {Boolean}
@@ -44,4 +44,4 @@ */
      * @param contextName {String}
-     * @param type {Type|String|Function}
-     * @returns {Type} - Type passed in if `type` is checkable
+     * @param type {TypeRef}
+     * @returns {TypeRef} - Type passed in if `type` is checkable
      */
@@ -176,3 +176,3 @@ errorIfNotCheckableType = exports.errorIfNotCheckableType = function errorIfNotCheckableType(contextName, type) {
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @param [messageSuffix=null] {String} - Optional.
@@ -194,3 +194,3 @@ * @returns {undefined}
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @returns {undefined}
@@ -221,3 +221,3 @@ * @uncurried
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @param [messageSuffix=null] {String} - Optional.
@@ -237,3 +237,3 @@ * @returns {undefined}
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @returns {undefined}
@@ -240,0 +240,0 @@ * @curried

dist/umd/generated/version.js

@@ -21,10 +21,10 @@ (function (global, factory) {
    * @memberOf module:fjlErrorThrowing
-   * @property version {String} - Semantic version string.
+   * @property {String} version - Semantic version string.
    * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
-   * @generated Sat Nov 11 2017 17:50:04 GMT-0500 (Eastern Standard Time) 
+   * @generated Sun Nov 12 2017 16:12:15 GMT-0500 (Eastern Standard Time) 
    */
 
-  var version = exports.version = '0.7.3';
+  var version = exports.version = '0.7.4';
 
   exports.default = version;
 });

jsdocs/scripts/linenumber.js

@@ -0,0 +0,0 @@ /*global document */

jsdocs/scripts/prettify/Apache-License-2.0.txt

@@ -0,0 +0,0 @@

jsdocs/scripts/prettify/lang-css.js

 PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n"]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
 /^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);

jsdocs/scripts/prettify/prettify.js

@@ -0,0 +0,0 @@ var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;

node-scripts/VersionNumberReadStream.js

@@ -27,3 +27,3 @@ /**
  * @memberOf module:fjlErrorThrowing
- * @property version {String} - Semantic version string.
+ * @property {String} version - Semantic version string.
  * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
@@ -30,0 +30,0 @@ * @generated ${new Date()}

package.json

 {
   "name": "fjl-error-throwing",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "Error throwing helpers for quickly throwing errors when a value doesn't match a type.",
@@ -5,0 +5,0 @@ "main": "dist/cjs/fjl.errorThrowing.js",

src/fjl.errorThrowing.js

@@ -19,9 +19,14 @@ /**
 /**
- * @typedef TemplateContext {Object<value, valueName, expectedTypeName, foundTypeName, messageSuffix>}
+ * @typedef {String|Function} TypeRef
+ * @description Type reference.  Type itself or Type's name;  E.g., `Type.name`;
+ */
+
+/**
+ * @typedef {Object<value, valueName, expectedTypeName, foundTypeName, messageSuffix>} TemplateContext
  * @description Template context used for error message renderers (functions that take a context obj and return a string).
- * @property value {Any}
+ * @property value {*}
  * @property valueName {String}
  * @property expectedTypeName {String} - Expected name of constructor of `value`;  E.g., usually `SomeConstructor.name`;
  * @property foundTypeName {String} - Found types name;  E.g., `FoundConstructor.name`;
- * @property [messageSuffix=null] {Any} - Message suffix (sometimes an extra hint or instructions for
+ * @property [messageSuffix=null] {*} - Message suffix (sometimes an extra hint or instructions for
  *  directing user to fix where his/her error has occurred).  Optional.
@@ -37,4 +42,4 @@ */
  * @description Checks whether a value is of given type.
- * @param Type {Function|String} - a Type constructor or it's name.
- * @param value {Any} - Any value.
+ * @param Type {TypeRef} - a Type or it's name;  E.g., `Type.name`.
+ * @param value {*}
  * @returns {Boolean}
@@ -53,6 +58,6 @@ */
  * @description Used to ensure value matches passed in type.
- * @param type {String|Function} - Constructor name or constructor.
+ * @param type {TypeRef} - Constructor name or constructor.
  * @param contextName {String}
  * @param valueName {String}
- * @param value {Any}
+ * @param value {*}
  * @throws {Error} - If value doesn't match type.
@@ -65,6 +70,6 @@ * @returns {Undefined}
  * @description Used to ensure a value matches one of one or more types passed in.
- * @param valueTypes {Array|TypesArray} - Array of constructor names or constructors.
+ * @param valueTypes {TypesArray} - Array of constructor names or constructors.
  * @param contextName {String}
  * @param valueName {String}
- * @param value {Any}
+ * @param value {*}
  * @throws {Error} - If value doesn't match type.
@@ -74,7 +79,2 @@ * @returns {Undefined}
 
-/**
- * @memberOf module:fjlErrorThrowing
- * @property version {String}
- * @description Library version no..
- */
 export {version} from './generated/version';
@@ -87,3 +87,3 @@
      * @function module:fjlErrorThrowing.isCheckableType
-     * @param type {Type|String|Function}
+     * @param type {TypeRef}
      * @returns {Boolean}
@@ -97,4 +97,4 @@ */
      * @param contextName {String}
-     * @param type {Type|String|Function}
-     * @returns {Type} - Type passed in if `type` is checkable
+     * @param type {TypeRef}
+     * @returns {TypeRef} - Type passed in if `type` is checkable
      */
@@ -209,3 +209,3 @@ errorIfNotCheckableType = (contextName, type) => {
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @param [messageSuffix=null] {String} - Optional.
@@ -226,3 +226,3 @@ * @returns {undefined}
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @returns {undefined}
@@ -251,3 +251,3 @@ * @uncurried
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @param [messageSuffix=null] {String} - Optional.
@@ -266,3 +266,3 @@ * @returns {undefined}
      * @param valueName {String} - String rep of value.
-     * @param value {Any}
+     * @param value {*}
      * @returns {undefined}
@@ -269,0 +269,0 @@ * @curried

src/generated/version.js

 /**
  * @memberOf module:fjlErrorThrowing
- * @property version {String} - Semantic version string.
+ * @property {String} version - Semantic version string.
  * @note Content generated by '{project-root}/node-scripts/VersionNumberReadStream.js'.
- * @generated Sat Nov 11 2017 17:50:04 GMT-0500 (Eastern Standard Time) 
+ * @generated Sun Nov 12 2017 16:12:15 GMT-0500 (Eastern Standard Time) 
  */
 
-export let version = '0.7.3';
+export let version = '0.7.4';
 
 export default version;
 

New alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1249197

1.53%

Worsened metrics

Lines of code

2201

-0.05%

No dependency changes