Need private packages and team management tools?Check out npm Teams »

use-frozen-state

1.1.1 • Public • Published

use-frozen-state

React hook that makes sure your state is immutable. Call useFrozenState or useDeepFrozenState instead of useState.

Features:

  • Tiny and dependancy free
  • Built with Typescript

NPM PRs Welcome

Install

npm install --save use-frozen-state

Usage

Pick from useFrozenState and useDeepFrozenState.

  • useFrozenState will shallow freeze the state. (example)
  • useDeepFrozenState will traverse through the state object and freeze it all. (example)
  • Need selective deep freezing? Supply useDeepFrozenState a second parameter: deepFreezeFn. (example)

useFrozenState example

import React from "react";
import { useFrozenState } from "use-frozen-state";
 
const Example = () => {
  const [person, setPerson] = useFrozenState({ name: "Rick", last: "Sanchez" });
 
  const mortify = () => {
    person.name = "Morty"; // That's not how you do it Morty! Geez!
    setPerson(person);
  };
 
  return (
    <>
      <div>
        name: {person.name} {person.last}
      </div>
      <button onClick={mortify}>Morty is better!</button>
    </>
  );
};

useDeepFrozenState example

import React from "react";
import { useDeepFrozenState } from "use-frozen-state";
 
const theSmiths = [
  { name: "Summer", last: "Smith" },
  { name: "Beth", last: "Smith" },
  { name: "Jerry", last: "Smith" },
  { name: "Morty", last: "Smith" },
];
 
const Example = () => {
  const [family, setFamily] = useDeepFrozenState(theSmiths);
 
  const rickTakesControl = () => {
    // You'll kill us all Rick!
    family.forEach(member => {
      member.last = "Sanchez";
    });
  };
 
  return (
    <>
      ...
      <button onClick={rickTakesControl}>wubalubadubdub</button>
    </>
  );
};

deepFreezeFn example

import React from "react";
import { useDeepFrozenState } from "use-frozen-state";
 
const theSmiths = [
  { name: "Summer", last: "Smith" },
  { name: "Beth", last: "Smith" },
  { name: "Jerry", last: "Smith" },
  { name: "Morty", last: "Smith" },
];
 
function deepFreezeSecondLevel(object: any) {
  if (object === undefined || object === null) return object;
 
  Object.getOwnPropertyNames(object).forEach(prop => {
    const value = object[prop];
    typeof value === "object" && value !== null && Object.freeze(value);
  });
 
  return object;
}
 
const Example = () => {
  const [family, setFamily] = useDeepFrozenState(
    theSmiths,
    deepFreezeFromSecondLevel /* important part */,
  );
 
  const rickTakesControl = () => {
    // with deepFreezeSecondLevel, splice on family will work
    const jerryIndex = family.findIndex(member => member.name === "Jerry");
    theSmiths.splice(jerryIndex, 1, { name: "Rick", last: "Sanchez" });
 
    // but changing a family member will fail
    const beth = family.findIndex(member => member.name === "Beth");
    beth.last = "Sanchez";
  };
 
  return (
    <>
      ...
      <button onClick={rickTakesControl}>wubalubadubdub</button>
    </>
  );
};

License

MIT © NoamRa


This hook is created using create-react-hook.

Install

npm i use-frozen-state

DownloadsWeekly Downloads

2

Version

1.1.1

License

MIT

Unpacked Size

18.8 kB

Total Files

17

Last publish

Collaborators

  • avatar