vt-angular-module

1. Description

This package provides simple classes that allows you to create complex angular modules in a simpler way and import/export them easily.

Attention :: This version is in development process and thus it is not stable yet. Although I'm testing it myself all the time, there is a possibility that you encounter an error or wrong, unpredictable behaviour.

2. Installation

npm install vt-angular-module

3. Usage

Creating and exporting new module:

## "./example.js"

import { NgModule } from 'vt-angular-module';

export default NgModule({
    ...
});

Creating new angular entry:

## "./entry.js"

import { NgApp } from 'vt-angular-module';
import ExampleModule from './example.js'

NgApp({
    modules: [
        ExampleModule,
    ]
});

4. Module configuration

You can define angular elements in module configuration object:

import { NgModule } from 'vt-angular-module'

import AnotherModule from '../another.module.js';
import ExampleController from './example.controller.js';
import ExampleDirective from './example.directive.js';
import ExampleFactory from './example.factory.js';
import ExampleService from './example.service.js';
import ExampleFilter from './example.filter.js';

export default NgModule({
    dependencies: [
        AnotherModule,
    ],
        
    controllers: {
        'ExampleController': ExampleController,
    },
    
    directives: {
        'ExampleDirective': ExampleDirective,
    },
    
    factories: {
        'ExampleFactory': ExampleFactory,
    },
    
    services: {
        'ExampleService': ExampleService,
    },
    
    filters: {
        'ExampleFilter': ExampleFilter,
    }
});

NOTE: Angular modules create their own random name. You don't need to worry about their naming as long as you keep practicing this package convention.

5. Entry configuration

You can customize entry options through entry configuration object:

import { NgApp } from 'vt-angular-module';

NgApp({
    element: // document by default, you can provide any valid javascript DOM element
    
    config: {
        providers: // an empty array by default, add any provider you want to run for this entry
    }
    
    modules: // an empty array by default, you should provide any required modules here in order to be boostrapped
});

Copyright (C) Wojciech Brzeziński, [e-mail]