Immutabled

concept

Immutabled is a low cost (8kb in size) immutable data structure library. Performance is saved through using structural sharing of copies, and developer sanity is kept through referential transparency. this package is still a work in progress and open to ideas, check out the current api and info in the documentation.

comparison to immutable-js

while immutable.js opts for an object oriented api, immutabled opts in to more functional api featuring partial application and seperation of logic and data.

import { map, _ } from 'immutabled';

/**
 * takes a user returns a user with loggedIn === true
 * userLoggedIn: user => user
 *
 * @example
 *   userLogin(user)
 *
 */
const userLogIn = map.set(_, 'loggedIn', true)


import { Map } from 'immutable'

/**
 * takes a user returns a user with loggedIn === true
 * userLoggedIn: user => user
 *
 * @example
 *   userLogin(user)
 *
 */
const userLogin = user => user.set('loggedIn', true)

how to install

yarn add -S immutabled

how to import

The recommended import is the es version if you are using webpack 2:

import { map, _ } from 'immutabled/es'

For for legacy imports:

import { map, _ } from 'immutabled'

// or

const { map, _ } = require('immutabled')

configure webpack to tree shake node_modules/**/es/*

to tree shake node_modules it is important that we import the native modules versions, but also, make sure that they are transpiled by webpack. to do this we need to configure our webpack rule for js slightly different slightly different.

const jsRule = {
  test: /\.jsx?$/,
  exclude: /node_modules\/(?!.*?es)/, // exclude node modules unless inside a 'es' sub directory
  use: 'babel-loader',
}

this will allow traditional node_modules to skip transpilation, but modules inside an 'es' sub directory to transpiled.