Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

mutativejs/mutability

Repository files navigation

mutability

Node CI npm version license

A JavaScript library for transactional mutable updates based on Mutative.

Motivation

When we want to perform transactional updates on a mutable object, if an error is caught during the update process, the mutable update will not be applied at all. Otherwise, the mutable update will be applied to the mutable object. Therefore, we need a tool to implement this functionality.

Installation

yarn add mutative mutability

or with npm

npm install mutative mutability

Usage

import { mutate } from 'mutability';
test('base - mutate', () => {
 const baseState = {
 a: {
 c: 1,
 },
 };
 const { patches, inversePatches } = mutate(baseState, (draft) => {
 draft.a.c = 2;
 });
 expect(baseState).toEqual({ a: { c: 2 } });
 expect({ patches, inversePatches }).toEqual({
 patches: [
 {
 op: 'replace',
 path: ['a', 'c'],
 value: 2,
 },
 ],
 inversePatches: [
 {
 op: 'replace',
 path: ['a', 'c'],
 value: 1,
 },
 ],
 });
 apply(baseState, inversePatches);
 expect(baseState).toEqual({ a: { c: 1 } });
});
test('base - mutate with error', () => {
 const baseState = {
 a: {
 c: 1,
 },
 b: {
 c: 1,
 },
 };
 try {
 mutate(baseState, (draft) => {
 draft.a.c = 2;
 throw new Error('error');
 draft.b.c = 2;
 });
 } catch (e) {
 //
 }
 expect(baseState).toEqual({
 a: {
 c: 1,
 },
 b: {
 c: 1,
 },
 });
});

APIs

mutate()

Mutate the mutable object, and return the patches and inverse patches.

apply()

Apply the mutable update with patches.

License

Mutability is MIT licensed.

About

A JavaScript library for transactional mutable updates

Topics

Resources

License

Stars

Watchers

Forks

Packages

Contributors

AltStyle によって変換されたページ (->オリジナル) /