Cleanup
This commit is contained in:
Jonasz Bigda
524
node_modules/kareem/README.md
generated
vendored
524
node_modules/kareem/README.md
generated
vendored
@@ -24,11 +24,9 @@ appropriate, giving you more fine-grained control over your function hooks.
|
||||
#### It runs without any hooks specified
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.execPre('cook', null, function() {
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function() {
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
#### It runs basic serial pre hooks
|
||||
@@ -38,44 +36,38 @@ when your pre hook is finished.
|
||||
|
||||
|
||||
```javascript
|
||||
|
||||
var count = 0;
|
||||
var count = 0;
|
||||
|
||||
hooks.pre('cook', function(done) {
|
||||
++count;
|
||||
done();
|
||||
});
|
||||
hooks.pre('cook', function(done) {
|
||||
++count;
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function() {
|
||||
assert.equal(1, count);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function() {
|
||||
assert.equal(1, count);
|
||||
});
|
||||
```
|
||||
|
||||
#### It can run multipe pre hooks
|
||||
|
||||
```javascript
|
||||
|
||||
var count1 = 0;
|
||||
var count2 = 0;
|
||||
var count1 = 0;
|
||||
var count2 = 0;
|
||||
|
||||
hooks.pre('cook', function(done) {
|
||||
++count1;
|
||||
done();
|
||||
});
|
||||
hooks.pre('cook', function(done) {
|
||||
++count1;
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.pre('cook', function(done) {
|
||||
++count2;
|
||||
done();
|
||||
});
|
||||
hooks.pre('cook', function(done) {
|
||||
++count2;
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function() {
|
||||
assert.equal(1, count1);
|
||||
assert.equal(1, count2);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function() {
|
||||
assert.equal(1, count1);
|
||||
assert.equal(1, count2);
|
||||
});
|
||||
```
|
||||
|
||||
#### It can run fully synchronous pre hooks
|
||||
@@ -85,25 +77,22 @@ fully synchronous.
|
||||
|
||||
|
||||
```javascript
|
||||
|
||||
var count1 = 0;
|
||||
var count2 = 0;
|
||||
var count1 = 0;
|
||||
var count2 = 0;
|
||||
|
||||
hooks.pre('cook', function() {
|
||||
++count1;
|
||||
});
|
||||
hooks.pre('cook', function() {
|
||||
++count1;
|
||||
});
|
||||
|
||||
hooks.pre('cook', function() {
|
||||
++count2;
|
||||
});
|
||||
hooks.pre('cook', function() {
|
||||
++count2;
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function(error) {
|
||||
assert.equal(null, error);
|
||||
assert.equal(1, count1);
|
||||
assert.equal(1, count2);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', null, function(error) {
|
||||
assert.equal(null, error);
|
||||
assert.equal(1, count1);
|
||||
assert.equal(1, count2);
|
||||
});
|
||||
```
|
||||
|
||||
#### It properly attaches context to pre hooks
|
||||
@@ -112,27 +101,24 @@ Pre save hook functions are bound to the second parameter to `execPre()`
|
||||
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.pre('cook', function(done) {
|
||||
this.bacon = 3;
|
||||
done();
|
||||
});
|
||||
hooks.pre('cook', function(done) {
|
||||
this.bacon = 3;
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.pre('cook', function(done) {
|
||||
this.eggs = 4;
|
||||
done();
|
||||
});
|
||||
hooks.pre('cook', function(done) {
|
||||
this.eggs = 4;
|
||||
done();
|
||||
});
|
||||
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
|
||||
// In the pre hooks, `this` will refer to `obj`
|
||||
hooks.execPre('cook', obj, function(error) {
|
||||
assert.equal(null, error);
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
done();
|
||||
});
|
||||
|
||||
// In the pre hooks, `this` will refer to `obj`
|
||||
hooks.execPre('cook', obj, function(error) {
|
||||
assert.equal(null, error);
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
});
|
||||
```
|
||||
|
||||
#### It can execute parallel (async) pre hooks
|
||||
@@ -144,38 +130,35 @@ async pre hooks have called `done()`.
|
||||
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
this.bacon = 3;
|
||||
next();
|
||||
setTimeout(function() {
|
||||
done();
|
||||
}, 5);
|
||||
});
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
this.bacon = 3;
|
||||
next();
|
||||
setTimeout(function() {
|
||||
done();
|
||||
}, 5);
|
||||
});
|
||||
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
next();
|
||||
var _this = this;
|
||||
setTimeout(function() {
|
||||
_this.eggs = 4;
|
||||
done();
|
||||
}, 10);
|
||||
});
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
next();
|
||||
var _this = this;
|
||||
setTimeout(function() {
|
||||
_this.eggs = 4;
|
||||
done();
|
||||
}, 10);
|
||||
});
|
||||
|
||||
hooks.pre('cook', function(next) {
|
||||
this.waffles = false;
|
||||
next();
|
||||
});
|
||||
hooks.pre('cook', function(next) {
|
||||
this.waffles = false;
|
||||
next();
|
||||
});
|
||||
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
|
||||
hooks.execPre('cook', obj, function() {
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', obj, function() {
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
});
|
||||
```
|
||||
|
||||
#### It supports returning a promise
|
||||
@@ -186,148 +169,162 @@ next middleware.
|
||||
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.pre('cook', function() {
|
||||
return new Promise(resolve => {
|
||||
setTimeout(() => {
|
||||
this.bacon = 3;
|
||||
resolve();
|
||||
}, 100);
|
||||
});
|
||||
});
|
||||
hooks.pre('cook', function() {
|
||||
return new Promise(resolve => {
|
||||
setTimeout(() => {
|
||||
this.bacon = 3;
|
||||
resolve();
|
||||
}, 100);
|
||||
});
|
||||
});
|
||||
|
||||
var obj = { bacon: 0 };
|
||||
var obj = { bacon: 0 };
|
||||
|
||||
hooks.execPre('cook', obj, function() {
|
||||
assert.equal(3, obj.bacon);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPre('cook', obj, function() {
|
||||
assert.equal(3, obj.bacon);
|
||||
});
|
||||
```
|
||||
|
||||
## post hooks
|
||||
|
||||
acquit:ignore:end
|
||||
|
||||
#### It runs without any hooks specified
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.execPost('cook', null, [1], function(error, eggs) {
|
||||
assert.ifError(error);
|
||||
assert.equal(1, eggs);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPost('cook', null, [1], function(error, eggs) {
|
||||
assert.ifError(error);
|
||||
assert.equal(1, eggs);
|
||||
done();
|
||||
});
|
||||
```
|
||||
|
||||
#### It executes with parameters passed in
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.post('cook', function(eggs, bacon, callback) {
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
callback();
|
||||
});
|
||||
hooks.post('cook', function(eggs, bacon, callback) {
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
callback();
|
||||
});
|
||||
|
||||
hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
|
||||
assert.ifError(error);
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
|
||||
assert.ifError(error);
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
});
|
||||
```
|
||||
|
||||
#### It can use synchronous post hooks
|
||||
|
||||
```javascript
|
||||
|
||||
var execed = {};
|
||||
var execed = {};
|
||||
|
||||
hooks.post('cook', function(eggs, bacon) {
|
||||
execed.first = true;
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
});
|
||||
hooks.post('cook', function(eggs, bacon) {
|
||||
execed.first = true;
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
});
|
||||
|
||||
hooks.post('cook', function(eggs, bacon, callback) {
|
||||
execed.second = true;
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
callback();
|
||||
});
|
||||
hooks.post('cook', function(eggs, bacon, callback) {
|
||||
execed.second = true;
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
callback();
|
||||
});
|
||||
|
||||
hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
|
||||
assert.ifError(error);
|
||||
assert.equal(2, Object.keys(execed).length);
|
||||
assert.ok(execed.first);
|
||||
assert.ok(execed.second);
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
done();
|
||||
});
|
||||
|
||||
hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
|
||||
assert.ifError(error);
|
||||
assert.equal(2, Object.keys(execed).length);
|
||||
assert.ok(execed.first);
|
||||
assert.ok(execed.second);
|
||||
assert.equal(1, eggs);
|
||||
assert.equal(2, bacon);
|
||||
});
|
||||
```
|
||||
|
||||
#### It supports returning a promise
|
||||
|
||||
You can also return a promise from your post hooks instead of calling
|
||||
`next()`. When the returned promise resolves, kareem will kick off the
|
||||
next middleware.
|
||||
|
||||
|
||||
```javascript
|
||||
hooks.post('cook', function(bacon) {
|
||||
return new Promise(resolve => {
|
||||
setTimeout(() => {
|
||||
this.bacon = 3;
|
||||
resolve();
|
||||
}, 100);
|
||||
});
|
||||
});
|
||||
|
||||
var obj = { bacon: 0 };
|
||||
|
||||
hooks.execPost('cook', obj, obj, function() {
|
||||
assert.equal(obj.bacon, 3);
|
||||
});
|
||||
```
|
||||
|
||||
## wrap()
|
||||
|
||||
acquit:ignore:end
|
||||
|
||||
#### It wraps pre and post calls into one call
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
this.bacon = 3;
|
||||
next();
|
||||
setTimeout(function() {
|
||||
done();
|
||||
}, 5);
|
||||
});
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
this.bacon = 3;
|
||||
next();
|
||||
setTimeout(function() {
|
||||
done();
|
||||
}, 5);
|
||||
});
|
||||
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
next();
|
||||
var _this = this;
|
||||
setTimeout(function() {
|
||||
_this.eggs = 4;
|
||||
done();
|
||||
}, 10);
|
||||
});
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
next();
|
||||
var _this = this;
|
||||
setTimeout(function() {
|
||||
_this.eggs = 4;
|
||||
done();
|
||||
}, 10);
|
||||
});
|
||||
|
||||
hooks.pre('cook', function(next) {
|
||||
this.waffles = false;
|
||||
next();
|
||||
});
|
||||
hooks.pre('cook', function(next) {
|
||||
this.waffles = false;
|
||||
next();
|
||||
});
|
||||
|
||||
hooks.post('cook', function(obj) {
|
||||
obj.tofu = 'no';
|
||||
});
|
||||
hooks.post('cook', function(obj) {
|
||||
obj.tofu = 'no';
|
||||
});
|
||||
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
|
||||
var args = [obj];
|
||||
args.push(function(error, result) {
|
||||
assert.ifError(error);
|
||||
assert.equal(null, error);
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal('no', obj.tofu);
|
||||
var args = [obj];
|
||||
args.push(function(error, result) {
|
||||
assert.ifError(error);
|
||||
assert.equal(null, error);
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal('no', obj.tofu);
|
||||
|
||||
assert.equal(obj, result);
|
||||
done();
|
||||
});
|
||||
assert.equal(obj, result);
|
||||
});
|
||||
|
||||
hooks.wrap(
|
||||
'cook',
|
||||
function(o, callback) {
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal(undefined, obj.tofu);
|
||||
callback(null, o);
|
||||
},
|
||||
obj,
|
||||
args);
|
||||
|
||||
hooks.wrap(
|
||||
'cook',
|
||||
function(o, callback) {
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal(undefined, obj.tofu);
|
||||
callback(null, o);
|
||||
},
|
||||
obj,
|
||||
args);
|
||||
```
|
||||
|
||||
## createWrapper()
|
||||
@@ -335,73 +332,70 @@ next middleware.
|
||||
#### It wraps wrap() into a callable function
|
||||
|
||||
```javascript
|
||||
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
this.bacon = 3;
|
||||
next();
|
||||
setTimeout(function() {
|
||||
done();
|
||||
}, 5);
|
||||
});
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
this.bacon = 3;
|
||||
next();
|
||||
setTimeout(function() {
|
||||
done();
|
||||
}, 5);
|
||||
});
|
||||
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
next();
|
||||
var _this = this;
|
||||
setTimeout(function() {
|
||||
_this.eggs = 4;
|
||||
done();
|
||||
}, 10);
|
||||
});
|
||||
hooks.pre('cook', true, function(next, done) {
|
||||
next();
|
||||
var _this = this;
|
||||
setTimeout(function() {
|
||||
_this.eggs = 4;
|
||||
done();
|
||||
}, 10);
|
||||
});
|
||||
|
||||
hooks.pre('cook', function(next) {
|
||||
this.waffles = false;
|
||||
next();
|
||||
});
|
||||
hooks.pre('cook', function(next) {
|
||||
this.waffles = false;
|
||||
next();
|
||||
});
|
||||
|
||||
hooks.post('cook', function(obj) {
|
||||
obj.tofu = 'no';
|
||||
});
|
||||
hooks.post('cook', function(obj) {
|
||||
obj.tofu = 'no';
|
||||
});
|
||||
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
var obj = { bacon: 0, eggs: 0 };
|
||||
|
||||
var cook = hooks.createWrapper(
|
||||
'cook',
|
||||
function(o, callback) {
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal(undefined, obj.tofu);
|
||||
callback(null, o);
|
||||
},
|
||||
obj);
|
||||
var cook = hooks.createWrapper(
|
||||
'cook',
|
||||
function(o, callback) {
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal(undefined, obj.tofu);
|
||||
callback(null, o);
|
||||
},
|
||||
obj);
|
||||
|
||||
cook(obj, function(error, result) {
|
||||
assert.ifError(error);
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal('no', obj.tofu);
|
||||
cook(obj, function(error, result) {
|
||||
assert.ifError(error);
|
||||
assert.equal(3, obj.bacon);
|
||||
assert.equal(4, obj.eggs);
|
||||
assert.equal(false, obj.waffles);
|
||||
assert.equal('no', obj.tofu);
|
||||
|
||||
assert.equal(obj, result);
|
||||
done();
|
||||
});
|
||||
|
||||
assert.equal(obj, result);
|
||||
});
|
||||
```
|
||||
|
||||
## clone()
|
||||
|
||||
acquit:ignore:end
|
||||
|
||||
#### It clones a Kareem object
|
||||
|
||||
```javascript
|
||||
|
||||
var k1 = new Kareem();
|
||||
k1.pre('cook', function() {});
|
||||
k1.post('cook', function() {});
|
||||
var k1 = new Kareem();
|
||||
k1.pre('cook', function() {});
|
||||
k1.post('cook', function() {});
|
||||
|
||||
var k2 = k1.clone();
|
||||
assert.deepEqual(['cook'], Object.keys(k2._pres));
|
||||
assert.deepEqual(['cook'], Object.keys(k2._posts));
|
||||
|
||||
var k2 = k1.clone();
|
||||
assert.deepEqual(Array.from(k2._pres.keys()), ['cook']);
|
||||
assert.deepEqual(Array.from(k2._posts.keys()), ['cook']);
|
||||
```
|
||||
|
||||
## merge()
|
||||
@@ -409,20 +403,18 @@ next middleware.
|
||||
#### It pulls hooks from another Kareem object
|
||||
|
||||
```javascript
|
||||
|
||||
var k1 = new Kareem();
|
||||
var test1 = function() {};
|
||||
k1.pre('cook', test1);
|
||||
k1.post('cook', function() {});
|
||||
var k1 = new Kareem();
|
||||
var test1 = function() {};
|
||||
k1.pre('cook', test1);
|
||||
k1.post('cook', function() {});
|
||||
|
||||
var k2 = new Kareem();
|
||||
var test2 = function() {};
|
||||
k2.pre('cook', test2);
|
||||
var k3 = k2.merge(k1);
|
||||
assert.equal(k3._pres['cook'].length, 2);
|
||||
assert.equal(k3._pres['cook'][0].fn, test2);
|
||||
assert.equal(k3._pres['cook'][1].fn, test1);
|
||||
assert.equal(k3._posts['cook'].length, 1);
|
||||
|
||||
var k2 = new Kareem();
|
||||
var test2 = function() {};
|
||||
k2.pre('cook', test2);
|
||||
var k3 = k2.merge(k1);
|
||||
assert.equal(k3._pres.get('cook').length, 2);
|
||||
assert.equal(k3._pres.get('cook')[0].fn, test2);
|
||||
assert.equal(k3._pres.get('cook')[1].fn, test1);
|
||||
assert.equal(k3._posts.get('cook').length, 1);
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user