Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@3imed-jaberi/deepfreeze
Advanced tools
The modern and amiable deep freeze, works with Map and Set 🥶
Features
Object.freeze()
for objects, functions and arrays.Map
and Set
..isDeepFrozen()
method for each frozen object.Installation
# npm
$ npm install @3imed-jaberi/deepfreeze
# yarn
$ yarn add @3imed-jaberi/deepfreeze
Usage
This is a practical example of how to use.
"use strict";
const deepfreeze = require("@3imed-jaberi/deepfreeze");
const object = {
someBoolean: true,
someNumber: 10,
someString: "hello!",
someObject: { foo: "bar", someNestedObject: { nested: "inObject" } },
someArray: [false, 20, "bye!", { nested: "inArray" }],
someMap: new Map(["item1", "item2"]),
someSet: new Set(["item1", "item2"]),
};
const frozenObject = deepfreeze(object);
Object.isFrozen(frozenObject); // true
Object.isFrozen(frozenObject.someBoolean); // true
Object.isFrozen(frozenObject.someNumber); // true
Object.isFrozen(frozenObject.someString); // true
Object.isFrozen(frozenObject.someObject); // true
Object.isFrozen(frozenObject.someObject.foo); // true
Object.isFrozen(frozenObject.someObject.someNestedObject); // true
Object.isFrozen(frozenObject.someObject.someNestedObject.nested); // true
Object.isFrozen(frozenObject.someArray); // true
frozenObject.someArray.forEach((value) => {
Object.isFrozen(value); // true
});
frozenObject.someMap.clear(); // Error: Map is read-only.
frozenObject.someSet.clear(); // Error: Set is read-only.
API
You can pass some arguments to the freeze method;
object
— (Object) object to deep freeze.options.isProd
— (Boolean) ignore freezing in production (for better performance) (default to false
).options.pureFreeze
— (Boolean) use lodash.cloneDeep
to create a copy and use it dealing the freezing process (default to false
).If the passed object handled by our method, a method called isDeepFrozen
will be inserted as property to the object.
FAQs
The modern and amiable deep freeze, works with Map and Set 🥶
The npm package @3imed-jaberi/deepfreeze receives a total of 2 weekly downloads. As such, @3imed-jaberi/deepfreeze popularity was classified as not popular.
We found that @3imed-jaberi/deepfreeze demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.