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

@duckness/duck

v1.0.0

Published

@duckness/duck - Modular Redux Ducks hatchery

Downloads

311

Readme

@duckness/duck

Modular Redux Ducks hatchery.

NPM License Libraries.io dependency status for latest release, scoped npm package GitHub issues vulnerabilities npm bundle size

Example

// counterDuck.js
import Duck from '@duckness/duck'

// Create duck with the name 'counter' for 'counter-app'
const counterDuck = Duck('counter', 'counter-app')

// Export action creators
counterDuck.action('incrementCounter', 'INCREMENT')
//  counterDuck.action.incrementCounter will build actions with type 'counter-app/counter/INCREMENT'
counterDuck.action('decrementCounter', 'DECREMENT')
//  counterDuck.action.decrementCounter will build actions with type 'counter-app/counter/DECREMENT'

// Add selector
counterDuck.selector('counter', state => (state.counter || 0))

// Add reducers
counterDuck.reducer('INCREMENT', (state, _action, duckFace) => {
  // duckness adds duckFace to every reducer
  // duckFace is an interface to duck with access to selectors, action types and root reducer
  return {
    ...state,
    counter: duckFace.select.counter(state) + 1
  }
})
counterDuck.reducer('DECREMENT', (state, _action, duckFace) => {
  return {
    ...state,
    counter: duckFace.select.counter(state) - 1
  }
})

// Duck itself is a root reducer
export default counterDuck

Table of Contents

API

Create Duck

Create a new duck with duckName and poolName (poolName is a namespace for ducks)

import Duck from '@duckness/duck'

const myDuck = Duck('duck-name', 'pool-name')

.duckName

const myDuck = Duck('duck-name', 'pool-name')
myDuck.duckName
// => 'duck-name'

.poolName

const myDuck = Duck('duck-name', 'pool-name')
myDuck.poolName
// => 'pool-name'

Actions

.mapActionType(actionType)

Maps short action type to long action type

myDuck.mapActionType('ACTION_TYPE')
// => 'pool-name/duck-name/ACTION_TYPE'

.action(actionName, actionType, payloadBuilder?, actionTransformer?)

Build action creator and register it under actionName (if actionName present)

const eatFish = myDuck.action('eatAllTheFish', 'EAT_FISH')
eatFish({ amount: 10 })
// => { type: 'pool-name/duck-name/EAT_FISH', payload: { amount: 10 } }
myDuck.action.eatAllTheFish({ amount: 9000 })
// => { type: 'pool-name/duck-name/EAT_FISH', payload: { amount: 9000 } }

Optional payloadBuilder could be specified to customize payloads

const eatFish = myDuck.action(null, 'EAT_FISH', payload => {
  return { amount: payload }
})
eatFish(10)
// => { type: 'pool-name/duck-name/EAT_FISH', payload: { amount: 10 } }

Optional actionTransformer could be specified to customize action

const eatFish = myDuck.action(null, 'EAT_FISH', null, action => {
  return { ...action, wellFed: true }
})
eatFish({ amount: 10 })
// => { type: 'pool-name/duck-name/EAT_FISH', payload: { amount: 10 }, wellFed: true }

If Error object is passed to action creator payloadBuilder will be skipped and action.error will be true

const eatFish = myDuck.action(null, 'EAT_FISH')
eatFish(new Error('no more fish'))
// => { type: 'pool-name/duck-name/EAT_FISH', payload: Error('no more fish'), error: true }

.action[]

Calls registered action creator by its name

const eatFish = myDuck.action('eatAllTheFish', 'EAT_FISH')
myDuck.action.eatAllTheFish({ amount: 9000 })
// => { type: 'pool-name/duck-name/EAT_FISH', payload: { amount: 9000 } }

.listActionTypes()

Returns all known short action types. Type is known if .mapActionType or .action was called with it.

myDuck.listActionTypes()
// => ['EAT_FISH', 'QUACK']

.actionTypes[]

Is an object that maps known short action types to long action types

myDuck.actionTypes.EAT_FISH
// => 'pool-name/duck-name/EAT_FISH'

Selectors

.selector(selectorName, selector)

Registers selector under selectorName

myDuck.selector('counter', (state, _duckFace) => (state.counter || 0))

.select[]

Calls registered selector

const state = { counter: 10 }
myDuck.select.counter(state)
// => 10

Reducers

.reducer(actionType, reducer)

Registers reducer for specific action type

myDuck.reducer('EAT_FISH', (state, action, _duckFace) => {
  return {
    ...state,
    fishEaten: state.fishEaten + action.payload.amount
  }
})

.reducer(null, reducer)

Registers wildcard reducer for all duck action types (ones that starts with 'pool-name/duck-name/')

myDuck.reducer(null, (state, action, _duckFace) => {
  return {
    ...state,
    updated: (state.updated || 0) + 1
  }
})

.reducer(withActions(action, duckFace), reducer)

Registers reducer with action filter

myDuck.reducer((action, _duckFace) => action.error, (state, action, _duckFace) => {
  return {
    ...state,
    errors: (state.errors || 0) + 1
  }
})

Root reducer

Duck itself is a root reducer for all registered reducers

myDuck( state, duckAction(payload) )
// => reduced state

duckFace

duckFace is an interface to duck that is added as a last argument to each registered selectors and reducers

myDuck.selector('counter', (some, selector, args, duckFace) => {
  // ...
}
myDuck.reducer('EAT_FISH', (state, action, duckFace) => {
  // ...
}

duckFace.actionTypes[]

Is an object that maps known short action types to long action types

duckFace.actionTypes.EAT_FISH
// => 'pool-name/duck-name/EAT_FISH'

duckFace.action[]

Calls registered action creator by its name

dispatch(duckFace.action.eatFish())

duckFace.mapActionType(actionType)

Maps short action type to long action type

duckFace.mapActionType('ACTION_TYPE')
// => 'pool-name/duck-name/ACTION_TYPE'

duckFace.listActionTypes()

Returns all known short action types. Type is known if .mapActionType or .action was called with it.

duckFace.listActionTypes()
// => ['EAT_FISH', 'QUACK']

duckFace.select[]

Calls registered selector

const state = { counter: 10 }
duckFace.select.counter(state)
// => 10

duckFace.reduce(state, action)

Calls duck root reducer

const prepareFish = myDuck.action(null, 'PREPARE_FISH')
myDuck.reducer('EAT_FISH', (state, action, duckFace) => {
  const preparedState = duckFace.reduce(state, prepareFish())
  return {
    ...preparedState,
    // ...
  }
})

duck.duckFace

duckFace can also be accessed from the duck itself by duck.duckFace name.

Context

Create Duck with context

Duck can be created with duckContext that will be accessible for selectors and reducers through duckFace

const themeDuck = Duck('theme', 'my-app', { highlightColor: 'blue' })
themeDuck.duckFace.duckContext.highlightColor
// => 'blue'

duck.updateContext

Duck context can be replaced with duck.updateContext(newContext)

themeDuck.updateContext({ highlightColor: 'red' })

Clone duck

Duck can be cloned by calling .clone(duckName, moduleName, duckContext).

Cloned duck will contain selectors, reducers and known action types copied from original duck with all action types adjusted to duckName and moduleName.

duckContext will be replaced.

Cloned duck can be expanded further.

const baseDuck = Duck('base', 'my-app')
baseDuck.reducer('BASE_ACTION', /* ... */)

const extendedDuck = baseDuck.clone('extended', 'my-app')
extendedDuck.reducer('ANOTHER_ACTION', /* ... */)

@Duckness packages: