customize - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

CHANGELOG.md

@@ -5,3 +5,6 @@ # Change Log
 
+## v0.2.2 - 2015-07-15
 
+* README-Updates in 0.2.1 and 0.2.2
+
 ## v0.2.0 - 2015-07-14
@@ -8,0 +11,0 @@

index.js

@@ -155,4 +155,7 @@ /*!
 /**
+ * Wrap a function so that if it overrides another function, that function will
+ * be available as `this.parent`
+ * @param fn
+ * @api public
  * @readonly
- * @public
  */
@@ -162,4 +165,9 @@ module.exports.withParent = require('./lib/withParent')
 /**
+ * Create a promise that is regarded as leaf in the configuration tree.
+ * That means, that the overrider is not resolving this promise when overriding values.
+ * Promised object values will not be merged but replaced.
+ * @param {*} promiseOrValue a promise or a valude that represents the leaf
+ * @returns {Promise}
+ * @api public
  * @readonly
- * @public
  */
@@ -213,2 +221,3 @@ module.exports.leaf = require('./lib/leaf')
 /**
+ * The custom-overrider used by Customize
  * @readonly
@@ -215,0 +224,0 @@ * @type {customOverrider}

package.json

 {
   "name": "customize",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "A simple framework to create customizable engines",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -45,5 +45,8 @@ # customize
 
-**withParent**:  , The main class. The heart of Customize
-**leaf**:  , The main class. The heart of Customize
-**overrider**: `customOverrider` , The main class. The heart of Customize
+**withParent**:  , Wrap a function so that if it overrides another function, that function will
+be available as `this.parent`
+**leaf**:  , Create a promise that is regarded as leaf in the configuration tree.
+That means, that the overrider is not resolving this promise when overriding values.
+Promised object values will not be merged but replaced.
+**overrider**: `customOverrider` , The custom-overrider used by Customize
 ##### Customize.registerEngine(id, engine) 
@@ -50,0 +53,0 @@

No alert changes

Improved metrics

Total package byte prevSize

23250

increased by3.53%

Lines of code

351

increased by2.63%

Number of lines in readme file

175

increased by1.74%

No dependency changes