npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

simple-redux-crud

v0.0.1-4a

Published

Simple Redux CRUD for your app

Downloads

1

Readme

Simple Redux CRUD

Simple CRUD for your Redux app

Motivation

I found some CRUD implementation of CRUD for redux, but they were a little bit complicated for my purpose. So I created this simple thing, hope you will like it.

Installation

$ npm install react-simple-redux

And you have to have thunk middleware enabled in your app!!

Usage

//assuming that you have 'todos' key in your state (in the root, not somewhere nested). 
//You may use this library only on keys that contain an array!
let state = {
	todos: [{
			text: 'My todo',
			completed: false,
			id: 99
		}, {
			text: 'Next todo',
			completed: true,
			id: 100
		}],
	isFetching: false
	//whatever else
}

//in your ./actions/todos/index.js
//import crud and create action creaters and CRUD reducer
import { createCRUDActions } from 'simple-redux-crud' //this function create action creators for your state key (e.g. todos)
import * as actions from './yourActions.js' //you will probably have your own action creators

export default Object.assign({}, createCRUDActions('todos'), actions) //combine newly created crud actions with your own actions
//you now get add, edit and delete action creators next to your own actions

Action creators signatures

/**
	@param {*} entity - thing you want to add to the state
	@param {boolean=} optimistic - whether adding should be done without waiting for some async function e.g. API call
	@param {boolean=} optimisticOnly - if you just want to add entity to state without calling API
*/
add(entity, optimistic = true, optimisticOnly = false) 

/**
	@param {number} index - index for simple editing (important!!)
	@param {number} id - id of object for API calls
	@param {Object} toUpdate - object of keys you want to update
	@param {boolean=} optimistic
	@param {boolean=} optimisticOnly
*/
edit(index, id, toUpdate, optimistic = true, optimisticOnly = false)

/**
	@param {number} index
	@param {number} id
	@param {Object=} deletePayload - anything you want to send in API request
	@param {boolean=} optimistic
	@param {boolean=} optimisticOnly
*/
delete(index, id, deletePayload = {}, optimistic = true, optimisticOnly = false)

Creating CRUD reducer

import { combineReducers } from 'redux'
import { createCRUDReducer } from 'simple-redux-crud'

export default combineReducers({
	todos: createCRUDReducer('todos') //argument is of course state key that is meant to be observed by reducer
})

//that's it, everything should be running now

Calling action creators

import React, { Component } from 'react'
import { connect } from 'redux'
import * as actions from '../actions/todos'

class Todo extends Component {
	
	toggleCompleted() {
		//you don't have to send whole entity, it is taken from previous state
		//don't forget to put right index of entity in state as first argument!!
		this.props.edit(this.props.index, this.props.id, {completed: !this.props.completed})
	},

	render() {
		<div className="todo">
			<strong>{this.props.text}</strong>
			<span>{this.completed ? 'Completed' : 'x'}</span>
			<span onClick={this.toggleCompleted}>Toggle completed!</span>
		</div>				
	}
}

export default connect((state) => {}, actions)(Todo) //that is it, everything should be running just fine now...

Configuration

So how do you implement API calls? Remember calling createCRUDActions()? You can add second argument to this function called conf look at source code:

export default function(stateKey, conf = {}) {
	const { asyncAdd, asyncEdit, asyncDelete } = conf

Got it? So you can just do this in your /actions/todos/index.js:

//...

export default Object.assign({}, createCRUDActions('todos', {
	asyncAdd: function(entity, optimistic) {
		return (dispatch, getState) => { //that is why you have to use thunk middleware!!
			//some stuff
		}
	},
	asyncEdit: function(index, id, toUpdate, optimistic) {
		//same thing here
	},
	asyncDelete: function(index, id, deletePayload, optimistic) {
		//same here too
	}
}), actions)

My first NPM package

I would:

  • add tests :))
  • get some users
  • solve some of their issues Thanks. VT.