rttc - npm Package Compare versions

Comparing version 9.1.0 to 9.2.0

index.js

@@ -25,2 +25,3 @@ module.exports = {
   coerceExemplar: require('./lib/coerce-exemplar'),
+  cast: require('./lib/cast'),
 };
@@ -27,0 +28,0 @@

lib/coerce-exemplar.js

@@ -15,3 +15,3 @@ /**
  * If `allowSpecialSyntax` is set, '->', '*', and '===' take on their traditional special meaning.
- * Otherwise, they will be replaced with strings ('an arrow symbol', 'a star symbol', '3 equal signs')
+ * Otherwise, they will be "exemplified"-- that is, replaced with strings ('an arrow symbol', 'a star symbol', '3 equal signs')
  *
@@ -87,4 +87,5 @@ * @param  {*} value
     }
-    // dictionaries need a recursive step
+    // dictionaries need a recursive step too
     else if (_.isObject(valuePart)) {
+      // Note that empty dictionaries just become generic dictionaries.
       return _.reduce(valuePart, function (dictSoFar, subValue, key) {
@@ -91,0 +92,0 @@ dictSoFar[key] = _recursivelyCoerceExemplar(subValue); // <= recursive step

lib/get-base-val.js

@@ -10,9 +10,9 @@ /**
 /**
- * A convenience method to return the base val for the given value.
+ * A convenience method to return the base value for the given exemplar.
  *
- * @param  {===} val
+ * @param  {===} exemplar
  * @return {*?}
  */
-module.exports = function getBaseVal(val){
-  return coerce(infer(val));
+module.exports = function getBaseVal(exemplar){
+  return coerce(infer(exemplar));
 };

lib/helpers/build-two-headed-schema-cursor.js

@@ -94,3 +94,2 @@ /**
    * @param  {*} thingToTraverse1
-   * @param  {boolean} _isExemplar
    * @return {*}
@@ -97,0 +96,0 @@ */

lib/reify.js

@@ -15,3 +15,3 @@ /**
  * In other words, this makes a type schema "strict", and the result of
- * this function always passes `rttc.isStrictType()`.
+ * this function always passes `rttc.isSpecific()`.
  *
@@ -18,0 +18,0 @@ * @param  {*} typeSchema

lib/union.js

@@ -182,2 +182,6 @@ /**
       var sharedKeys = _.intersection(_.keys(schema0), _.keys(schema1));
+
+      // If there are any keys that don't exist in BOTH schemas, we'll just return
+      // a generic type (ref or {}) as the union.  This way coercing a value to the
+      // unioned schema will never result in data loss (i.e. stripped keys).
       var xorKeys = _.difference(_.union(_.keys(schema0), _.keys(schema1)), sharedKeys);
@@ -184,0 +188,0 @@ if (xorKeys.length > 0) {

package.json

 {
   "name": "rttc",
-  "version": "9.1.0",
+  "version": "9.2.0",
   "description": "Runtime type-checking for JavaScript.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -102,3 +102,3 @@ # rttc
 | boolean                 | `false` _(or `true`)_    | `false`
-| lamda                   | `function anyFunction(){ /* any function */ }` | `function () { throw new Error('Not implemented! (this function was automatically created by `rttc`'); };`
+| lamda                   | `'->'`                   | `function () { throw new Error('Not implemented! (this function was automatically created by `rttc`'); };`
 | generic dictionary      | `{}`           | `{}` _(empty dictionary)_
@@ -560,5 +560,8 @@ | generic array           | `[]`          | `[]` _(empty array)_
 
+##### .getBaseVal(sampleValue)
 
+A convenience method to return the base value for the given exemplar.
 
 
+
 ## License
@@ -565,0 +568,0 @@

No alert changes

Improved metrics

Total package byte prevSize

214684

increased by0.32%

Number of package files

41

increased by2.5%

Lines of code

4578

increased by0.22%

Number of lines in readme file

570

increased by0.53%

No dependency changes