ngrx-action-creator-factory
v0.0.1
Published
An Action Creator Factory for creating ngrx action creator
Downloads
56
Readme
Ngrx Action Creator Factory
This is an angular 2 provider based - read about the concept at Simple Action Creators for ngrx/store in Angular 2.
This component came out as a result of the open source project Echoes Player - an alternative player for watching and listening to media from youtube.
Angular 2 Support
supports Angular 2 - Final - 2.2.1
LICENSE
MIT
Installation
npm install ngrx-action-creator-factory --save-dev
Supported API
Currently supported:
- ActionCreatorFactory.create(action: string, payload?: any)
Usage
First, import the ActionCreatorFactory to your module:
import { NgModule } from '@angular/core';
import { ActionCreatorFactory } from 'ngrx-action-creator-factory';
@NgModule({
imports:[ BrowserModule ],
providers: [ ActionCreatorFactory ],
declarations: [ AppComponent, ],
bootstrap: [ AppComponent ]
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
Next, use the ngrx-action-creator-factory either as a static factory or as an injectable provider:
import { Injectable } from '@angular/core';
import { Action } from '@ngrx/store';
import { ActionCreatorFactory } from 'ngrx-action-creator-factory';
@Injectable()
export class NowPlaylistActions {
static MEDIA_ENDED = '[NOW PLAYLIST] MEDIA_ENDED';
static QUEUE = '[NOW PLAYLIST] QUEUE';
// as injectable
constructor(private acf: ActionCreatorFactory) {
this.queueVideo = this.acf.create(NowPlaylistActions.QUEUE);
}
// as a static method
mediaEnded = ActionCreatorFactory.create(NowPlaylistActions.MEDIA_ENDED);
}
Testing
To start developing tdd/bdd style: npm run dev
This will: compile ts files, watch for changes and start the test task. Whenever a ts file is changed, it will rerun the tests.