@se-oss/deep-freeze

@se-oss/deep-freeze is a utility for deep-freezing objects.

• Installation
• Usage
• Documentation
• Contributing
• License

📦 Installation

npm install @se-oss/deep-freeze

pnpm

pnpm install @se-oss/deep-freeze

yarn

yarn add @se-oss/deep-freeze

📖 Usage

import { deepFreeze } from '@se-oss/deep-freeze';

const obj = {
  a: 1,
  b: { c: 2 },
  d: [1, 2],
};

deepFreeze(obj);

// obj is now immutable:
// obj.a = 2; // Error
// obj.b.c = 3; // Error
// obj.d.push(3); // Error

📚 Documentation

For all configuration options, please see the API docs.

🤝 Contributing

Want to contribute? Awesome! To show your support is to star the project, or to raise issues on GitHub.

Thanks again for your support, it is much appreciated! 🙏

License

MIT © Shahrad Elahi and contributors.