{"_id":"@brainhubeu/hadron-core","_rev":"27-91d312b39f2e96baecfab720405c9d2b","name":"@brainhubeu/hadron-core","dist-tags":{"latest":"1.0.0"},"versions":{"0.0.1":{"name":"@brainhubeu/hadron-core","version":"0.0.1","keywords":["hadron","brainhub","hadron-core"],"author":{"name":"Brainhub"},"license":"MIT","_id":"@brainhubeu/hadron-core@0.0.1","maintainers":[{"name":"brainhub-adam","email":"adam@brainhub.pl"},{"name":"caderek","email":"maciej.caderek@gmail.com"},{"name":"drymek","email":"marcin@dryka.pl"},{"name":"dyoda","email":"lukasz.pluszczewski@gmail.com"},{"name":"szymon.morawski","email":"szymon.morawski@brainhub.pl"}],"dist":{"shasum":"7baeebe62a43dc7b9c95169a937c01cedd05ff77","tarball":"https://registry.npmjs.org/@brainhubeu/hadron-core/-/hadron-core-0.0.1.tgz","fileCount":23,"integrity":"sha512-CIAbX/Hn12sClQpxV5RbOkvQFEDSGCTvOKvS4wFAaFGmSXhesERi9XLQJNiHSeuS02OGdTIU5YQWOMKIrgIsIg==","signatures":[{"sig":"MEYCIQCYEaWpJIVcUpYREulpxuR8SRPXKJXuwJyD5PYL5gxcxwIhAOl/XkmJmETA6Ip9woujalxxTiVkDp7nEmfdban5KlM5","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28448,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa2fCOCRA9TVsSAnZWagAAkTQP+wbarcZkp4WUUbEyMEKA\noK2OArFwlXvsl/ZxeyLn0j0nFQ4EcHolgQJ29Nj92eXmOpI+Zef4wboCb9U9\nGzZ3LV19fBT+/xS6BGF2RyYftaaWy0JhoZhEtUh3SKrLTaelTQW9uVMVU0z6\nAnfDhnDr8xlvv9Y81FhBAqgIMTvU5VM+qvdWlmDyYiL1G8seocsSaLhf90/0\nNgkLiDOKa6ctHPw3sPCt0VEDi34iCl418ELziOtixIAPmddbeQ0OEJ1DZRyO\nh4cCjde01CY6xDj8z+KJ5Huig4zooCktd2vi0HI4xPLqPfZ/dRo9z3kkSFfd\nhxu/Np3i91W8AlQKpg/jCFsirZ27logbdU+vZ9V7vb0us+S8iWOf7jBSUkWj\neM3SKTi3w7BfTwdHF0UjbCCpCbUq2E0kmDCmpKJ8BSUIO7GYpt3jRmfw9unM\nv45qErS4StZIB7XxW9Y7VTfY/eIsmsM6JEu0R1Wne1+3KqKFPFLth6woqtZG\nEKTsNkVsbhPfhAdUJc4GxaUT7o7etczeGaw+V48ST4zB/ud3Vb0ZA8EGLG4t\ng0cYwe0AtdA2Y/KMQTX5/HfWRpHXFLI3coG+UCsmlKNvkA/rdWrbZvI+JMIG\nIUhFK/n6KJusuOo07d6k2oFl4IrwJopfUG0d5HXq2k520OtnONGOEsybNXXh\nGo/T\r\n=wcIC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","files":["dist","./LICENSE"],"scripts":{"test":"echo \"Error: no test specified\" && exit 1","prepare":"tsc"},"_npmUser":{"name":"szymon.morawski","email":"szymon.morawski@brainhub.pl"},"_npmVersion":"5.5.1","description":"Hadron core module","directories":{},"_nodeVersion":"8.6.0","dependencies":{"bunyan":"^1.8.12","@brainhubeu/hadron-utils":"^0.0.1","@brainhubeu/hadron-error-handler":"^0.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/hadron-core_0.0.1_1524232333210_0.1330448055090403","host":"s3://npm-registry-packages"}},"0.0.2":{"name":"@brainhubeu/hadron-core","version":"0.0.2","keywords":["hadron","brainhub","hadron-core"],"author":{"name":"Brainhub"},"license":"MIT","_id":"@brainhubeu/hadron-core@0.0.2","maintainers":[{"name":"brainhub-adam","email":"adam@brainhub.pl"},{"name":"caderek","email":"maciej.caderek@gmail.com"},{"name":"drymek","email":"marcin@dryka.pl"},{"name":"dyoda","email":"lukasz.pluszczewski@gmail.com"},{"name":"szymon.morawski","email":"szymon.morawski@brainhub.pl"}],"dist":{"shasum":"ecd750640146a0308ceb79bd1a0f5ec6a361ea95","tarball":"https://registry.npmjs.org/@brainhubeu/hadron-core/-/hadron-core-0.0.2.tgz","fileCount":23,"integrity":"sha512-sTZn5Sgn0bY1K4zoRtGBQutOIYxRhQhSOJPwmh/g5POMEeLB9C0Q1li2rOw8q/+pO4qgdcYuU+uM00Omx2fVbg==","signatures":[{"sig":"MEUCIBz8LnJA18lR6skUOn0gKPyvh4PzFytn0zVYHZDeY+f5AiEAvr0A9ST6UbYNaocY329ylc4QN8Am+xuW0E2kNEJ4U8A=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28251,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa8ClhCRA9TVsSAnZWagAA5NEP/3dMFhYV7ibEso4qSKyn\neOLi4982v+Oct2MbRPSWRcdZnECqkAxW5SqNq3U4sE4JIZXbWVLrOBjnq0l0\nLMbzjiOgarFQuURI18FWJa8xkfprlkz5gf7hdc2RDdB5mlhz0ZvXFq16E8GX\n/uPIc83XVUDYkUygDR7meHCLe4Mz3Bugv+kk0ipcwDqvcSJlfM4vRePeuIEG\nWzPAkqp8xUJhxrqnhy4KyO+q7dRcMTs61vs7HtgwjFUvNaGLHHI00Y6NwVEf\nUtbO7JgbQ/YfYoKNmAkneG4V8pEIh5j3X/Ow4sH7FKk7rOMZ6MXby8jj67lh\nkRnyyDLObdFfv56QeZakn5TzpNI/+GXsBMJI7TZWtVComFIJqrqiEvflG+sR\nDx9Lmko98XbJWjWcF2bQE+1SJpblWnzr/zG/Uv/HDuWevFOTAngC5sejn2NN\n+MWs1QBZWeas+VNdYH+IxqqlIHQx1tAEfVzJScyTfh5Qg07dzGGVSlRiO/Y4\nxuoAe0xxdrmTr2b1tGOSAMLgdb3ZPMjRn3ybSKSnYr7sAwFxZBZLtT/z5w3o\nMfAVsow9kyXLMGJyFnXF1Ya2LSNxvNjIJyvhM4Uq1JZYSGEYkIR6gWI3jy65\n7ccvdI3QJvBOk1pgbSefaIZwcc6ktsQYgBsSyWBU3OxeIaZFYrpTHmzasmZY\n+XtC\r\n=RV/E\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","files":["dist","./LICENSE"],"scripts":{"test":"echo \"Error: no test specified\" && exit 1","prepare":"tsc"},"_npmUser":{"name":"szymon.morawski","email":"szymon.morawski@brainhub.pl"},"_npmVersion":"5.5.1","description":"Hadron core module","directories":{},"_nodeVersion":"8.6.0","dependencies":{"bunyan":"^1.8.12","@brainhubeu/hadron-utils":"^0.0.1","@brainhubeu/hadron-error-handler":"^0.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/hadron-core_0.0.2_1525688673370_0.6016439932548456","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@brainhubeu/hadron-core","version":"1.0.0","keywords":["hadron","brainhub","hadron-core"],"author":{"name":"Brainhub"},"license":"MIT","_id":"@brainhubeu/hadron-core@1.0.0","maintainers":[{"name":"brainhub-adam","email":"adam@brainhub.pl"},{"name":"caderek","email":"maciej.caderek@gmail.com"},{"name":"drymek","email":"marcin@dryka.pl"},{"name":"dyoda","email":"lukasz.pluszczewski@gmail.com"},{"name":"szymon.morawski","email":"szymon.morawski@brainhub.pl"}],"dist":{"shasum":"3b331ec62c43686e1cafb15f36c5803635dfefe0","tarball":"https://registry.npmjs.org/@brainhubeu/hadron-core/-/hadron-core-1.0.0.tgz","fileCount":23,"integrity":"sha512-rHMlhy76RdgMLsJNhNHwadeszFJTZTZ7c6f8FeUDa/31wV5LVHPOIIL1Qpw2SrhoD4RXZRUof79IIlOfMbtL0w==","signatures":[{"sig":"MEUCIQDTBg1/cEp1k58YxSqlrVjJL4lXQkOKMxhvdcGGRHPfzAIgVNQylp/sJP3uy9cTq12/PIpp5CgQEHy2NTnOa6LxGic=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":30139,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbFXVqCRA9TVsSAnZWagAA4HgQAJZRb8oKLrMckOsTMTBc\nzgjq5YGFIXSykLj6hGwqqPv9Zoa6ZTw1SckGNaOHUK208O+bbgVpEqXTqKN4\nRdVZ9nJjvA7HIxV0dfaCxBxiPKbsN3KJatKhMnM7ZW9mHrnkWhQLsyQdeB2T\nFhqFR8KXLz6cxvbirBtpraQpj+ted7Nks5qw3HGtMr5X9u0mR7TNMQd3K6CK\nJRphshNLVvlr9uDje3rljrHvYQWqMu+j7sYhVfk86SQ3cIjydtbi7B9A0rQ/\nobBjn/xWAAbeXkS0WUIAp/UqzUL5t9szBdG/ckAbRtOmBylH2fSnr4XSkNLQ\nUBwTXCxNXQjQI2wdG2HRR033Ct/PfiaVMWTlY+i+YGeMMlNuLUUVErA0+yRb\nnwfawSiPToKpjLl07Kz0eF7Xy2IvysVKD320H5pEFmfFsK9ZLobg8afH8Cvl\nydILXJTYbBYmEZJzXW6RI7r3ktY7g45gWjMEEwWX1z4r0EwDwhKOHBebign9\ntph1ADClZKJy/exJh2IXjOn0a/s0LnXNldYxaV/kDB6HTkrT/8bWRE8vAZpL\nBoiq/kWGXyY8p1STiAeAXyaS+XPIsyRTIZGbRCHzFvq7X3zxl3XTnqgrHsM3\npMoOvANH6KGt9gpcbdrfTACbAvskD+5hrjjgPpvx16aKTs6a5r3ls5g8Bm4V\n+f9v\r\n=q2rV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","files":["dist","./LICENSE"],"scripts":{"test":"echo \"Error: no test specified\" && exit 1","prepare":"tsc"},"_npmUser":{"name":"szymon.morawski","email":"szymon.morawski@brainhub.pl"},"_npmVersion":"5.5.1","description":"Hadron core module","directories":{},"_nodeVersion":"8.6.0","dependencies":{"bunyan":"^1.8.12","@brainhubeu/hadron-utils":"^1.0.0","@brainhubeu/hadron-error-handler":"^1.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/hadron-core_1.0.0_1528132969112_0.28650787093879226","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-04-20T13:52:13.154Z","modified":"2024-10-25T13:04:45.542Z","0.0.1":"2018-04-20T13:52:13.286Z","0.0.2":"2018-05-07T10:24:33.417Z","1.0.0":"2018-06-04T17:22:49.197Z"},"author":{"name":"Brainhub"},"license":"MIT","keywords":["hadron","brainhub","hadron-core"],"description":"Hadron core module","maintainers":[{"email":"angjeziorska@gmail.com","name":"angjez"},{"email":"mateusz.jarzebowski.bownik@gmail.com","name":"matt-jb"},{"email":"filip.kublin@brainhub.pl","name":"fkublin"},{"email":"cypherq@gmail.com","name":"benedyktdryl"},{"email":"dariusz.luber@gmail.com","name":"dluber"},{"email":"devops@brainhub.pl","name":"brainhubeu-devops"},{"email":"anna.lach@brainhub.pl","name":"annalach"},{"email":"szymon.morawski@brainhub.pl","name":"szymon.morawski"},{"email":"lukasz.pluszczewski@gmail.com","name":"dyoda"},{"email":"dev@brainhub.pl","name":"brainhubeu-ci"},{"email":"robert_hebel@icloud.com","name":"roberthebel"}],"readme":"## Installation\n\n* Install Node.js. We recommend using the latest version, installation details on [nodejs.org](https://nodejs.org)\n\n* Install following modules from npm:\n\n```bash\nnpm install @brainhubeu/hadron-core @brainhubeu/hadron-express express --save\n```\n\n## Hello world app\n\nLet's start with traditional Hello World app. It will give you a quick grasp of the framework.\n\n```javascript\nconst hadron = require('@brainhubeu/hadron-core').default;\nconst express = require('express');\n\nconst port = 8080;\nconst expressApp = express();\n\nconst config = {\n  routes: {\n    helloWorldRoute: {\n      path: '/',\n      callback: () => 'Hello world!',\n      methods: ['get'],\n    },\n  },\n};\n\nhadron(expressApp, [require('@brainhubeu/hadron-express')], config).then(() => {\n  expressApp.listen(port, () =>\n    console.log(`Listening on http://localhost:${port}`),\n  );\n});\n```\n\nIn the sections below, we will describe step by step what just happened.\n\n## Bootstrapping an app\n\nThe main hadron-core function is responsible for bootstrapping the app. It registers packages based on passed config and server instance:\n\n```javascript\nconst hadron = require('hadron-core').default;\n\nhadron(serverInstance, [...packages], config);\n```\n\nThe purpose of the main function is to initialize DI container and register package dependencies according to correspondent sections in config object (described in details in next chapters).\n\nMain function returns a promise that resolves to created DI container instance. In the promise `.then()` method, besides performing operations on the container instance, we can actually start our server, by calling Express `listen` method:\n\n```javascript\nhadron(serverInstance, ...rest).then((container) => {\n  // do some things on container...\n\n  serverInstance.listen(PORT, callback);\n});\n```\n\nNow, let's move to DI container itself.\n\n## Dependency Injection\n\nThe whole framework is built around DI Container concept. Its purpose is to automatically supply proper arguments for routes callbacks and other framework's building blocks.\n\nDI container instance is created and used internally by bootstrapping function, it is also returned (as a promise) from bootstrapping function, as mentioned in the previous section.\n\n### Container methods\n\n#### Registering items\n\n```javascript\ncontainer.register(key, item, lifetime);\n```\n\n* `key` - item name on which it will be registered inside the container\n* `item` - any value (primitive, data structure, function, class, etc.)\n* `lifetime` - the type of item's life-span\n\nLifetime options:\n\n* `'value'` - container returns registered item as is [default]\n* `'singleton'` - returns always the same instance of registered class / constructor function\n* `'transient'` - returns always a new instance of registered class / constructor function\n\n#### Retrieving items\n\n```javascript\ncontainer.take(key);\n```\n\n* `key` - item name (same as provided during registration)\n\nThe method returns item or item instance according to item type and lifetime option.\n\n#### Example usage in bootstrapping function\n\n```javascript\nconst { default: hadron, Lifetime } = require('hadron-core');\n\nhadron(...args).then((container) => {\n  container.register('foo', 123);\n  container.register('bar', class Bar {}, Lifetime.Singleton);\n  container.register('baz', class Baz {}, Lifetime.Transient);\n\n  // other stuff...\n});\n```\n\n### Accessing container items from routes' callbacks\n\nTo access container items from callbacks, you can just set arguments' names to match container keys, and required dependency will be provided.\n\nSee an example [here](../routing/#retrieving-items-from-container-in-callback)\n","readmeFilename":"README.md"}