Getting Started

Install

npm install --save realt

Actions

createAction(actionName: string)

createAction(actionName: string, payloadCreator: function)

createAction(actionName: string, namespace: string)

createAction(actionName: string, payloadCreator: function, namespace: string)

createActions(Actions: object|array|function)

createActions(Actions: object|array|function, namespace: string)

Examples

Create single action

import{createAction}from'realt';constaddText=createAction('addText');expect(addText.toString()).toEqual('ADD_TEXT');expect(addText('Hello world')).toEqual({type:'ADD_TEXT',payload:'Hello world'});

Create from array

import{createActions}from'realt';constactions=createActions(['create','delete']);

Create from object

import{createActions}from'realt';constactions=createActions({create(id){returnid;},update(id,data){return{ id, data}}});

Create from class

import{createActions}from'realt';classActions{constructor(){this.generate('create');}update(id,data){return{ id, data};}}constactions=createActions(Actions);

ActionsClass.generate(…actionNames: string)

Note: all of the generated actions will receive only 1 parameter, so your data should be wrapped in an object

Reducer

createReducer(Reducer: object|function)

createReducer(Reducer: object|function, initialState: any)

createReducer(Reducer: object|function, namespace: string)

createReducer(Reducer: object|function, initialState: any, namespace: string)

Examples

Create from object

import{createReducer}from'realt';constinitialState=[{id:0,title:'Use Realt',}];constreducer=createReducer({create(state,id){// or handleCreate/reducerForCreate},update(state,id){// or handleUpdate/reducerForUpdate}},initialState);

Create from class

import{createReducer}from'realt';importactionsfrom'../actions';classReducer{constructor(){this.bindAction(actions.create,this.handleCreate);this.bindHandler(this.handleDelete,actions.delete);}getinitialState(){return[{id:0,title:'Use Realt',}];}handleCreate(state,id){returnstate.concat({ id,title:'New entity'});}handleDelete(state,id){returnstate.filter(entity=>entity.id!==id);}}exportdefaultcreateReducer(Reducer);

ReducerClass.initialState

ReducerClass.bindHandler(reducerHandler: function, actionCreator: object)

ReducerClass.bindAction(actionCreator: object, reducerHandler: function)