@dcs/angular2-utils

Util functions and classes for angular2 projects. Used at DCS Fürth

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@dcs/angular2-utils
0.15.07 years ago7 years agoMinified + gzip package size for @dcs/angular2-utils in KB

Readme

@dcs/angular2-utils
Angular2 tools and infrastructure used at DCS Fürth.
This is a companion libary for our Angular2 starter project (currently not public).

Table of Contents

Installation

In your Angular2 + TypeScript project:
npm install --save @dcs/angular2-utils immutable @angular2-redux/store redux-immutable redux-logger redux-observable

The other peer dependencies (@angular/core, rxjs ...) should already be there. It is an Angular2 project after all.
In the Root NgModule add Angular2UtilsModule to imports and inherit from MainBaseModule:
import { NgModule } from '@angular/core';
import { Angular2UtilsModule, MainBaseModule } from '@dcs/angular2-utils';

@NgModule({
  /* ... */
  imports: [ /* ... */, Angular2UtilsModule ]
})
export class MainModule extends MainBaseModule { }

This does all the redux, DevTools, HMR ... wiring for the application.

Features

  • Pre-wired redux store via @angular2-redux/store
  • Add reducers and epics via Angular DI
  • Many ready to use validator functions
  • Some basic reusable Components and Pipes
  • RestService as a small configurable wrapper around Angular2 Http service
  • Lots of small utility functions (see utils folder)

Root Reducer

To add a new reducer to the Root Reducer, we use Angular DI.
Provide a new reducer for the token APPREDUCERS, using { multi: true }:
import { NgModule } from '@angular/core';
import { APP_REDUCERS } from '@dcs/angular2-utils';

import { myReducer } from './my.reducer';


@NgModule({
  providers: [
    { provide: APP_REDUCERS, useValue: { name: 'keyInState', reducer: myReducer } }
  ]
})
export class FeatureModule { }

Routing via actions

Routing can be triggered via a Redux Action. Just inject RouterActions and dispatch the Action function routeChange.
The state below 'router', 'url'
also updates automatically when the route changes in app, even when not using the Action.