@clave/use-object-state

useObjectState

Make it easier to work with state of objects

Documentation

npm install @clave/use-object-state

The goal of this hook is to make it easier to manipulate objects stored in state. There are methods available to set, edit or append/change several properties oy the object stored in state. The manipulation methods are available on the setState method, for example setState.set('key', value).

Usage

import useObjectState from "@clave/use-object-state";

// useObjectState instead of useState
const [value, setValue] = useObjectState({
  name: "Ada Lovelace",
  born: "December 10, 1815",
  died: "November 27, 1852",
  aged: 36,
});

console.log(value);
// {
//   name: "Ada Lovelace",
//   born: "December 10, 1815",
//   died: "November 27, 1852",
//   aged: 36,
// }

// setValue behaves like normal
setValue({}); // the value is now an empty object, {}

// Set a key to a value
setValue.set("name", "Grace Hopper");
// {
//   name: "Grace Hopper",
//   born: "December 10, 1815",
//   died: "November 27, 1852",
//   aged: 36,
// }

// Set several keys to values
setValue.with({
  name: "Grace Hopper",
  aged: 85,
});
// {
//   name: "Grace Hopper",
//   born: "December 10, 1815",
//   died: "November 27, 1852",
//   aged: 85,
// }

// Edit a key
setValue.edit("name", (name) => name.ToUpperCase());
// {
//   name: "ADA LOVELACE",
//   born: "December 10, 1815",
//   died: "November 27, 1852",
//   aged: 36,
// }