Description
JavaScript looks up an unqualified name by searching a scope chain associated with the
execution context of the script or function containing that unqualified name. The 'with'
statement adds the given object to the head of this scope chain during the evaluation of
its statement body. If an unqualified name used in the body matches a property in the
scope chain, then the name is bound to the property and the object containing the
property. Otherwise a ReferenceError
is thrown.
Note: Using with
is not recommended, and is forbidden in strict mode. The recommended alternative is to assign the object whose properties you want to access to a temporary variable.
Performance pro & contra
Pro: The with
statement can help reduce file size by
reducing the need to repeat a lengthy object reference without performance penalty. The
scope chain change required by 'with' is not computationally expensive. Use of 'with'
will relieve the interpreter of parsing repeated object references. Note, however, that
in many cases this benefit can be achieved by using a temporary variable to store a
reference to the desired object.
Contra: The with
statement forces the specified object to
be searched first for all name lookups. Therefore all identifiers that aren't members of
the specified object will be found more slowly in a 'with' block. Where performance is
important, 'with' should only be used to encompass code blocks that access members of
the specified object.
Ambiguity contra
Contra: The with
statement makes it hard for a human
reader or JavaScript compiler to decide whether an unqualified name will be found along
the scope chain, and if so, in which object. So given this example:
function f(x, o) { with (o) { console.log(x); } }
Only when f
is called can x
be determined as found or not - and if found,
whether as a property of o
, or, if no such property exists, as f
's first formal argument. If you forget to define
x
in the object you pass as the second argument, you
won't get an error - instead you'll just get unexpected results. (And
it's also unclear what the actual intent of such code would be).
Contra: Code using with
may not be forward compatible,
especially when used with something other than a plain object. Consider this example:
function f(foo, values) { with (foo) { console.log(values); } }
If you call f([1,2,3], obj)
in an ECMAScript 5 environment, then the
values
reference inside the with
statement will resolve to
obj
. However, ECMAScript 2015 introduces a values
property
on Array.prototype
(so that it will be available on every array). So, in
a JavaScript environment that supports ECMAScript 2015, the values
reference inside the with
statement could resolve to
[1,2,3].values
. However, in this particular example,
Array.prototype
has been defined with values
in its
Symbol.unscopables
object. If it were not, one can see how this would be
a difficult issue to debug.