Code Monkey home page Code Monkey logo

redux-sequelize's Introduction

Redux Sequelize

npm Build Status Coverage Status GitHub

Description

Redux middleware, reducer and actions to work with sequelize databases.

Usage

Models

For each sequelize model create an entity type:

import { Entity, RelatedEntities, mapRelatedEntities } from 'redux-sequelize';
import { Model } from 'sequelize';

import { Project } from './project';

export interface Project extends Entity {
    name: string;
    workId: number

    projects: RelatedEntities<Project>;
}

export function toAnimal(data: Model): Animal {
    return {
        id: data.get('id') as number,
        name: data.get('name') as string,
        workId: data.get('workId') as number,
        projects: mapRelatedEntities<Project>('projects', data.get('projects') as Project[], 'workers')
    };
}

Actions

For each model create store actions:

import { createActions } from 'redux-sequelize';

import { Worker, toWorker } from '../types/worker';

import database from '../database';

export const include = [
    { key: 'projects', table: 'projects' }
];

const {
    createEntity: createWorker,
    deleteEntity: deleteWorker,
    getEntities: getWorkers,
    getEntity: getWorker,
    setEntity: setWorker
} = createActions<Worker>(() => database.sequelize, 'workers', toWorker, include);

export {
    createWorker,
    deleteWorker,
    getWorkers,
    getWorker,
    setWorker
};

Middleware

Add the redux-sequelize middleware to the redux-store:

import { createStore, applyMiddleware } from 'redux';
import thunk from 'redux-thunk';
import { middleware as sequelizeMiddleware } from 'redux-sequelize';

import reducers from './reducers';

const logger = createLogger();

export default createStore(reducers, undefined, applyMiddleware(thunk, sequelizeMiddleware));

Reducers

Create reducers for each database model:

import { combineReducers } from 'redux';
import { reducer as sequelizeReducer } from 'redux-sequelize';

import { Worker } from '../types/worker';
import { Project } from '../types/project';

const rootReducer = combineReducers({
    workers: sequelizeReducer<Worker>('workers'),
    projects: sequelizeReducer<Project>('projects')
});

export default rootReducer;
export type AppState = ReturnType<typeof rootReducer>;

Use entities in components

const mapStateToProps = (state: AppState) => ({
    workers: state.workers.data,
    updating: state.workers.updating > 0
});

const mapDispatchToProps = (dispatch: Dispatch) => bindActionCreators({
    getWorkers,
    getWorker,
    deleteWorker,
    setWorker,
    createWorker
}, dispatch);

License

MIT License

Copyright (c) 2020 MarkAtk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

redux-sequelize's People

Contributors

markatk avatar

Watchers

 avatar  avatar

redux-sequelize's Issues

Improve converter functions

Instead of passing the entity itself to the converter functions, maybe pass the JSON representation to make the conversion easier

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.