From 91f6b6677b05af986089fcc7cc60976b95d726b9 Mon Sep 17 00:00:00 2001 From: darata <41451940+darata@users.noreply.github.com> Date: Mon, 10 Feb 2020 21:02:24 -0500 Subject: [PATCH] Upgrade dependencies (#5) * upgraded dependencies * fixed documentation * update build system --- .babelrc | 4 +- dist/middleware.js | 68 +- dist/middleware.min.js | 2 +- docs/API.md | 56 +- docs/html/MiddlewareManager.html | 478 +- .../MiddlewareManager_MiddlewareManager.html | 439 + docs/html/classes.list.html | 8 +- docs/html/global.html | 6 +- docs/html/index.html | 116 +- docs/html/quicksearch.html | 2 +- gulp-tasks/build.js | 51 - gulp-tasks/clean.js | 15 - gulp-tasks/default.js | 12 - gulp-tasks/docs.js | 22 - gulp-tasks/lint.js | 11 - gulp-tasks/server.js | 19 - gulp-tasks/test.js | 11 - gulpfile.js | 27 - gulpfile.js/build.js | 37 + gulpfile.js/clean.js | 21 + gulpfile.js/docs.js | 30 + gulpfile.js/index.js | 12 + gulpfile.js/lint.js | 14 + gulpfile.js/rebuild.js | 11 + gulpfile.js/server.js | 30 + gulpfile.js/test.js | 13 + lib/Middleware.js | 2 + package-lock.json | 11233 ++++++++++++++++ package.json | 61 +- 29 files changed, 12033 insertions(+), 778 deletions(-) create mode 100644 docs/html/MiddlewareManager_MiddlewareManager.html delete mode 100644 gulp-tasks/build.js delete mode 100644 gulp-tasks/clean.js delete mode 100644 gulp-tasks/default.js delete mode 100644 gulp-tasks/docs.js delete mode 100644 gulp-tasks/lint.js delete mode 100644 gulp-tasks/server.js delete mode 100644 gulp-tasks/test.js delete mode 100644 gulpfile.js create mode 100644 gulpfile.js/build.js create mode 100644 gulpfile.js/clean.js create mode 100644 gulpfile.js/docs.js create mode 100644 gulpfile.js/index.js create mode 100644 gulpfile.js/lint.js create mode 100644 gulpfile.js/rebuild.js create mode 100644 gulpfile.js/server.js create mode 100644 gulpfile.js/test.js create mode 100644 package-lock.json diff --git a/.babelrc b/.babelrc index 01bbc3d..7d25832 100644 --- a/.babelrc +++ b/.babelrc @@ -1,8 +1,8 @@ { "presets": [ - "env" + "@babel/preset-env" ], "plugins": [ - "transform-class-properties" + "@babel/plugin-proposal-class-properties" ] } diff --git a/dist/middleware.js b/dist/middleware.js index 89e2c97..2de5f07 100644 --- a/dist/middleware.js +++ b/dist/middleware.js @@ -1,22 +1,29 @@ -(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.jsMiddleware = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o f(g(h(...args))). */ + function compose() { - for (var _len = arguments.length, funcs = Array(_len), _key = 0; _key < _len; _key++) { + for (var _len = arguments.length, funcs = new Array(_len), _key = 0; _key < _len; _key++) { funcs[_key] = arguments[_key]; } @@ -51,11 +59,12 @@ function compose() { return function () { return rest.reduceRight(function (composed, f) { return f(composed); - }, last.apply(undefined, arguments)); + }, last.apply(void 0, arguments)); }; } - /** + * @class MiddlewareManager + * @classdesc * Manage middlewares for an object. * Middleware functions are functions that have access to the target function and it's arguments, * and the target object and the next middleware function in the target function cycle. @@ -199,7 +208,10 @@ function compose() { * */ -var MiddlewareManager = exports.MiddlewareManager = function () { + +var MiddlewareManager = +/*#__PURE__*/ +function () { /** * @param {object} target The target object. * @param {...object} middlewareObjects Middleware objects. @@ -212,8 +224,8 @@ var MiddlewareManager = exports.MiddlewareManager = function () { var instance = middlewareManagerHash.find(function (key) { return key._target === target; - }); - // a target can only has one MiddlewareManager instance + }); // a target can only has one MiddlewareManager instance + if (instance === undefined) { this._target = target; this._methods = {}; @@ -222,51 +234,48 @@ var MiddlewareManager = exports.MiddlewareManager = function () { instance = this; } - for (var _len2 = arguments.length, middlewareObjects = Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) { + for (var _len2 = arguments.length, middlewareObjects = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) { middlewareObjects[_key2 - 1] = arguments[_key2]; } (_instance = instance).use.apply(_instance, middlewareObjects); return instance; - } - - // Function's name start or end with "_" will not be able to apply middleware. + } // Function's name start or end with "_" will not be able to apply middleware. _createClass(MiddlewareManager, [{ - key: '_methodIsValid', + key: "_methodIsValid", value: function _methodIsValid(methodName) { return !/^_+|_+$|constructor/g.test(methodName); - } - - // Apply middleware to method + } // Apply middleware to method }, { - key: '_applyToMethod', + key: "_applyToMethod", value: function _applyToMethod(methodName) { var _this = this; if (typeof methodName === 'string' && this._methodIsValid(methodName)) { var method = this._methods[methodName] || this._target[methodName]; + if (typeof method === 'function') { this._methods[methodName] = method; + if (this._methodMiddlewares[methodName] === undefined) { this._methodMiddlewares[methodName] = []; } - for (var _len3 = arguments.length, middlewares = Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) { + for (var _len3 = arguments.length, middlewares = new Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) { middlewares[_key3 - 1] = arguments[_key3]; } middlewares.forEach(function (middleware) { return typeof middleware === 'function' && _this._methodMiddlewares[methodName].push(middleware(_this._target)); }); - this._target[methodName] = compose.apply(undefined, _toConsumableArray(this._methodMiddlewares[methodName]))(method.bind(this._target)); + this._target[methodName] = compose.apply(void 0, _toConsumableArray(this._methodMiddlewares[methodName]))(method.bind(this._target)); } } } - /** * Apply (register) middleware functions to the target function or apply (register) middleware objects. * If the first argument is a middleware object, the rest arguments must be middleware objects. @@ -277,20 +286,20 @@ var MiddlewareManager = exports.MiddlewareManager = function () { */ }, { - key: 'use', + key: "use", value: function use(methodName) { var _this2 = this; - for (var _len4 = arguments.length, middlewares = Array(_len4 > 1 ? _len4 - 1 : 0), _key4 = 1; _key4 < _len4; _key4++) { + for (var _len4 = arguments.length, middlewares = new Array(_len4 > 1 ? _len4 - 1 : 0), _key4 = 1; _key4 < _len4; _key4++) { middlewares[_key4 - 1] = arguments[_key4]; } - if ((typeof methodName === 'undefined' ? 'undefined' : _typeof(methodName)) === 'object') { + if (_typeof(methodName) === 'object') { Array.prototype.slice.call(arguments).forEach(function (arg) { // A middleware object can specify target functions within middlewareMethods (Array). // e.g. obj.middlewareMethods = ['method1', 'method2']; // only method1 and method2 will be the target function. - (typeof arg === 'undefined' ? 'undefined' : _typeof(arg)) === 'object' && (arg.middlewareMethods || (Object.keys(arg).length ? Object.keys(arg) : Object.getOwnPropertyNames(Object.getPrototypeOf(arg)))).forEach(function (key) { + _typeof(arg) === 'object' && (arg.middlewareMethods || (Object.keys(arg).length ? Object.keys(arg) : Object.getOwnPropertyNames(Object.getPrototypeOf(arg)))).forEach(function (key) { typeof arg[key] === 'function' && _this2._methodIsValid(key) && _this2._applyToMethod(key, arg[key].bind(arg)); }); }); @@ -305,10 +314,11 @@ var MiddlewareManager = exports.MiddlewareManager = function () { return MiddlewareManager; }(); +exports.MiddlewareManager = MiddlewareManager; + if (typeof window !== 'undefined') { window['MiddlewareManager'] = MiddlewareManager; } },{}]},{},[1])(1) }); -//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["node_modules/browser-pack/_prelude.js","lib/Middleware.js"],"names":[],"mappings":"AAAA;ACAA;;;;;;;;;;QAagB,O,GAAA,O;;;;;;AAZhB,IAAI,wBAAwB,EAA5B;;AAEA;;;;;;;;;;AAUO,SAAS,OAAT,GAA2B;AAAA,oCAAP,KAAO;AAAP,SAAO;AAAA;;AAChC,MAAI,MAAM,MAAN,KAAiB,CAArB,EAAwB;AACtB,WAAO;AAAA,aAAO,GAAP;AAAA,KAAP;AACD;;AAED,UAAQ,MAAM,MAAN,CAAa;AAAA,WAAQ,OAAO,IAAP,KAAgB,UAAxB;AAAA,GAAb,CAAR;;AAEA,MAAI,MAAM,MAAN,KAAiB,CAArB,EAAwB;AACtB,WAAO,MAAM,CAAN,CAAP;AACD;;AAED,MAAM,OAAO,MAAM,MAAM,MAAN,GAAe,CAArB,CAAb;AACA,MAAM,OAAO,MAAM,KAAN,CAAY,CAAZ,EAAe,CAAC,CAAhB,CAAb;AACA,SAAO;AAAA,WAAa,KAAK,WAAL,CAAiB,UAAC,QAAD,EAAW,CAAX;AAAA,aAAiB,EAAE,QAAF,CAAjB;AAAA,KAAjB,EAA+C,gCAA/C,CAAb;AAAA,GAAP;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+Ia,iB,WAAA,iB;AACX;;;;;AAKA,6BAAY,MAAZ,EAA0C;AAAA;;AAAA;;AACxC,QAAI,WAAW,sBAAsB,IAAtB,CAA2B,UAAU,GAAV,EAAe;AACvD,aAAO,IAAI,OAAJ,KAAgB,MAAvB;AACD,KAFc,CAAf;AAGA;AACA,QAAI,aAAa,SAAjB,EAA4B;AAC1B,WAAK,OAAL,GAAe,MAAf;AACA,WAAK,QAAL,GAAgB,EAAhB;AACA,WAAK,kBAAL,GAA0B,EAA1B;AACA,4BAAsB,IAAtB,CAA2B,IAA3B;AACA,iBAAW,IAAX;AACD;;AAXuC,uCAAnB,iBAAmB;AAAnB,uBAAmB;AAAA;;AAYxC,2BAAS,GAAT,kBAAgB,iBAAhB;;AAEA,WAAO,QAAP;AACD;;AAED;;;;;mCACe,U,EAAY;AACzB,aAAO,CAAC,uBAAuB,IAAvB,CAA4B,UAA5B,CAAR;AACD;;AAED;;;;mCACe,U,EAA4B;AAAA;;AACzC,UAAI,OAAO,UAAP,KAAsB,QAAtB,IAAkC,KAAK,cAAL,CAAoB,UAApB,CAAtC,EAAuE;AACrE,YAAI,SAAS,KAAK,QAAL,CAAc,UAAd,KAA6B,KAAK,OAAL,CAAa,UAAb,CAA1C;AACA,YAAI,OAAO,MAAP,KAAkB,UAAtB,EAAkC;AAChC,eAAK,QAAL,CAAc,UAAd,IAA4B,MAA5B;AACA,cAAI,KAAK,kBAAL,CAAwB,UAAxB,MAAwC,SAA5C,EAAuD;AACrD,iBAAK,kBAAL,CAAwB,UAAxB,IAAsC,EAAtC;AACD;;AAJ+B,6CAHR,WAGQ;AAHR,uBAGQ;AAAA;;AAKhC,sBAAY,OAAZ,CAAoB;AAAA,mBAClB,OAAO,UAAP,KAAsB,UAAtB,IAAoC,MAAK,kBAAL,CAAwB,UAAxB,EAAoC,IAApC,CAAyC,WAAW,MAAK,OAAhB,CAAzC,CADlB;AAAA,WAApB;AAGA,eAAK,OAAL,CAAa,UAAb,IAA2B,4CAAW,KAAK,kBAAL,CAAwB,UAAxB,CAAX,GAAgD,OAAO,IAAP,CAAY,KAAK,OAAjB,CAAhD,CAA3B;AACD;AACF;AACF;;AAED;;;;;;;;;;;wBAQI,U,EAA4B;AAAA;;AAAA,yCAAb,WAAa;AAAb,mBAAa;AAAA;;AAC9B,UAAI,QAAO,UAAP,yCAAO,UAAP,OAAsB,QAA1B,EAAoC;AAClC,cAAM,SAAN,CAAgB,KAAhB,CAAsB,IAAtB,CAA2B,SAA3B,EAAsC,OAAtC,CAA8C,eAAO;AACnD;AACA;AACA;AACA,kBAAO,GAAP,yCAAO,GAAP,OAAe,QAAf,IACA,CAAC,IAAI,iBAAJ,KACA,OAAO,IAAP,CAAY,GAAZ,EAAiB,MAAjB,GAA0B,OAAO,IAAP,CAAY,GAAZ,CAA1B,GAA6C,OAAO,mBAAP,CAA2B,OAAO,cAAP,CAAsB,GAAtB,CAA3B,CAD7C,CAAD,EAEE,OAFF,CAEU,eAAO;AACf,mBAAO,IAAI,GAAJ,CAAP,KAAoB,UAApB,IAAkC,OAAK,cAAL,CAAoB,GAApB,CAAlC,IAA8D,OAAK,cAAL,CAAoB,GAApB,EAAyB,IAAI,GAAJ,EAAS,IAAT,CAAc,GAAd,CAAzB,CAA9D;AACD,WAJD,CADA;AAMD,SAVD;AAWD,OAZD,MAYO;AACL,aAAK,cAAL,cAAoB,UAApB,SAAmC,WAAnC;AACD;;AAED,aAAO,IAAP;AACD;;;;;;AAGH,IAAI,OAAO,MAAP,KAAkB,WAAtB,EAAmC;AACjC,SAAO,mBAAP,IAA8B,iBAA9B;AACD","file":"generated.js","sourceRoot":"","sourcesContent":["(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require==\"function\"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error(\"Cannot find module '\"+o+\"'\");throw f.code=\"MODULE_NOT_FOUND\",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require==\"function\"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})","'use strict';\nlet middlewareManagerHash = [];\n\n/**\n * Composes single-argument functions from right to left. The rightmost\n * function can take multiple arguments as it provides the signature for\n * the resulting composite function.\n *\n * @param {...Function} funcs The functions to compose.\n * @returns {Function} A function obtained by composing the argument functions\n * from right to left. For example, compose(f, g, h) is identical to doing\n * (...args) => f(g(h(...args))).\n */\nexport function compose(...funcs) {\n  if (funcs.length === 0) {\n    return arg => arg;\n  }\n\n  funcs = funcs.filter(func => typeof func === 'function');\n\n  if (funcs.length === 1) {\n    return funcs[0];\n  }\n\n  const last = funcs[funcs.length - 1];\n  const rest = funcs.slice(0, -1);\n  return (...args) => rest.reduceRight((composed, f) => f(composed), last(...args));\n}\n\n/**\n * Manage middlewares for an object.\n * Middleware functions are functions that have access to the target function and it's arguments,\n * and the target object and the next middleware function in the target function cycle.\n * The next middleware function is commonly denoted by a variable named next.\n *\n * Middleware functions can perform the following tasks:\n *  - Execute any code.\n *  - Make changes to the function's arguments.\n *  - End the target function.\n *  - Call the next middleware in the stack.\n *\n * If the current middleware function does not end the target function cycle,\n * it must call next() to pass control to the next middleware function. Otherwise,\n * the target function will be left hanging.\n *\n * e.g.\n *  ```\n *  const walk = target => next => (...args) => {\n *     this.log(`walk function start.`);\n *     const result = next(...args);\n *     this.log(`walk function end.`);\n *     return result;\n *   }\n *  ```\n *\n * Middleware object is an object that contains function's name as same as the target object's function name.\n *\n * e.g.\n *  ```\n *  const Logger = {\n *      walk: target => next => (...args) => {\n *        console.log(`walk function start.`);\n *        const result = next(...args);\n *        console.log(`walk function end.`);\n *        return result;\n *      }\n *   }\n *  ```\n *\n * Function's name start or end with \"_\" will not be able to apply middleware.\n *\n * @example\n *\n * ## Basic\n *\n * We define a Person class.\n * // the target object\n * class Person {\n *   // the target function\n *   walk(step) {\n *     this.step = step;\n *   }\n *\n *   speak(word) {\n *     this.word = word;\n *   }\n * }\n *\n * Then we define a middleware function to print log.\n *\n * // middleware for walk function\n * const logger = target => next => (...args) => {\n *   console.log(`walk start, steps: ${args[0]}.`);\n *   const result = next(...args);\n *   console.log(`walk end.`);\n *   return result;\n * }\n *\n * Now we apply the log function as a middleware to a Person instance.\n *\n * // apply middleware to target object\n * const p = new Person();\n * const middlewareManager = new MiddlewareManager(p);\n * middlewareManager.use('walk', logger);\n * p.walk(3);\n *\n * Whenever a Person instance call it's walk method, we'll see logs from the looger middleware.\n *\n * ## Middleware object\n * We can also apply a middleware object to a target object.\n * Middleware object is an object that contains function's name as same as the target object's function name.\n *\n * const PersonMiddleware = {\n *   walk: target => next => step => {\n *     console.log(`walk start, steps: step.`);\n *     const result = next(step);\n *     console.log(`walk end.`);\n *     return result;\n *   },\n *   speak: target => next => word => {\n *     word = 'this is a middleware trying to say: ' + word;\n *     return next(word);\n *   }\n * }\n *\n * // apply middleware to target object\n * const p = new Person();\n * const middlewareManager = new MiddlewareManager(p);\n * middlewareManager.use(PersonMiddleware);\n * p.walk(3);\n * p.speak('hi');\n *\n * ## middlewareMethods\n * In a class, function's name start or end with \"_\" will not be able to apply as middleware.\n * Or we can use `middlewareMethods` to define function names for middleware target within a class.\n *\n * class PersonMiddleware {\n *   constructor() {\n *     // Or Define function names for middleware target.\n *     this.middlewareMethods = ['walk', 'speak'];\n *   }\n *   // Function's name start or end with \"_\" will not be able to apply as middleware.\n *   _getPrefix() {\n *     return 'Middleware log: ';\n *   }\n *   log(text) {\n *     console.log(this._getPrefix() + text);\n *   }\n *   walk(target) {\n *     return next => step => {\n *       this.log(`walk start, steps: step.`);\n *       const result = next(step);\n *       this.log(`walk end.`);\n *       return result;\n *     }\n *   }\n *   speak(target) {\n *     return next => word => {\n *       this.log('this is a middleware trying to say: ' + word);\n *       return next(word);\n *     }\n *   }\n * }\n *\n * // apply middleware to target object\n * const p = new Person();\n * const middlewareManager = new MiddlewareManager(p);\n * middlewareManager.use(new PersonMiddleware())\n * p.walk(3);\n * p.speak('hi');\n *\n */\nexport class MiddlewareManager {\n  /**\n   * @param {object} target The target object.\n   * @param {...object} middlewareObjects Middleware objects.\n   * @return {object} this\n   */\n  constructor(target, ...middlewareObjects) {\n    let instance = middlewareManagerHash.find(function (key) {\n      return key._target === target;\n    });\n    // a target can only has one MiddlewareManager instance\n    if (instance === undefined) {\n      this._target = target;\n      this._methods = {};\n      this._methodMiddlewares = {};\n      middlewareManagerHash.push(this);\n      instance = this;\n    }\n    instance.use(...middlewareObjects);\n\n    return instance;\n  }\n\n  // Function's name start or end with \"_\" will not be able to apply middleware.\n  _methodIsValid(methodName) {\n    return !/^_+|_+$|constructor/g.test(methodName);\n  }\n\n  // Apply middleware to method\n  _applyToMethod(methodName, ...middlewares) {\n    if (typeof methodName === 'string' && this._methodIsValid(methodName)) {\n      let method = this._methods[methodName] || this._target[methodName];\n      if (typeof method === 'function') {\n        this._methods[methodName] = method;\n        if (this._methodMiddlewares[methodName] === undefined) {\n          this._methodMiddlewares[methodName] = [];\n        }\n        middlewares.forEach(middleware =>\n          typeof middleware === 'function' && this._methodMiddlewares[methodName].push(middleware(this._target))\n        );\n        this._target[methodName] = compose(...this._methodMiddlewares[methodName])(method.bind(this._target));\n      }\n    }\n  }\n\n  /**\n   * Apply (register) middleware functions to the target function or apply (register) middleware objects.\n   * If the first argument is a middleware object, the rest arguments must be middleware objects.\n   *\n   * @param {string|object} methodName String for target function name, object for a middleware object.\n   * @param {...function|...object} middlewares The middleware chain to be applied.\n   * @return {object} this\n   */\n  use(methodName, ...middlewares) {\n    if (typeof methodName === 'object') {\n      Array.prototype.slice.call(arguments).forEach(arg => {\n        // A middleware object can specify target functions within middlewareMethods (Array).\n        // e.g. obj.middlewareMethods = ['method1', 'method2'];\n        // only method1 and method2 will be the target function.\n        typeof arg === 'object' &&\n        (arg.middlewareMethods ||\n        (Object.keys(arg).length ? Object.keys(arg) : Object.getOwnPropertyNames(Object.getPrototypeOf(arg)))\n        ).forEach(key => {\n          typeof arg[key] === 'function' && this._methodIsValid(key) && this._applyToMethod(key, arg[key].bind(arg));\n        });\n      });\n    } else {\n      this._applyToMethod(methodName, ...middlewares);\n    }\n\n    return this;\n  }\n}\n\nif (typeof window !== 'undefined') {\n  window['MiddlewareManager'] = MiddlewareManager;\n}\n"]} diff --git a/dist/middleware.min.js b/dist/middleware.min.js index 72c929d..a76f894 100644 --- a/dist/middleware.min.js +++ b/dist/middleware.min.js @@ -1 +1 @@ -!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var t;t="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,t.jsMiddleware=e()}}(function(){return function e(t,r,n){function o(f,u){if(!r[f]){if(!t[f]){var a="function"==typeof require&&require;if(!u&&a)return a(f,!0);if(i)return i(f,!0);var d=new Error("Cannot find module '"+f+"'");throw d.code="MODULE_NOT_FOUND",d}var l=r[f]={exports:{}};t[f][0].call(l.exports,function(e){var r=t[f][1][e];return o(r||e)},l,l.exports,e,t,r,n)}return r[f].exports}for(var i="function"==typeof require&&require,f=0;f1?i-1:0),u=1;u1?o-1:0),u=1;u1?r-1:0),o=1;o const result = next(...args); this.log(`walk function end.`); return result; - } -

Middleware object is an object that contains function's name as same as the target object's function name.

+ }

Middleware object is an object that contains function's name as same as the target object's function name.

e.g.

 const Logger = {
      walk: target => next => (...args) => {
@@ -32,11 +31,8 @@ the target function will be left hanging.

        console.log(`walk function end.`);
        return result;
      }
-  }
-

Function's name start or end with "_" will not be able to apply middleware.

+ }

Function's name start or end with "_" will not be able to apply middleware.

-
MiddlewareManager
-
## Functions @@ -96,45 +92,17 @@ Function's name start or end with "_" will not be able to apply middleware. **Kind**: global class * [MiddlewareManager](#MiddlewareManager) - * [new MiddlewareManager(target, ...middlewareObjects)](#new_MiddlewareManager_new) + * [.MiddlewareManager](#MiddlewareManager+MiddlewareManager) + * [new exports.MiddlewareManager(target, ...middlewareObjects)](#new_MiddlewareManager+MiddlewareManager_new) * [.use(methodName, ...middlewares)](#MiddlewareManager+use) ⇒ object - - -### new MiddlewareManager(target, ...middlewareObjects) -**Returns**: object - this - -| Param | Type | Description | -| --- | --- | --- | -| target | object | The target object. | -| ...middlewareObjects | object | Middleware objects. | - - - -### middlewareManager.use(methodName, ...middlewares) ⇒ object -Apply (register) middleware functions to the target function or apply (register) middleware objects. -If the first argument is a middleware object, the rest arguments must be middleware objects. - -**Kind**: instance method of [MiddlewareManager](#MiddlewareManager) -**Returns**: object - this - -| Param | Type | Description | -| --- | --- | --- | -| methodName | string | object | String for target function name, object for a middleware object. | -| ...middlewares | function | object | The middleware chain to be applied. | - - - -## MiddlewareManager -**Kind**: global class - -* [MiddlewareManager](#MiddlewareManager) - * [new MiddlewareManager(target, ...middlewareObjects)](#new_MiddlewareManager_new) - * [.use(methodName, ...middlewares)](#MiddlewareManager+use) ⇒ object + - +### middlewareManager.MiddlewareManager +**Kind**: instance class of [MiddlewareManager](#MiddlewareManager) + -### new MiddlewareManager(target, ...middlewareObjects) +#### new exports.MiddlewareManager(target, ...middlewareObjects) **Returns**: object - this | Param | Type | Description | @@ -148,13 +116,13 @@ If the first argument is a middleware object, the rest arguments must be middlew Apply (register) middleware functions to the target function or apply (register) middleware objects. If the first argument is a middleware object, the rest arguments must be middleware objects. -**Kind**: instance method of [MiddlewareManager](#MiddlewareManager) +**Kind**: instance method of [MiddlewareManager](#MiddlewareManager) **Returns**: object - this | Param | Type | Description | | --- | --- | --- | -| methodName | string | object | String for target function name, object for a middleware object. | -| ...middlewares | function | object | The middleware chain to be applied. | +| methodName | string \| object | String for target function name, object for a middleware object. | +| ...middlewares | function \| object | The middleware chain to be applied. | diff --git a/docs/html/MiddlewareManager.html b/docs/html/MiddlewareManager.html index ac85a12..a593927 100644 --- a/docs/html/MiddlewareManager.html +++ b/docs/html/MiddlewareManager.html @@ -33,7 +33,7 @@
  • Classes
    • @@ -96,21 +96,25 @@

    it must call next() to pass control to the next middleware function. Otherwise, the target function will be left hanging.

    e.g.

    -
     const walk = target => next => (...args) => {
-    this.log(`walk function start.`);
-    const result = next(...args);
-    this.log(`walk function end.`);
-    return result;
-  }

    Middleware object is an object that contains function's name as same as the target object's function name.

    +
    const walk = target => next => (...args) => {
+   this.log(`walk function start.`);
+   const result = next(...args);
+   this.log(`walk function end.`);
+   return result;
+ }
+
    +

    Middleware object is an object that contains function's name as same as the target object's function name.

    e.g.

    -
     const Logger = {
-     walk: target => next => (...args) => {
-       console.log(`walk function start.`);
-       const result = next(...args);
-       console.log(`walk function end.`);
-       return result;
-     }
-  }

    Function's name start or end with "_" will not be able to apply middleware.

    +
    const Logger = {
+    walk: target => next => (...args) => {
+      console.log(`walk function start.`);
+      const result = next(...args);
+      console.log(`walk function end.`);
+      return result;
+    }
+ }
+
    +

    Function's name start or end with "_" will not be able to apply middleware.

    @@ -302,451 +306,17 @@

    Example
    - - - - - - - - -

    Methods

    +

    Classes

    - -
    -
    -

    use(methodName, middlewares)

    - - -
    -
    - - -
    -

    Apply (register) middleware functions to the target function or apply (register) middleware objects. -If the first argument is a middleware object, the rest arguments must be middleware objects.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeArgumentDescription
    methodName - - -string -| - -object - - - - - - - - - - -

    String for target function name, object for a middleware object.

    middlewares - - -function -| - -object - - - - - - - - - - - <repeatable>
    - -

    The middleware chain to be applied.

    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - -
    Returns:
    - - -
    -

    this

    -
    - - - -
    -
    - Type -
    -
    - -object - - - -
    -
    - - - - - -
    - +
    MiddlewareManager
    +
    - - - - - - - -

    Class: MiddlewareManager

    -
    - -
    - -

    - MiddlewareManager -

    - - -
    - - -
    -
    - - -
    -
    -

    new MiddlewareManager(target, middlewareObjects)

    - - -
    -
    - - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeArgumentDescription
    target - - -object - - - - - - - - - - -

    The target object.

    middlewareObjects - - -object - - - - - - - - - - - <repeatable>
    - -

    Middleware objects.

    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - -
    Returns:
    - - -
    -

    this

    -
    - - - -
    -
    - Type -
    -
    - -object - - - -
    -
    - - - - - -
    - - -
    - - - - - - - - - - @@ -1004,9 +574,9 @@

    Search results

    - Documentation generated by JSDoc 3.4.3 + Documentation generated by JSDoc 3.6.3 - on 2017-06-21 + on 2020-02-10 using the DocStrap template. diff --git a/docs/html/MiddlewareManager_MiddlewareManager.html b/docs/html/MiddlewareManager_MiddlewareManager.html new file mode 100644 index 0000000..bdb7f3d --- /dev/null +++ b/docs/html/MiddlewareManager_MiddlewareManager.html @@ -0,0 +1,439 @@ + + + + + + + Codestin Search App + + + + + + + + + + +
    +
    +
    + js-middleware + +
    + + +
    +
    + + +
    +
    + + +
    + +
    + + +

    Class: MiddlewareManager

    +
    + +
    + +

    + MiddlewareManager# + + MiddlewareManager +

    + + +
    + + +
    +
    + + +
    +
    +

    new MiddlewareManager(target, middlewareObjects)

    + + +
    +
    + + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeArgumentDescription
    target + + +object + + + + + + + + + + +

    The target object.

    middlewareObjects + + +object + + + + + + + + + + + <repeatable>
    + +

    Middleware objects.

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + +
    Returns:
    + + +
    +

    this

    +
    + + + +
    +
    + Type +
    +
    + +object + + + +
    +
    + + + + + +
    + + +
    + + + + + + + + + + + + + + + + + + +
    + +
    + + + + +
    +
    + +
    + + +
    + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/html/classes.list.html b/docs/html/classes.list.html index 6695454..bc433da 100644 --- a/docs/html/classes.list.html +++ b/docs/html/classes.list.html @@ -33,7 +33,7 @@
  • Classes
    • @@ -145,7 +145,7 @@

    Classes

    MiddlewareManager
    -
    MiddlewareManager
    +
    MiddlewareManager
    @@ -203,9 +203,9 @@

    Search results

    - Documentation generated by JSDoc 3.4.3 + Documentation generated by JSDoc 3.6.3 - on 2017-06-21 + on 2020-02-10 using the DocStrap template. diff --git a/docs/html/global.html b/docs/html/global.html index f8d253e..192c0ec 100644 --- a/docs/html/global.html +++ b/docs/html/global.html @@ -33,7 +33,7 @@
  • Classes
    • @@ -365,9 +365,9 @@

    Search results

    - Documentation generated by JSDoc 3.4.3 + Documentation generated by JSDoc 3.6.3 - on 2017-06-21 + on 2020-02-10 using the DocStrap template. diff --git a/docs/html/index.html b/docs/html/index.html index 96fd4d2..db7c1ff 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -33,7 +33,7 @@
  • Classes
    • @@ -93,14 +93,17 @@
    -

    js-middleware

    Powerful Javascript Middleware Pattern implementation, apply middleweares to any object. +

    js-middleware

    +

    Powerful Javascript Middleware Pattern implementation, apply middleweares to any object. A painless solution to make codes as scalable and maintainable as ReduxJS and ExpressJS.

    -

    Links

      +

      Links

      + -

      Overview

      Middleware functions are functions that have access to the target function and it's arguments, +

      Overview

      +

      Middleware functions are functions that have access to the target function and it's arguments, and the target object and the next middleware function in the target function cycle. The next middleware function is commonly denoted by a variable named next.

      Middleware functions can perform the following tasks:

      @@ -108,42 +111,60 @@

      Overview

      Middleware functions are functions that have access to the t

    • Execute any code.
    • Make changes to the function's arguments.
    • End the target function.
      • -

    • Call the next middleware in the stack.

      +
    • Call the next middleware in the stack.
      • +

    If the current middleware function does not end the target function cycle, it must call next() to pass control to the next middleware function. Otherwise, the target function will be left hanging.

    - - -

    Get started

      +

      Get started

      +
      1. window.MiddlewareManager is available for browsers by include -dist/middleware.min.js file in your HTML.
        <script src="middleware.min.js"></script>
        2. -
      2. Or install the package
        npm install --save js-middleware
        and import it in your files
        import {MiddlewareManager} from 'js-middleware';
        3. +dist/middleware.min.js file in your HTML. +
      +
        <script src="middleware.min.js"></script>
+
      +
        +
      1. Or install the package
      -

      Usages

      Basic

      We define a Person class.

      +
      npm install --save js-middleware
+
      +

      and import it in your files

      +
      import {MiddlewareManager} from 'js-middleware';
+
      +

      Usages

      +

      Basic

      +

      We define a Person class.

      // the target object
 class Person {
   // the target function
   walk(step) {
     this.step = step;
   }
-
+  
   speak(word) {
     this.word = word;
   }
- }

      Then we define a middleware function to print log.

      + } + +

      Then we define a middleware function to print log.

       // middleware for walk function
  const logger = target => next => (...args) => {
     console.log(`walk start, steps: ${args[0]}.`);
     const result = next(...args);
     console.log(`walk end.`);
     return result;
-  }

      Now we apply the log function as a middleware to a Person instance.

      + } + +

      Now we apply the log function as a middleware to a Person instance.

       // apply middleware to target object
  const p = new Person();
  const middlewareManager = new MiddlewareManager(p);
  middlewareManager.use('walk', logger);
- p.walk(3);

      Whenever a Person instance call it's walk method, we'll see logs from the looger middleware.

      -

      Middleware object

      We can also apply a middleware object to a target object. Middleware object is an object that contains function's name as same as the target object's function name. + p.walk(3); + +

      Whenever a Person instance call it's walk method, we'll see logs from the looger middleware.

      +

      Middleware object

      +

      We can also apply a middleware object to a target object. Middleware object is an object that contains function's name as same as the target object's function name. Function's name start or end with "_" will not be able to apply middleware.

      const PersonMiddleware = {
   walk: target => next => step => {
@@ -163,7 +184,10 @@ 
      Middleware object
      We can also apply a middleware object to a target o
  const middlewareManager = new MiddlewareManager(p);
  middlewareManager.use(PersonMiddleware);
  p.walk(3);
- p.speak('hi');

      middlewareMethods

      In a class, function's name start or end with "_" will not be able to apply as middleware. + p.speak('hi'); + +

      middlewareMethods

      +

      In a class, function's name start or end with "_" will not be able to apply as middleware. Or we can use middlewareMethods to define function names for middleware target within a class.

      class PersonMiddleware {
   constructor() {
@@ -201,40 +225,52 @@ 
      Middleware object
      We can also apply a middleware object to a target o
  const middlewareManager = new MiddlewareManager(p);
  middlewareManager.use(new PersonMiddleware())
  p.walk(3);
- p.speak('hi');

      APIs

      .use(methodName, ...middlewares)

      Apply (register) middleware functions to the target function or apply (register) middleware objects. + p.speak('hi'); + +

      APIs

      +

      .use(methodName, ...middlewares)

      +

      Apply (register) middleware functions to the target function or apply (register) middleware objects. If the first argument is a middleware object, the rest arguments must be middleware objects.

      • {string|object} methodName String for target function name, object for a middleware object.
      • {...function} middlewares The middleware chain to be applied.
      • return {object} this
      -

      Build

        -

      1. Run npm install to install requirements.

        +

        Build

        +
          +
        1. +

          Run npm install to install requirements.

          2. -

        2. Run gulp to builds the library, generates dist/middleware.js as the core script, watches for file changes, +

        3. +

          Run gulp to builds the library, generates dist/middleware.js as the core script, watches for file changes, starts a HTTP server for debug.

          +
          4. +
        Usage
- gulp [TASK] [OPTIONS...]
+  gulp [TASK] [OPTIONS...]
 
 Available tasks
- build       Builds the library.
- clean       Cleans files.
- clean:dist  Cleans dist files.
- clean:docs  Cleans docs files.
- default    
- docs        Builds documentation.
- docs:html   Builds HTML documentation.
- docs:md     Builds markdown documentation.
- help        Display this help text.
- lint        Lint JS files.
- mini        Minify the library.
- server      Starts a HTTP server for debug.
- test        Run test cases.
- watch       Watches for changes in files, re-lint, re-build & re-docs.
        2. -
      2. Run gulp docs to build docs. View markdown docs with docs/API.md, or run gulp server to start a HTTP server + build Builds the library. + clean Cleans files. + clean:dist Cleans dist files. + clean:docs Cleans docs files. + default + docs Builds documentation. + docs:html Builds HTML documentation. + docs:md Builds markdown documentation. + help Display this help text. + lint Lint JS files. + mini Minify the library. + server Starts a HTTP server for debug. + test Run test cases. + watch Watches for changes in files, re-lint, re-build & re-docs. + +
          +
        1. Run gulp docs to build docs. View markdown docs with docs/API.md, or run gulp server to start a HTTP server and view HTML docs with localhost:3000/docs/html/.
        -

        Roadmap & Make contributions

          +

          Roadmap & Make contributions

          +
          • Supports RegExp to match method names, pass the current method name as param to the current middleware.
          • once(methodName, ...middlewares) Apply middlewares only run once.
          • Be able to unuse middlewares.
            • @@ -282,9 +318,9 @@

            Search results

            - Documentation generated by JSDoc 3.4.3 + Documentation generated by JSDoc 3.6.3 - on 2017-06-21 + on 2020-02-10 using the DocStrap template. diff --git a/docs/html/quicksearch.html b/docs/html/quicksearch.html index 204fd74..54586f8 100644 --- a/docs/html/quicksearch.html +++ b/docs/html/quicksearch.html @@ -7,7 +7,7 @@