ng-di-kit
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    Angular Dependency Injection Kit

    Build Status NPM Version NPM Downloads

    This library allows Angular developers to inject Components, Services and Modules to the main angular app via decorators.
    The library provides a number of decorators and corresponding global arrays to allow for a cleaner injection in the main Angualr App Module.

    Decorator Global Array Description
    DIDeclare declarations Used to inject components into the App Module as declarations
    DIEntry entries Used to inject components into the App Module as entry components
    DIProvide providers Used to inject services into the App Module as providers
    DIRoute routes Used to inject components into the App Module as routes
    DIImport importers Used to inject modules into the App Module as imports
    DIExport exporters Used to inject components into the App Module as exports

    NOTE
    The user defined components, services and modules using these decorators must be imported into the Angular App Module.
    This will allow the decorators to push the user defined entities to their respective global arrays.

    Therefore, it is recommended to use an indexer and import as technique.

    Installation

    Do the following steps to install ng-di-kit:

    npm install ng-di-kit
    

    Usage

    login.component.ts

    import { DIDeclare } from "ng-di-kit";
    import { Component, OnInit } from '@angular/core';
     
    @DIDeclare()
    @Component({
      selector: 'login-component',
      templateUrl: './login.component.html'
    })
    export class LoginComponent implements OnInit {
        ngOnInit() {
     
        }
    }

    login.service.ts

    import { DIProvide } from 'ng-di-kit';
    import { Injectable } from '@angular/core';
     
    @DIProvide()
    @Injectable()
    export class LoginService  {
     
    }

    users.component.ts

    import { DIRoute } from "ng-di-kit";
    import { Component, OnInit } from '@angular/core';
     
    @DIRoute(paths['/users'])
    @Component({
      selector: 'users-component',
      templateUrl: './users.component.html'
    })
    export class UsersComponent implements OnInit {
        ngOnInit() {
     
        }
    }

    index.ts

    export * from './login.component'
    export * from './login.service'
    export * from './users.component'

    app.module.ts

    import * as components from './index';
    import { declarations, entries, providers, importers, routes } from 'ng-di-kit';
    import { NgModule } from '@angular/core';
    import { HttpClientModule } from '@angular/common';
    import { BrowserModule } from '@angular/platform-browser';
    import { AppComponent } from './app.component';
     
    // expose the components, modules and services to allow application of decorators
    for(let key in components){
      components[key];
    }
     
    importers.push(BrowserModule);
    importers.push(HttpClientModule);
    importers.push(RouterModule.forRoot(routes));
     
    @NgModule({
      imports: importers,
      providers: providers,
      declarations: declarations,
      entryComponents: entries,
      bootstrap: [ AppComponent ]
    })
    export class AppModule { }

    Options

    DIDeclare

    Name Type Default Description
    isEntry boolean false Indicates if the declared component is also an entry component

    Example:

    @DIDeclare({isEntry: true})

    Authors

    01) Joseph Eniojukan - joejukan

    ChangeLog

    CHANGELOG.md file for details

    License

    This project is licensed under the ISC License - see the LICENSE.md file for details

    Copyright 2018 Joseph Eniojukan

    Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

    Install

    npm i ng-di-kit

    DownloadsWeekly Downloads

    6

    Version

    1.0.0

    License

    ISC

    Unpacked Size

    14.5 kB

    Total Files

    30

    Last publish

    Collaborators

    • joejukan