Git Product home page Git Product logo

immutablejs-json's Introduction

immutablejs-json

npm version license

Overview

immutablejs-json is a JavaScript library that provides a function called deepSeal to create deeply immutable objects. It ensures that the nested level objects cannot be mutated, promoting immutability within your applications. This helps maintain data integrity and simplifies state management, especially in scenarios like Redux, where immutable data structures are preferred.

Installation

You can install the package via npm or yarn:

npm install immutablejs-json

# or

yarn add immutablejs-json

Usage

To use deepSeal, simply import it into your project and apply it to your objects:

const { deepSeal } = require('immutablejs-json');

const myObject = {
  name: 'John',
  age: 30,
  address: {
    city: 'New York',
    country: 'USA'
  }
};

const immutableObject = deepSeal(myObject);

// Attempting to modify properties will throw an error
immutableObject.name = 'Jane'; // Throws an error
immutableObject.address.city = 'San Francisco'; // Throws an error

// However, you can still access properties
console.log(immutableObject.name); // Output: "John"
console.log(immutableObject.address.city); // Output: "New York"

Key Features

  • Create deeply immutable objects to prevent nested level object mutations.
  • Helps in enforcing immutability and improving state management.
  • Lightweight and easy-to-use.

Contribution

Contributions to immutablejs-json are always welcome! If you find any bugs or have suggestions for improvements, please feel free to open an issue or submit a pull request. Make sure to follow the existing coding style and add appropriate test cases.

License

immutablejs-json is open-source software licensed under the MIT License.

Thank you for considering using immutablejs-json. If you have any questions or need further assistance, feel free to reach out to us or create an issue on GitHub.

Happy coding! ๐Ÿ˜„

immutablejs-json's People

Contributors

kinshukshah avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.