Object.isFrozen()

  • Revision slug: JavaScript/Reference/Global_Objects/Object/isFrozen
  • Revision title: isFrozen
  • Revision id: 293007
  • Created:
  • Creator: ethertank
  • Is current revision? No
  • Comment

Revision Content

{{ js_minversion_header("1.8.5") }}

Summary

Determine if an object is frozen.

Method of Object
Implemented in JavaScript 1.8.5
ECMAScript Edition ECMAScript 5th Edition

Syntax

Object.isFrozen(obj)

Parameters

obj
The object which should be checked.

Description

An object is frozen if and only if it is not extensible, all its properties are non-configurable, and all its data properties (that is, properties which are not accessor properties with getter or setter components) are non-writable.

Examples

// A new object is extensible, so it is not frozen.
assert(Object.isFrozen({}) === false);

// An empty object which is not extensible is vacuously frozen.
var vacuouslyFrozen = Object.preventExtensions({});
assert(Object.isFrozen(vacuouslyFrozen) === true);

// A new object with one property is also extensible, ergo not frozen.
var oneProp = { p: 42 };
assert(Object.isFrozen(oneProp) === false);

// Preventing extensions to the object still doesn't make it frozen,
// because the property is still configurable (and writable).
Object.preventExtensions(oneProp);
assert(Object.isFrozen(oneProp) === false);

// ...but then deleting that property makes the object vacuously frozen.
delete oneProp.p;
assert(Object.isFrozen(oneProp) === true);

// A non-extensible object with a non-writable but still configurable property is not frozen.
var nonWritable = { e: "plep" };
Object.preventExtensions(nonWritable);
Object.defineProperty(nonWritable, "e", { writable: false }); // make non-writable
assert(Object.isFrozen(nonWritable) === false);

// Changing that property to non-configurable then makes the object frozen.
Object.defineProperty(nonWritable, "e", { configurable: false }); // make non-configurable
assert(Object.isFrozen(nonWritable) === true);

// A non-extensible object with a non-configurable but still writable property also isn't frozen.
var nonConfigurable = { release: "the kraken!" };
Object.preventExtensions(nonConfigurable);
Object.defineProperty(nonConfigurable, "release", { configurable: false });
assert(Object.isFrozen(nonConfigurable) === false);

// Changing that property to non-writable then makes the object frozen.
Object.defineProperty(nonConfigurable, "release", { writable: false });
assert(Object.isFrozen(nonConfigurable) === true);

// A non-extensible object with a configurable accessor property isn't frozen.
var accessor = { get food() { return "yum"; } };
Object.preventExtensions(accessor);
assert(Object.isFrozen(accessor) === false);

// ...but make that property non-configurable and it becomes frozen.
Object.defineProperty(accessor, "food", { configurable: false });
assert(Object.isFrozen(accessor) === true);

// But the easiest way for an object to be frozen is if Object.freeze has been called on it.
var frozen = { 1: 81 };
assert(Object.isFrozen(frozen) === false);
Object.freeze(frozen);
assert(Object.isFrozen(frozen) === true);

// By definition, a frozen object is non-extensible.
assert(Object.isExtensible(frozen) === false);

// Also by definition, a frozen object is sealed.
assert(Object.isSealed(frozen) === true);

Browser compatibility

{{ CompatibilityTable() }}

Feature Firefox (Gecko) Chrome Internet Explorer Opera Safari
Basic support 4 (2.0) 6 9 {{ CompatNo() }} 5.1
Feature Firefox Mobile (Gecko) Android IE Mobile Opera Mobile Safari Mobile
Basic support {{ CompatUnknown() }} {{ CompatUnknown() }} {{ CompatUnknown() }} {{ CompatUnknown() }} {{ CompatUnknown() }}

Based on Kangax's compat table.

See also

Revision Source

<div>{{ js_minversion_header("1.8.5") }}</div>


<h2 id="Summary" name="Summary">Summary</h2>
<p>Determine if an object is frozen.</p>
<table class="standard-table">
  <thead>
    <tr>
      <th class="header" colspan="2">Method of <a href="/en/docs/JavaScript/Reference/Global_Objects/Object" title="en/docs/JavaScript/Reference/Global_Objects/Object"><code>Object</code></a></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Implemented in</td>
      <td>JavaScript 1.8.5</td>
    </tr>
    <tr>
      <td>ECMAScript Edition</td>
      <td>ECMAScript 5th Edition</td>
    </tr>
  </tbody>
</table>
<h3 id="Syntax" name="Syntax">Syntax</h3>
<p><code>Object.isFrozen(<em>obj</em>)</code></p>
<h3 id="Parameters" name="Parameters">Parameters</h3>
<dl>
  <dt>
    obj</dt>
  <dd>
    The object which should be checked.</dd>
</dl>



<h2 id="Description" name="Description">Description</h2>
<p>An object is frozen if and only if it is not <a href="/en/docs/JavaScript/Reference/Global_Objects/Object/isExtensible" title="en/docs/JavaScript/Reference/Global Objects/Object/isExtensible">extensible</a>, all its properties are non-configurable, and all its data properties (that is, properties which are not accessor properties with getter or setter components) are non-writable.</p>


<h2 id="Examples" name="Examples">Examples</h2>
<pre class="brush: js">
// A new object is extensible, so it is not frozen.
assert(Object.isFrozen({}) === false);

// An empty object which is not extensible is vacuously frozen.
var vacuouslyFrozen = Object.preventExtensions({});
assert(Object.isFrozen(vacuouslyFrozen) === true);

// A new object with one property is also extensible, ergo not frozen.
var oneProp = { p: 42 };
assert(Object.isFrozen(oneProp) === false);

// Preventing extensions to the object still doesn't make it frozen,
// because the property is still configurable (and writable).
Object.preventExtensions(oneProp);
assert(Object.isFrozen(oneProp) === false);

// ...but then deleting that property makes the object vacuously frozen.
delete oneProp.p;
assert(Object.isFrozen(oneProp) === true);

// A non-extensible object with a non-writable but still configurable property is not frozen.
var nonWritable = { e: "plep" };
Object.preventExtensions(nonWritable);
Object.defineProperty(nonWritable, "e", { writable: false }); // make non-writable
assert(Object.isFrozen(nonWritable) === false);

// Changing that property to non-configurable then makes the object frozen.
Object.defineProperty(nonWritable, "e", { configurable: false }); // make non-configurable
assert(Object.isFrozen(nonWritable) === true);

// A non-extensible object with a non-configurable but still writable property also isn't frozen.
var nonConfigurable = { release: "the kraken!" };
Object.preventExtensions(nonConfigurable);
Object.defineProperty(nonConfigurable, "release", { configurable: false });
assert(Object.isFrozen(nonConfigurable) === false);

// Changing that property to non-writable then makes the object frozen.
Object.defineProperty(nonConfigurable, "release", { writable: false });
assert(Object.isFrozen(nonConfigurable) === true);

// A non-extensible object with a configurable accessor property isn't frozen.
var accessor = { get food() { return "yum"; } };
Object.preventExtensions(accessor);
assert(Object.isFrozen(accessor) === false);

// ...but make that property non-configurable and it becomes frozen.
Object.defineProperty(accessor, "food", { configurable: false });
assert(Object.isFrozen(accessor) === true);

// But the easiest way for an object to be frozen is if Object.freeze has been called on it.
var frozen = { 1: 81 };
assert(Object.isFrozen(frozen) === false);
Object.freeze(frozen);
assert(Object.isFrozen(frozen) === true);

// By definition, a frozen object is non-extensible.
assert(Object.isExtensible(frozen) === false);

// Also by definition, a frozen object is sealed.
assert(Object.isSealed(frozen) === true);
</pre>


<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{ CompatibilityTable() }}</p>
<div id="compat-desktop">
  <table class="compat-table">
    <tbody>
      <tr>
        <th>Feature</th>
        <th>Firefox (Gecko)</th>
        <th>Chrome</th>
        <th>Internet Explorer</th>
        <th>Opera</th>
        <th>Safari</th>
      </tr>
      <tr>
        <td>Basic support</td>
        <td>4 (2.0)</td>
        <td>6</td>
        <td>9</td>
        <td>{{ CompatNo() }}</td>
        <td>5.1</td>
      </tr>
    </tbody>
  </table>
</div>
<div id="compat-mobile">
  <table class="compat-table">
    <tbody>
      <tr>
        <th>Feature</th>
        <th>Firefox Mobile (Gecko)</th>
        <th>Android</th>
        <th>IE Mobile</th>
        <th>Opera Mobile</th>
        <th>Safari Mobile</th>
      </tr>
      <tr>
        <td>Basic support</td>
        <td>{{ CompatUnknown() }}</td>
        <td>{{ CompatUnknown() }}</td>
        <td>{{ CompatUnknown() }}</td>
        <td>{{ CompatUnknown() }}</td>
        <td>{{ CompatUnknown() }}</td>
      </tr>
    </tbody>
  </table>
</div>
<p>Based on <a class="external" href="http://kangax.github.com/es5-compat-table/">Kangax's compat table</a>.</p>




<h2 id="See_also" name="See_also">See also</h2>
<ul>
  <li><strong><a href="/en/docs/JavaScript/Reference/Global_Objects/Object/freeze" title="en/docs/JavaScript/Reference/Global Objects/Object/freezed"><code>Object.freeze</code></a></strong></li>

<li><a href="/en/docs/JavaScript/Reference/Global_Objects/Object/preventExtensions" title="en/docs/JavaScript/Reference/Global Objects/Object/preventExtensions"><code>Object.preventExtensions</code></a></li>

<li><a href="/en/docs/JavaScript/Reference/Global_Objects/Object/isExtensible" title="en/docs/JavaScript/Reference/Global Objects/Object/isExtensible"><code>Object.isExtensible</code></a></li>

<li><a href="/en/docs/JavaScript/Reference/Global_Objects/Object/seal" title="en/docs/JavaScript/Reference/Global Objects/Object/seal"><code>Object.seal</code></a></li>

<li><a href="/en/docs/JavaScript/Reference/Global_Objects/Object/isSealed" title="en/docs/JavaScript/Reference/Global Objects/Object/isSealed"><code>Object.isSealed</code></a></li>

</ul>
Revert to this revision