@neoskop/nem

Strucktured modules to build express apps

Stats

StarsIssuesVersionUpdatedCreatedSize
@neoskop/nem
080.6.0-rc.59 months ago4 years agoMinified + gzip package size for @neoskop/nem in KB

Readme

@neoskop/nem

Strucktured modules to build express apps

Master Travis master Test coverage master Known Vulnerabilities master

Develop Travis develop Test coverage develop Known Vulnerabilities develop

Installation

$ yarn add @neoskop/nem             # via yarn

$ npm install --save @neoskop/nem   # via npm

Usage

import { nem, NemModule, Controller, Get, View } from '@neoskop/nem';

@Controller()
export class ExampleController {
    @Get('/')
    @View('index')
    index() {
        return {
            title: 'Example'
        }
    }
}


@NemModule({
    controller: [
        [ '/', ExampleController ]
    ]
})
export class ExampleModule {

}

nem().bootstrap(ExampleModule).listen(8000);

See samples for for more examples.

Dependency Injection

                                                                        +-----------------------+
                                                                        |     rootProviders     |
                                                                        v                       |
+------------------------------+     +--------------------+     +---------------+     +-----------------+     +---------------------+
| Provided Injector (Optional) | --> | Bootstrap Injector | --> | Root Injector | --> | Module Injector | --> | Controller Injector | 
+------------------------------+     +--------------------+     +---------------+  ^  +-----------------+  |  +---------------------+
                                                                                   |                       |
                                                                                   |     Nested Modules    |
                                                                                   +-----------------------+

The bootstrap injector contains the required dependencies to bootstrap the app, the root injector inherits from the bootstrap injector and contains all global depenendencies.
The module injectors inherits from the parent module injector or the root injector for the root module.

Testing

yarn test

Building

yarn run build

License

MIT License

Copyright (c) 2018 Neoskop GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Sponsor

Neoskop GmbH

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.