ECMA-262, 12th edition, June 2021 ECMAScript® 2021 Language Specification
About this Specification
The document athttps://tc39.es/ecma262/ is the most accurate and up-to-date ECMAScript specification. It contains the content of the most recent yearly snapshot plus anyfinished proposals (those that have reached Stage 4 in theproposal process and thus are implemented in several implementations and will be in the next practical revision) since that snapshot was taken.
Contributing to this Specification
This specification is developed on GitHub with the help of the ECMAScript community. There are a number of ways to contribute to the development of this specification:
Refer to thecolophon for more information on how this document is created.
Introduction
This Ecma Standard defines the ECMAScript 2021 Language. It is the twelfth edition of the ECMAScript Language Specification. Since publication of the first edition in 1997, ECMAScript has grown to be one of the world's most widely used general-purpose programming languages. It is best known as the language embedded in web browsers but has also been widely adopted for server and embedded applications.
ECMAScript is based on several originating technologies, the most well-known being JavaScript (Netscape) and JScript (Microsoft). The language was invented by Brendan Eich at Netscape and first appeared in that company's Navigator 2.0 browser. It has appeared in all subsequent browsers from Netscape and in all browsers from Microsoft starting with Internet Explorer 3.0.
The development of the ECMAScript Language Specification started in November 1996. The first edition of this Ecma Standard was adopted by the Ecma General Assembly of June 1997.
That Ecma Standard was submitted to ISO/IEC JTC 1 for adoption under the fast-track procedure, and approved as international standard ISO/IEC 16262, in April 1998. The Ecma General Assembly of June 1998 approved the second edition of ECMA-262 to keep it fully aligned with ISO/IEC 16262. Changes between the first and the second edition are editorial in nature.
The third edition of the Standard introduced powerful regular expressions, better string handling, new control statements, try/catch exception handling, tighter definition of errors, formatting for numeric output and minor changes in anticipation of future language growth. The third edition of the ECMAScript standard was adopted by the Ecma General Assembly of December 1999 and published as ISO/IEC 16262:2002 in June 2002.
After publication of the third edition, ECMAScript achieved massive adoption in conjunction with the World Wide Web where it has become the programming language that is supported by essentially all web browsers. Significant work was done to develop a fourth edition of ECMAScript. However, that work was not completed and not published as the fourth edition of ECMAScript but some of it was incorporated into the development of the sixth edition.
The fifth edition of ECMAScript (published as ECMA-262 5th edition) codified de facto interpretations of the language specification that have become common among browser implementations and added support for new features that had emerged since the publication of the third edition. Such features include accessor properties, reflective creation and inspection of objects, program control of property attributes, additional array manipulation functions, support for the JSON object encoding format, and a strict mode that provides enhanced error checking and program security. The fifth edition was adopted by the Ecma General Assembly of December 2009.
The fifth edition was submitted to ISO/IEC JTC 1 for adoption under the fast-track procedure, and approved as international standard ISO/IEC 16262:2011. Edition 5.1 of the ECMAScript Standard incorporated minor corrections and is the same text as ISO/IEC 16262:2011. The 5.1 Edition was adopted by the Ecma General Assembly of June 2011.
Focused development of the sixth edition started in 2009, as the fifth edition was being prepared for publication. However, this was preceded by significant experimentation and language enhancement design efforts dating to the publication of the third edition in 1999. In a very real sense, the completion of the sixth edition is the culmination of a fifteen year effort. The goals for this edition included providing better support for large applications, library creation, and for use of ECMAScript as a compilation target for other languages. Some of its major enhancements included modules, class declarations, lexical block scoping, iterators and generators, promises for asynchronous programming, destructuring patterns, and proper tail calls. The ECMAScript library of built-ins was expanded to support additional data abstractions including maps, sets, and arrays of binary numeric values as well as additional support for Unicode supplemental characters in strings and regular expressions. The built-ins were also made extensible via subclassing. The sixth edition provides the foundation for regular, incremental language and library enhancements. The sixth edition was adopted by the General Assembly of June 2015.
ECMAScript 2016 was the first ECMAScript edition released under Ecma TC39's new yearly release cadence and open development process. A plain-text source document was built from the ECMAScript 2015 source document to serve as the base for further development entirely on GitHub. Over the year of this standard's development, hundreds of pull requests and issues were filed representing thousands of bug fixes, editorial fixes and other improvements. Additionally, numerous software tools were developed to aid in this effort including Ecmarkup, Ecmarkdown, and Grammarkdown. ES2016 also included support for a new exponentiation operator and adds a new method toArray.prototype calledincludes.
ECMAScript 2017 introduced Async Functions, Shared Memory, and Atomics along with smaller language and library enhancements, bug fixes, and editorial updates. Async functions improve the asynchronous programming experience by providing syntax for promise-returning functions. Shared Memory and Atomics introduce a newmemory model that allows multi-agent programs to communicate using atomic operations that ensure a well-defined execution order even on parallel CPUs. It also included new static methods on Object:Object.values,Object.entries, andObject.getOwnPropertyDescriptors.
ECMAScript 2018 introduced support for asynchronous iteration via the AsyncIterator protocol and async generators. It also included four new regular expression features: thedotAll flag, named capture groups, Unicode property escapes, and look-behind assertions. Lastly it included object rest and spread properties.
ECMAScript 2019 introduced a few new built-in functions:flat andflatMap onArray.prototype for flattening arrays,Object.fromEntries for directly turning the return value ofObject.entries into a new Object, andtrimStart andtrimEnd onString.prototype as better-named alternatives to the widely implemented but non-standardString.prototype.trimLeft andtrimRight built-ins. In addition, it included a few minor updates to syntax and semantics. Updated syntax included optional catch binding parameters and allowing U+2028 (LINE SEPARATOR) and U+2029 (PARAGRAPH SEPARATOR) in string literals to align with JSON. Other updates included requiring thatArray.prototype.sort be a stable sort, requiring thatJSON.stringify return well-formed UTF-8 regardless of input, and clarifyingFunction.prototype.toString by requiring that it either return the corresponding original source text or a standard placeholder.
ECMAScript 2020, the 11th edition, introduces thematchAll method for Strings, to produce an iterator for all match objects generated by a global regular expression;import(), a syntax to asynchronously import Modules with a dynamic specifier;BigInt, a new number primitive for working with arbitrary precision integers;Promise.allSettled, a new Promise combinator that does not short-circuit;globalThis, a universal way to access the globalthis value; dedicatedexport * as ns from 'module' syntax for use within modules; increased standardization offor-in enumeration order;import.meta, ahost-populated object available in Modules that may contain contextual information about the Module; as well as adding two new syntax features to improve working with “nullish” values (null orundefined): nullish coalescing, a value selection operator; and optional chaining, a property access and function invocation operator that short-circuits if the value to access/invoke is nullish.
This specification, the 12th edition, introduces thereplaceAll method for Strings;Promise.any, a Promise combinator that short-circuits when an input value is fulfilled;AggregateError, a new Error type to represent multiple errors at once; logical assignment operators (??=,&&=,||=);WeakRef, for referring to a target object without preserving it from garbage collection, andFinalizationRegistry, to manage registration and unregistration of cleanup operations performed when target objects are garbage collected; separators for numeric literals (1_000); andArray.prototype.sort was made more precise, reducing the amount of cases that result in animplementation-defined sort order.
Dozens of individuals representing many organizations have made very significant contributions within Ecma TC39 to the development of this edition and to the prior editions. In addition, a vibrant community has emerged supporting TC39's ECMAScript efforts. This community has reviewed numerous drafts, filed thousands of bug reports, performed implementation experiments, contributed test suites, and educated the world-wide developer community about ECMAScript. Unfortunately, it is impossible to identify and acknowledge every person and organization who has contributed to this effort.
Allen Wirfs-Brock ECMA-262, Project Editor, 6th Edition
Brian Terlson ECMA-262, Project Editor, 7th through 10th Editions
Jordan Harband ECMA-262, Project Editor, 10th through 12th Editions
1 Scope
This Standard defines the ECMAScript 2021 general-purpose programming language.
2 Conformance
A conforming implementation of ECMAScript must provide and support all the types, values, objects, properties, functions, and program syntax and semantics described in this specification.
A conforming implementation of ECMAScript must interpret source text input in conformance with the latest version of the Unicode Standard and ISO/IEC 10646.
A conforming implementation of ECMAScript that provides an application programming interface (API) that supports programs that need to adapt to the linguistic and cultural conventions used by different human languages and countries must implement the interface defined by the most recent edition of ECMA-402 that is compatible with this specification.
A conforming implementation of ECMAScript may provide additional types, values, objects, properties, and functions beyond those described in this specification. In particular, a conforming implementation of ECMAScript may provide properties not described in this specification, and values for those properties, for objects that are described in this specification.
A conforming implementation of ECMAScript may support program and regular expression syntax not described in this specification. In particular, a conforming implementation of ECMAScript may support program syntax that makes use of any “future reserved words” noted in subclause12.6.2 of this specification.
A conforming implementation of ECMAScript must not implement any extension that is listed as a Forbidden Extension in subclause17.1.
A conforming implementation of ECMAScript may choose to implement or not implementNormative Optional subclauses. If any Normative Optional behaviour is implemented, all of the behaviour in the containing Normative Optional clause must be implemented. A Normative Optional clause is denoted in this specification with the words "Normative Optional" in a coloured box, as shown below.
The following referenced documents are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.
ISO/IEC 10646Information Technology — Universal Multiple-Octet Coded Character Set (UCS) plus Amendment 1:2005, Amendment 2:2006, Amendment 3:2008, and Amendment 4:2008, plus additional amendments and corrigenda, or successor
This section contains a non-normative overview of the ECMAScript language.
ECMAScript is an object-oriented programming language for performing computations and manipulating computational objects within ahost environment. ECMAScript as defined here is not intended to be computationally self-sufficient; indeed, there are no provisions in this specification for input of external data or output of computed results. Instead, it is expected that the computational environment of an ECMAScript program will provide not only the objects and other facilities described in this specification but also certain environment-specific objects, whose description and behaviour are beyond the scope of this specification except to indicate that they may provide certain properties that can be accessed and certain functions that can be called from an ECMAScript program.
ECMAScript was originally designed to be used as a scripting language, but has become widely used as a general-purpose programming language. Ascripting language is a programming language that is used to manipulate, customize, and automate the facilities of an existing system. In such systems, useful functionality is already available through a user interface, and the scripting language is a mechanism for exposing that functionality to program control. In this way, the existing system is said to provide ahost environment of objects and facilities, which completes the capabilities of the scripting language. A scripting language is intended for use by both professional and non-professional programmers.
ECMAScript was originally designed to be aWeb scripting language, providing a mechanism to enliven Web pages in browsers and to perform server computation as part of a Web-based client-server architecture. ECMAScript is now used to provide core scripting capabilities for a variety ofhost environments. Therefore the core language is specified in this document apart from any particularhost environment.
ECMAScript usage has moved beyond simple scripting and it is now used for the full spectrum of programming tasks in many different environments and scales. As the usage of ECMAScript has expanded, so have the features and facilities it provides. ECMAScript is now a fully featured general-purpose programming language.
4.1 Web Scripting
A web browser provides an ECMAScripthost environment for client-side computation including, for instance, objects that represent windows, menus, pop-ups, dialog boxes, text areas, anchors, frames, history, cookies, and input/output. Further, thehost environment provides a means to attach scripting code to events such as change of focus, page and image loading, unloading, error and abort, selection, form submission, and mouse actions. Scripting code appears within the HTML and the displayed page is a combination of user interface elements and fixed and computed text and images. The scripting code is reactive to user interaction, and there is no need for a main program.
A web server provides a differenthost environment for server-side computation including objects representing requests, clients, and files; and mechanisms to lock and share data. By using browser-side and server-side scripting together, it is possible to distribute computation between the client and server while providing a customized user interface for a Web-based application.
Each Web browser and server that supports ECMAScript supplies its ownhost environment, completing the ECMAScript execution environment.
4.2 Hosts and Implementations
To aid integrating ECMAScript intohost environments, this specification defers the definition of certain facilities (e.g.,abstract operations), either in whole or in part, to a source outside of this specification. Editorially, this specification distinguishes the following kinds of deferrals.
Animplementation is an external source that further defines facilities enumerated in AnnexD or those that are marked asimplementation-defined orimplementation-approximated. In informal use, an implementation refers to a concrete artefact, such as a particular web browser.
Animplementation-defined facility is one that defers its definition to an external source without further qualification. This specification does not make any recommendations for particular behaviours, and conforming implementations are free to choose any behaviour within the constraints put forth by this specification.
Animplementation-approximated facility is one that defers its definition to an external source while recommending an ideal behaviour. While conforming implementations are free to choose any behaviour within the constraints put forth by this specification, they are encouraged to strive to approximate the ideal. Some mathematical operations, such asMath.exp, areimplementation-approximated.
Ahost is an external source that further defines facilities listed in AnnexD but does not further define otherimplementation-defined orimplementation-approximated facilities. In informal use, ahost refers to the set of all implementations, such as the set of all web browsers, that interface with this specification in the same way via AnnexD. Ahost is often an external specification, such as WHATWG HTML (https://html.spec.whatwg.org/). In other words, facilities that arehost-defined are often further defined in external specifications.
Ahost hook is an abstract operation that is defined in whole or in part by an external source. Allhost hooks must be listed in AnnexD.
Ahost-defined facility is one that defers its definition to an external source without further qualification and is listed in AnnexD. Implementations that are not hosts may also provide definitions forhost-defined facilities.
Ahost environment is a particular choice of definition for allhost-defined facilities. Ahost environment typically includes objects or functions which allow obtaining input and providing output ashost-defined properties of theglobal object.
This specification follows the editorial convention of always using the most specific term. For example, if a facility ishost-defined, it should not be referred to asimplementation-defined.
Both hosts and implementations may interface with this specification via the language types, specification types,abstract operations, grammar productions, intrinsic objects, and intrinsic symbols defined herein.
4.3 ECMAScript Overview
The following is an informal overview of ECMAScript—not all parts of the language are described. This overview is not part of the standard proper.
ECMAScript is object-based: basic language andhost facilities are provided by objects, and an ECMAScript program is a cluster of communicating objects. In ECMAScript, anobject is a collection of zero or moreproperties each withattributes that determine how each property can be used—for example, when the Writable attribute for a property is set tofalse, any attempt by executed ECMAScript code to assign a different value to the property fails. Properties are containers that hold other objects,primitive values, orfunctions. A primitive value is a member of one of the following built-in types:Undefined,Null,Boolean,Number,BigInt,String, andSymbol; an object is a member of the built-in typeObject; and a function is a callable object. A function that is associated with an object via a property is called amethod.
ECMAScript defines a collection ofbuilt-in objects that round out the definition of ECMAScript entities. These built-in objects include theglobal object; objects that are fundamental to theruntime semantics of the language includingObject,Function,Boolean,Symbol, and variousError objects; objects that represent and manipulate numeric values includingMath,Number, andDate; the text processing objectsString andRegExp; objects that are indexed collections of values includingArray and nine different kinds of Typed Arrays whose elements all have a specific numeric data representation; keyed collections includingMap andSet objects; objects supporting structured data including theJSON object,ArrayBuffer,SharedArrayBuffer, andDataView; objects supporting control abstractions including generator functions andPromise objects; and reflection objects includingProxy andReflect.
ECMAScript also defines a set of built-inoperators. ECMAScript operators include various unary operations, multiplicative operators, additive operators, bitwise shift operators, relational operators, equality operators, binary bitwise operators, binary logical operators, assignment operators, and the comma operator.
Large ECMAScript programs are supported bymodules which allow a program to be divided into multiple sequences of statements and declarations. Each module explicitly identifies declarations it uses that need to be provided by other modules and which of its declarations are available for use by other modules.
ECMAScript syntax intentionally resembles Java syntax. ECMAScript syntax is relaxed to enable it to serve as an easy-to-use scripting language. For example, a variable is not required to have its type declared nor are types associated with properties, and defined functions are not required to have their declarations appear textually before calls to them.
4.3.1 Objects
Even though ECMAScript includes syntax for class definitions, ECMAScript objects are not fundamentally class-based such as those in C++, Smalltalk, or Java. Instead objects may be created in various ways including via a literal notation or viaconstructors which create objects and then execute code that initializes all or part of them by assigning initial values to their properties. Eachconstructor is a function that has a property named"prototype" that is used to implementprototype-based inheritance andshared properties. Objects are created by using constructors innew expressions; for example,new Date(2009, 11) creates a new Date object. Invoking aconstructor without usingnew has consequences that depend on theconstructor. For example,Date() produces a string representation of the current date and time rather than an object.
Every object created by aconstructor has an implicit reference (called the object'sprototype) to the value of itsconstructor's"prototype" property. Furthermore, a prototype may have a non-null implicit reference to its prototype, and so on; this is called theprototype chain. When a reference is made to a property in an object, that reference is to the property of that name in the first object in the prototype chain that contains a property of that name. In other words, first the object mentioned directly is examined for such a property; if that object contains the named property, that is the property to which the reference refers; if that object does not contain the named property, the prototype for that object is examined next; and so on.
Figure 1: Object/Prototype Relationships
In a class-based object-oriented language, in general, state is carried by instances, methods are carried by classes, and inheritance is only of structure and behaviour. In ECMAScript, the state and methods are carried by objects, while structure, behaviour, and state are all inherited.
All objects that do not directly contain a particular property that their prototype contains share that property and its value. Figure 1 illustrates this:
CF is aconstructor (and also an object). Five objects have been created by usingnew expressions:cf1,cf2,cf3,cf4, andcf5. Each of these objects contains properties named"q1" and"q2". The dashed lines represent the implicit prototype relationship; so, for example,cf3's prototype isCFp. Theconstructor,CF, has two properties itself, named"P1" and"P2", which are not visible toCFp,cf1,cf2,cf3,cf4, orcf5. The property named"CFP1" inCFp is shared bycf1,cf2,cf3,cf4, andcf5 (but not byCF), as are any properties found inCFp's implicit prototype chain that are not named"q1","q2", or"CFP1". Notice that there is no implicit prototype link betweenCF andCFp.
Unlike most class-based object languages, properties can be added to objects dynamically by assigning values to them. That is, constructors are not required to name or assign values to all or any of the constructed object's properties. In the above diagram, one could add a new shared property forcf1,cf2,cf3,cf4, andcf5 by assigning a new value to the property inCFp.
Although ECMAScript objects are not inherently class-based, it is often convenient to define class-like abstractions based upon a common pattern ofconstructor functions, prototype objects, and methods. The ECMAScript built-in objects themselves follow such a class-like pattern. Beginning with ECMAScript 2015, the ECMAScript language includes syntactic class definitions that permit programmers to concisely define objects that conform to the same class-like abstraction pattern used by the built-in objects.
4.3.2 The Strict Variant of ECMAScript
The ECMAScript Language recognizes the possibility that some users of the language may wish to restrict their usage of some features available in the language. They might do so in the interests of security, to avoid what they consider to be error-prone features, to get enhanced error checking, or for other reasons of their choosing. In support of this possibility, ECMAScript defines a strict variant of the language. The strict variant of the language excludes some specific syntactic and semantic features of the regular ECMAScript language and modifies the detailed semantics of some features. The strict variant also specifies additional error conditions that must be reported by throwing error exceptions in situations that are not specified as errors by the non-strict form of the language.
The strict variant of ECMAScript is commonly referred to as thestrict mode of the language. Strict mode selection and use of the strict mode syntax and semantics of ECMAScript is explicitly made at the level of individual ECMAScript source text units as described in11.2.2. Because strict mode is selected at the level of a syntactic source text unit, strict mode only imposes restrictions that have local effect within such a source text unit. Strict mode does not restrict or modify any aspect of the ECMAScript semantics that must operate consistently across multiple source text units. A complete ECMAScript program may be composed of both strict mode and non-strict mode ECMAScript source text units. In this case, strict mode only applies when actually executing code that is defined within a strict mode source text unit.
In order to conform to this specification, an ECMAScript implementation must implement both the full unrestricted ECMAScript language and the strict variant of the ECMAScript language as defined by this specification. In addition, an implementation must support the combination of unrestricted and strict mode source text units into a single composite program.
4.4 Terms and Definitions
For the purposes of this document, the following terms and definitions apply.
4.4.1 implementation-approximated
animplementation-approximated facility is defined in whole or in part by an external source but has a recommended, ideal behaviour in this specification
4.4.2 implementation-defined
animplementation-defined facility is defined in whole or in part by an external source to this specification
The value of aconstructor's"prototype" property is a prototype object that is used to implement inheritance and shared properties.
4.4.8 prototype
object that provides shared properties for other objects
Note
When aconstructor creates an object, that object implicitly references theconstructor's"prototype" property for the purpose of resolving property references. Theconstructor's"prototype" property can be referenced by the program expressionconstructor.prototype, and properties added to an object's prototype are shared, through inheritance, by all objects sharing the prototype. Alternatively, a new object may be created with an explicitly specified prototype by using theObject.create built-in function.
4.4.9 ordinary object
object that has the default behaviour for the essential internal methods that must be supported by all objects
4.4.10 exotic object
object that does not have the default behaviour for one or more of the essential internal methods
object whose semantics are defined by this specification
4.4.12 built-in object
object specified and supplied by an ECMAScript implementation
Note
Standard built-in objects are defined in this specification. An ECMAScript implementation may specify and supply additional kinds of built-in objects. Abuilt-inconstructor is a built-in object that is also aconstructor.
4.4.13 undefined value
primitive value used when a variable has not been assigned a value
4.4.14 Undefined type
type whose sole value is theundefined value
4.4.15 null value
primitive value that represents the intentional absence of any object value
4.4.16 Null type
type whose sole value is thenull value
4.4.17 Boolean value
member of the Boolean type
Note
There are only two Boolean values,true andfalse.
4.4.18 Boolean type
type consisting of the primitive valuestrue andfalse
4.4.19 Boolean object
member of the Object type that is an instance of the standard built-in Booleanconstructor
Note
A Boolean object is created by using the Booleanconstructor in anew expression, supplying a Boolean value as an argument. The resulting object has an internal slot whose value is the Boolean value. A Boolean object can be coerced to a Boolean value.
4.4.20 String value
primitive value that is a finite ordered sequence of zero or more 16-bit unsignedinteger values
Note
A String value is a member of the String type. Eachinteger value in the sequence usually represents a single 16-bit unit of UTF-16 text. However, ECMAScript does not place any restrictions or requirements on the values except that they must be 16-bit unsigned integers.
4.4.21 String type
set of all possible String values
4.4.22 String object
member of the Object type that is an instance of the standard built-in Stringconstructor
Note
A String object is created by using the Stringconstructor in anew expression, supplying a String value as an argument. The resulting object has an internal slot whose value is the String value. A String object can be coerced to a String value by calling the Stringconstructor as a function (22.1.1.1).
4.4.23 Number value
primitive value corresponding to a double-precision 64-bit binary formatIEEE 754-2019 value
Note
ANumber value is a member of the Number type and is a direct representation of a number.
4.4.24 Number type
set of all possible Number values including the special “Not-a-Number” (NaN) value, positive infinity, and negative infinity
4.4.25 Number object
member of the Object type that is an instance of the standard built-in Numberconstructor
Note
A Number object is created by using the Numberconstructor in anew expression, supplying aNumber value as an argument. The resulting object has an internal slot whose value is theNumber value. A Number object can be coerced to aNumber value by calling the Numberconstructor as a function (21.1.1.1).
primitive value corresponding to an arbitrary-precisioninteger value
4.4.29 BigInt type
set of all possible BigInt values
4.4.30 BigInt object
member of the Object type that is an instance of the standard built-in BigIntconstructor
4.4.31 Symbol value
primitive value that represents a unique, non-String Object property key
4.4.32 Symbol type
set of all possible Symbol values
4.4.33 Symbol object
member of the Object type that is an instance of the standard built-in Symbolconstructor
4.4.34 function
member of the Object type that may be invoked as a subroutine
Note
In addition to its properties, a function contains executable code and state that determine how it behaves when invoked. A function's code may or may not be written in ECMAScript.
4.4.35 built-in function
built-in object that is a function
Note
Examples of built-in functions includeparseInt andMath.exp. Ahost or implementation may provide additional built-in functions that are not described in this specification.
4.4.36 property
part of an object that associates a key (either a String value or a Symbol value) and a value
Note
Depending upon the form of the property the value may be represented either directly as a data value (a primitive value, an object, or afunction object) or indirectly by a pair of accessor functions.
4.4.37 method
function that is the value of a property
Note
When a function is called as a method of an object, the object is passed to the function as itsthis value.
4.4.38 built-in method
method that is a built-in function
Note
Standard built-in methods are defined in this specification. Ahost or implementation may provide additional built-in methods that are not described in this specification.
4.4.39 attribute
internal value that defines some characteristic of a property
4.4.40 own property
property that is directly contained by its object
4.4.41 inherited property
property of an object that is not an own property but is a property (either own or inherited) of the object's prototype
4.5 Organization of This Specification
The remainder of this specification is organized as follows:
Clause5 defines the notational conventions used throughout the specification.
Clauses6 through10 define the execution environment within which ECMAScript programs operate.
Clauses11 through17 define the actual ECMAScript programming language including its syntactic encoding and the execution semantics of all language features.
Clauses18 through28 define the ECMAScript standard library. They include the definitions of all of the standard objects that are available for use by ECMAScript programs as they execute.
Clause29 describes the memory consistency model of accesses on SharedArrayBuffer-backed memory and methods of the Atomics object.
5 Notational Conventions
5.1 Syntactic and Lexical Grammars
5.1.1 Context-Free Grammars
Acontext-free grammar consists of a number ofproductions. Each production has an abstract symbol called anonterminal as itsleft-hand side, and a sequence of zero or more nonterminal andterminal symbols as itsright-hand side. For each grammar, the terminal symbols are drawn from a specified alphabet.
Achain production is a production that has exactly one nonterminal symbol on its right-hand side along with zero or more terminal symbols.
Starting from a sentence consisting of a single distinguished nonterminal, called thegoal symbol, a given context-free grammar specifies alanguage, namely, the (perhaps infinite) set of possible sequences of terminal symbols that can result from repeatedly replacing any nonterminal in the sequence with a right-hand side of a production for which the nonterminal is the left-hand side.
Input elements other than white space and comments form the terminal symbols for the syntactic grammar for ECMAScript and are called ECMAScripttokens. These tokens are the reserved words, identifiers, literals, and punctuators of the ECMAScript language. Moreover, line terminators, although not considered to be tokens, also become part of the stream of input elements and guide the process of automatic semicolon insertion (12.9). Simple white space and single-line comments are discarded and do not appear in the stream of input elements for the syntactic grammar. AMultiLineComment (that is, a comment of the form/*…*/ regardless of whether it spans more than one line) is likewise simply discarded if it contains no line terminator; but if aMultiLineComment contains one or more line terminators, then it is replaced by a single line terminator, which becomes part of the stream of input elements for the syntactic grammar.
ARegExp grammar for ECMAScript is given in22.2.1. This grammar also has as its terminal symbols the code points as defined bySourceCharacter. It defines a set of productions, starting from thegoal symbolPattern, that describe how sequences of code points are translated into regular expression patterns.
Productions of the lexical and RegExp grammars are distinguished by having two colons “::” as separating punctuation. The lexical and RegExp grammars share some productions.
5.1.3 The Numeric String Grammar
Another grammar is used for translating Strings into numeric values. This grammar is similar to the part of the lexical grammar having to do with numeric literals and has as its terminal symbolsSourceCharacter. This grammar appears in7.1.4.1.
Productions of the numeric string grammar are distinguished by having three colons “:::” as punctuation.
5.1.4 The Syntactic Grammar
Thesyntactic grammar for ECMAScript is given in clauses13 through16. This grammar has ECMAScript tokens defined by the lexical grammar as its terminal symbols (5.1.2). It defines a set of productions, starting from two alternative goal symbolsScript andModule, that describe how sequences of tokens form syntactically correct independent components of ECMAScript programs.
When a stream of code points is to be parsed as an ECMAScriptScript orModule, it is first converted to a stream of input elements by repeated application of the lexical grammar; this stream of input elements is then parsed by a single application of the syntactic grammar. The input stream is syntactically in error if the tokens in the stream of input elements cannot be parsed as a single instance of the goal nonterminal (Script orModule), with no tokens left over.
When a parse is successful, it constructs aparse tree, a rooted tree structure in which each node is aParse Node. Each Parse Node is aninstance of a symbol in the grammar; it represents a span of the source text that can be derived from that symbol. The root node of the parse tree, representing the whole of the source text, is an instance of the parse'sgoal symbol. When a Parse Node is an instance of a nonterminal, it is also an instance of some production that has that nonterminal as its left-hand side. Moreover, it has zero or morechildren, one for each symbol on the production's right-hand side: each child is a Parse Node that is an instance of the corresponding symbol.
New Parse Nodes are instantiated for each invocation of the parser and never reused between parses even of identical source text. Parse Nodes are consideredthe same Parse Node if and only if they represent the same span of source text, are instances of the same grammar symbol, and resulted from the same parser invocation.
Note 1
Parsing the same String multiple times will lead to different Parse Nodes. For example, consider:
let str ="1 + 1;";eval(str);eval(str);
Each call toeval converts the value ofstr into an ECMAScript source text and performs an independent parse that creates its own separate tree of Parse Nodes. The trees are distinct even though each parse operates upon a source text that was derived from the same String value.
Note 2
Parse Nodes are specification artefacts, and implementations are not required to use an analogous data structure.
Productions of the syntactic grammar are distinguished by having just one colon “:” as punctuation.
The syntactic grammar as presented in clauses13 through16 is not a complete account of which token sequences are accepted as a correct ECMAScriptScript orModule. Certain additional token sequences are also accepted, namely, those that would be described by the grammar if only semicolons were added to the sequence in certain places (such as before line terminator characters). Furthermore, certain token sequences that are described by the grammar are not considered acceptable if a line terminator character appears in certain “awkward” places.
In certain cases, in order to avoid ambiguities, the syntactic grammar uses generalized productions that permit token sequences that do not form a valid ECMAScriptScript orModule. For example, this technique is used for object literals and object destructuring patterns. In such cases a more restrictivesupplemental grammar is provided that further restricts the acceptable token sequences. Typically, anearly error rule will then define an error condition if "P is notcovering anN", whereP is a Parse Node (an instance of the generalized production) andN is a nonterminal from the supplemental grammar. Here, the sequence of tokens originally matched byP is parsed again usingN as thegoal symbol. (IfN takes grammatical parameters, then they are set to the same values used whenP was originally parsed.) An error occurs if the sequence of tokens cannot be parsed as a single instance ofN, with no tokens left over. Subsequently, algorithms access the result of the parse using a phrase of the form "theN that iscovered byP". This will always be a Parse Node (an instance ofN, unique for a givenP), since any parsing failure would have been detected by anearly error rule.
5.1.5 Grammar Notation
Terminal symbols are shown infixed width font, both in the productions of the grammars and throughout this specification whenever the text directly refers to such a terminal symbol. These are to appear in a script exactly as written. All terminal symbol code points specified in this way are to be understood as the appropriate Unicode code points from the Basic Latin range, as opposed to any similar-looking code points from other Unicode ranges. A code point in a terminal symbol cannot be expressed by a\UnicodeEscapeSequence.
Nonterminal symbols are shown initalic type. The definition of a nonterminal (also called a “production”) is introduced by the name of the nonterminal being defined followed by one or more colons. (The number of colons indicates to which grammar the production belongs.) One or more alternative right-hand sides for the nonterminal then follow on succeeding lines. For example, the syntactic definition:
states that the nonterminalWhileStatement represents the tokenwhile, followed by a left parenthesis token, followed by anExpression, followed by a right parenthesis token, followed by aStatement. The occurrences ofExpression andStatement are themselves nonterminals. As another example, the syntactic definition:
states that anArgumentList may represent either a singleAssignmentExpression or anArgumentList, followed by a comma, followed by anAssignmentExpression. This definition ofArgumentList is recursive, that is, it is defined in terms of itself. The result is that anArgumentList may contain any positive number of arguments, separated by commas, where each argument expression is anAssignmentExpression. Such recursive definitions of nonterminals are common.
The subscripted suffix “opt”, which may appear after a terminal or nonterminal, indicates an optional symbol. The alternative containing the optional symbol actually specifies two right-hand sides, one that omits the optional element and one that includes it. This means that:
so, in this example, the nonterminalForStatement actually has four alternative right-hand sides.
A production may be parameterized by a subscripted annotation of the form “[parameters]”, which may appear as a suffix to the nonterminal symbol defined by the production. “parameters” may be either a single name or a comma separated list of names. A parameterized production is shorthand for a set of productions defining all combinations of the parameter names, preceded by an underscore, appended to the parameterized nonterminal symbol. This means that:
Prefixing a parameter name with “?” on a right-hand side nonterminal reference makes that parameter value dependent upon the occurrence of the parameter name on the reference to the current production's left-hand side symbol. For example:
If a right-hand side alternative is prefixed with “[+parameter]” that alternative is only available if the named parameter was used in referencing the production's nonterminal symbol. If a right-hand side alternative is prefixed with “[~parameter]” that alternative is only available if the named parameter wasnot used in referencing the production's nonterminal symbol. This means that:
When the words “one of” follow the colon(s) in a grammar definition, they signify that each of the terminal symbols on the following line or lines is an alternative definition. For example, the lexical grammar for ECMAScript contains the production:
If the phrase “[empty]” appears as the right-hand side of a production, it indicates that the production's right-hand side contains no terminals or nonterminals.
If the phrase “[lookahead =seq]” appears in the right-hand side of a production, it indicates that the production may only be used if the token sequenceseq is a prefix of the immediately following input token sequence. Similarly, “[lookahead ∈set]”, whereset is a finite nonempty set of token sequences, indicates that the production may only be used if some element ofset is a prefix of the immediately following token sequence. For convenience, the set can also be written as a nonterminal, in which case it represents the set of all token sequences to which that nonterminal could expand. It is considered an editorial error if the nonterminal could expand to infinitely many distinct token sequences.
These conditions may be negated. “[lookahead ≠seq]” indicates that the containing production may only be used ifseq isnot a prefix of the immediately following input token sequence, and “[lookahead ∉set]” indicates that the production may only be used ifno element ofset is a prefix of the immediately following token sequence.
matches either the lettern followed by one or more decimal digits the first of which is even, or a decimal digit not followed by another decimal digit.
Note that when these phrases are used in the syntactic grammar, it may not be possible to unambiguously identify the immediately following token sequence because determining later tokens requires knowing which lexicalgoal symbol to use at later positions. As such, when these are used in the syntactic grammar, it is considered an editorial error for a token sequenceseq to appear in a lookahead restriction (including as part of a set of sequences) if the choices of lexical goal symbols to use could change whether or notseq would be a prefix of the resulting token sequence.
If the phrase “[noLineTerminator here]” appears in the right-hand side of a production of the syntactic grammar, it indicates that the production isa restricted production: it may not be used if aLineTerminator occurs in the input stream at the indicated position. For example, the production:
indicates that the production may not be used if aLineTerminator occurs in the script between thethrow token and theExpression.
Unless the presence of aLineTerminator is forbidden by a restricted production, any number of occurrences ofLineTerminator may appear between any two consecutive tokens in the stream of input elements without affecting the syntactic acceptability of the script.
When an alternative in a production of the lexical grammar or the numeric string grammar appears to be a multi-code point token, it represents the sequence of code points that would make up such a token.
The right-hand side of a production may specify that certain expansions are not permitted by using the phrase “but not” and then indicating the expansions to be excluded. For example, the production:
means that the nonterminalIdentifier may be replaced by any sequence of code points that could replaceIdentifierName provided that the same sequence of code points could not replaceReservedWord.
Finally, a few nonterminal symbols are described by a descriptive phrase in sans-serif type in cases where it would be impractical to list all the alternatives:
The specification often uses a numbered list to specify steps in an algorithm. These algorithms are used to precisely specify the required semantics of ECMAScript language constructs. The algorithms are not intended to imply the use of any specific implementation technique. In practice, there may be more efficient algorithms available to implement a given feature.
Algorithms may be explicitly parameterized with an ordered, comma-separated sequence of alias names which may be used within the algorithm steps to reference the argument passed in that position. Optional parameters are denoted with surrounding brackets ([ ,name ]) and are no different from required parameters within algorithm steps. A rest parameter may appear at the end of a parameter list, denoted with leading ellipsis (, ...name). The rest parameter captures all of the arguments provided following the required and optional parameters into aList. If there are no such additional arguments, thatList is empty.
Algorithm steps may be subdivided into sequential substeps. Substeps are indented and may themselves be further divided into indented substeps. Outline numbering conventions are used to identify substeps with the first level of substeps labelled with lower case alphabetic characters and the second level of substeps labelled with lower case roman numerals. If more than three levels are required these rules repeat with the fourth level using numeric labels. For example:
1.Top-level step
a.Substep.
b.Substep.
i.Subsubstep.
1.Subsubsubstep
a.Subsubsubsubstep
i.Subsubsubsubsubstep
A step or substep may be written as an “if” predicate that conditions its substeps. In this case, the substeps are only applied if the predicate is true. If a step or substep begins with the word “else”, it is a predicate that is the negation of the preceding “if” predicate step at the same level.
A step may specify the iterative application of its substeps.
A step that begins with “Assert:” asserts an invariant condition of its algorithm. Such assertions are used to make explicit algorithmic invariants that would otherwise be implicit. Such assertions add no additional semantic requirements and hence need not be checked by an implementation. They are used simply to clarify algorithms.
Algorithm steps may declare named aliases for any value using the form “Letx besomeValue”. These aliases are reference-like in that bothx andsomeValue refer to the same underlying data and modifications to either are visible to both. Algorithm steps that want to avoid this reference-like behaviour should explicitly make a copy of the right-hand side: “Letx be a copy ofsomeValue” creates a shallow copy ofsomeValue.
Once declared, an alias may be referenced in any subsequent steps and must not be referenced from steps prior to the alias's declaration. Aliases may be modified using the form “Setx tosomeOtherValue”.
5.2.1 Abstract Operations
In order to facilitate their use in multiple parts of this specification, some algorithms, calledabstract operations, are named and written in parameterized functional form so that they may be referenced by name from within other algorithms. Abstract operations are typically referenced using a functional application style such as OperationName(arg1,arg2). Some abstract operations are treated as polymorphically dispatched methods of class-like specification abstractions. Such method-like abstract operations are typically referenced using a method application style such assomeValue.OperationName(arg1,arg2).
5.2.2 Syntax-Directed Operations
Asyntax-directed operation is a named operation whose definition consists of algorithms, each of which is associated with one or more productions from one of the ECMAScript grammars. A production that has multiple alternative definitions will typically have a distinct algorithm for each alternative. When an algorithm is associated with a grammar production, it may reference the terminal and nonterminal symbols of the production alternative as if they were parameters of the algorithm. When used in this manner, nonterminal symbols refer to the actual alternative definition that is matched when parsing the source text. Thesource text matched by a grammar production is the portion of the source text that starts at the beginning of the first terminal that participated in the match and ends at the end of the last terminal that participated in the match.
When an algorithm is associated with a production alternative, the alternative is typically shown without any “[ ]” grammar annotations. Such annotations should only affect the syntactic recognition of the alternative and have no effect on the associated semantics for the alternative.
Syntax-directed operations are invoked with a parse node and, optionally, other parameters by using the conventions on steps1,3, and4 in the following algorithm:
1.Letstatus be SyntaxDirectedOperation ofSomeNonTerminal.
2.LetsomeParseNode be the parse of some source text.
4.Perform SyntaxDirectedOperation ofsomeParseNode passing"value" as the argument.
Unless explicitly specified otherwise, all chain productions have an implicit definition for every operation that might be applied to that production's left-hand side nonterminal. The implicit definition simply reapplies the same operation with the same parameters, if any, to thechain production's sole right-hand side nonterminal and then returns the result. For example, assume that some algorithm has a step of the form: “Return the result of evaluatingBlock” and that there is a production:
but the Evaluation operation does not associate an algorithm with that production. In that case, the Evaluation operation implicitly includes an association of the form:
Algorithms which specify semantics that must be called at runtime are calledruntime semantics. Runtime semantics are defined byabstract operations or syntax-directed operations. Such algorithms always return a completion record.
5.2.3.1 Implicit Completion Values
The algorithms of this specification often implicitly returnCompletion Records whose [[Type]] isnormal. Unless it is otherwise obvious from the context, an algorithm statement that returns a value that is not aCompletion Record, such as:
However, if the value expression of a “return” statement is aCompletion Record construction literal, the resultingCompletion Record is returned. If the value expression is a call to an abstract operation, the “return” statement simply returns theCompletion Record produced by the abstract operation.
The abstract operationCompletion(completionRecord) is used to emphasize that a previously computedCompletion Record is being returned. TheCompletion abstract operation takes a single argument,completionRecord, and performs the following steps:
Similarly, prefix! is used to indicate that the following invocation of an abstract orsyntax-directed operation will never return anabrupt completion and that the resultingCompletion Record's [[Value]] field should be used in place of the return value of the operation. For example, the step:
Context-free grammars are not sufficiently powerful to express all the rules that define whether a stream of input elements form a valid ECMAScriptScript orModule that may be evaluated. In some situations additional rules are needed that may be expressed using either ECMAScript algorithm conventions or prose requirements. Such rules are always associated with a production of a grammar and are called thestatic semantics of the production.
Static Semantic Rules have names and typically are defined using an algorithm. Named Static Semantic Rules are associated with grammar productions and a production that has multiple alternative definitions will typically have for each alternative a distinct algorithm for each applicable named static semantic rule.
A special kind of static semantic rule is anEarly Error Rule.Early error rules defineearly error conditions (see clause17) that are associated with specific grammar productions. Evaluation of mostearly error rules are not explicitly invoked within the algorithms of this specification. A conforming implementation must, prior to the first evaluation of aScript orModule, validate all of theearly error rules of the productions used to parse thatScript orModule. If any of theearly error rules are violated theScript orModule is invalid and cannot be evaluated.
5.2.5 Mathematical Operations
This specification makes reference to these kinds of numeric values:
Mathematical values: Arbitrary real numbers, used as the default numeric type.
Extended mathematical values: Mathematical values together with +∞ and -∞.
Numbers:IEEE 754-2019 double-precision floating point values.
BigInts: ECMAScript values representing arbitrary integers in a one-to-one correspondence.
In the language of this specification, numerical values are distinguished among different numeric kinds using subscript suffixes. The subscript𝔽 refers to Numbers, and the subscriptℤ refers to BigInts. Numeric values without a subscript suffix refer to mathematical values.
Numeric operators such as +, ×, =, and ≥ refer to those operations as determined by the type of the operands. When applied to mathematical values, the operators refer to the usual mathematical operations. When applied to Numbers, the operators refer to the relevant operations withinIEEE 754-2019. When applied to BigInts, the operators refer to the usual mathematical operations applied to themathematical value of the BigInt.
In general, when this specification refers to a numerical value, such as in the phrase, "the length ofy" or "theinteger represented by the four hexadecimal digits ...", without explicitly specifying a numeric kind, the phrase refers to amathematical value. Phrases which refer to a Number or a BigInt value are explicitly annotated as such; for example, "theNumber value for the number of code points in …" or "the BigInt value for …".
Numeric operators applied to mixed-type operands (such as a Number and amathematical value) are not defined and should be considered an editorial error in this specification.
This specification denotes most numeric values in base 10; it also uses numeric values of the form 0x followed by digits 0-9 or A-F as base-16 values.
When the terminteger is used in this specification, it refers to amathematical value which is in the set of integers, unless otherwise stated. When the termintegral Number is used in this specification, it refers to aNumber value whosemathematical value is in the set of integers.
Conversions between mathematical values and Numbers or BigInts are always explicit in this document. A conversion from amathematical value orextended mathematical valuex to a Number is denoted as "theNumber value forx" or𝔽(x), and is defined in6.1.6.1. A conversion from anintegerx to a BigInt is denoted as "the BigInt value forx" orℤ(x). A conversion from a Number or BigIntx to amathematical value is denoted as "themathematical value ofx", orℝ(x). Themathematical value of+0𝔽 and-0𝔽 is themathematical value 0. Themathematical value of non-finite values is not defined. Theextended mathematical value ofx is themathematical value ofx for finite values, and is +∞ and -∞ for+∞𝔽 and-∞𝔽 respectively; it is not defined forNaN.
The mathematical functionabs(x) produces the absolute value ofx, which is-x ifx < 0 and otherwise isx itself.
The mathematical functionmin(x1,x2, … ,xN) produces the mathematically smallest ofx1 throughxN. The mathematical functionmax(x1,x2, ...,xN) produces the mathematically largest ofx1 throughxN. The domain and range of these mathematical functions are the extended mathematical values.
The notation “x moduloy” (y must be finite and non-zero) computes a valuek of the same sign asy (or zero) such thatabs(k) <abs(y) andx -k =q ×y for someintegerq.
The phrase "the result ofclampingx betweenlower andupper" (wherex is anextended mathematical value andlower andupper are mathematical values such thatlower ≤upper) produceslower ifx <lower, producesupper ifx >upper, and otherwise producesx.
The mathematical functionfloor(x) produces the largestinteger (closest to +∞) that is not larger thanx.
Mathematical functions min, max,abs, andfloor are not defined for Numbers and BigInts, and any usage of those methods that have non-mathematical value arguments would be an editorial error in this specification.
In this specification, ECMAScript language values are displayed inbold. Examples includenull,true, or"hello". These are distinguished from longer ECMAScript code sequences such asFunction.prototype.apply orlet n = 42;.
Values which are internal to the specification and not directly observable from ECMAScript code are indicated with asans-serif typeface. For instance, aCompletion Record's [[Type]] field takes on values likenormal,return, orthrow.
6 ECMAScript Data Types and Values
Algorithms within this specification manipulate values each of which has an associated type. The possible value types are exactly those defined in this clause. Types are further subclassified into ECMAScript language types and specification types.
Within this specification, the notation “Type(x)” is used as shorthand for “thetype ofx” where “type” refers to the ECMAScript language and specification types defined in this clause. When the term “empty” is used as if it was naming a value, it is equivalent to saying “no value of any type”.
6.1 ECMAScript Language Types
AnECMAScript language type corresponds to values that are directly manipulated by an ECMAScript programmer using the ECMAScript language. The ECMAScript language types are Undefined, Null, Boolean, String, Symbol, Number, BigInt, and Object. AnECMAScript language value is a value that is characterized by an ECMAScript language type.
6.1.1 The Undefined Type
The Undefined type has exactly one value, calledundefined. Any variable that has not been assigned a value has the valueundefined.
6.1.2 The Null Type
The Null type has exactly one value, callednull.
6.1.3 The Boolean Type
The Boolean type represents a logical entity having two values, calledtrue andfalse.
6.1.4 The String Type
The String type is the set of all ordered sequences of zero or more 16-bit unsignedinteger values (“elements”) up to a maximum length of 253 - 1 elements. The String type is generally used to represent textual data in a running ECMAScript program, in which case each element in the String is treated as a UTF-16 code unit value. Each element is regarded as occupying a position within the sequence. These positions are indexed with non-negative integers. The first element (if any) is at index 0, the next element (if any) at index 1, and so on. The length of a String is the number of elements (i.e., 16-bit values) within it. The empty String has length zero and therefore contains no elements.
ECMAScript operations that do not interpret String contents apply no further semantics. Operations that do interpret String values treat each element as a single UTF-16 code unit. However, ECMAScript does not restrict the value of or relationships between these code units, so operations that further interpret String contents as sequences of Unicode code points encoded in UTF-16 must account for ill-formed subsequences. Such operations apply special treatment to every code unit with a numeric value in the inclusive range 0xD800 to 0xDBFF (defined by the Unicode Standard as aleading surrogate, or more formally as ahigh-surrogate code unit) and every code unit with a numeric value in the inclusive range 0xDC00 to 0xDFFF (defined as atrailing surrogate, or more formally as alow-surrogate code unit) using the following rules:
A sequence of two code units, where the first code unitc1 is aleading surrogate and the second code unitc2 atrailing surrogate, is asurrogate pair and is interpreted as a code point with the value (c1 - 0xD800) × 0x400 + (c2 - 0xDC00) + 0x10000. (See11.1.3)
The functionString.prototype.normalize (see22.1.3.13) can be used to explicitly normalize a String value.String.prototype.localeCompare (see22.1.3.10) internally normalizes String values, but no other operations implicitly normalize the strings upon which they operate. Only operations that are explicitly specified to be language or locale sensitive produce language-sensitive results.
Note
The rationale behind this design was to keep the implementation of Strings as simple and high-performing as possible. If ECMAScript source text is in Normalized Form C, string literals are guaranteed to also be normalized, as long as they do not contain any Unicode escape sequences.
In this specification, the phrase "thestring-concatenation ofA,B, ..." (where each argument is a String value, a code unit, or a sequence of code units) denotes the String value whose sequence of code units is the concatenation of the code units (in order) of each of the arguments (in order).
The phrase "thesubstring ofS frominclusiveStart toexclusiveEnd" (whereS is a String value or a sequence of code units andinclusiveStart andexclusiveEnd are integers) denotes the String value consisting of the consecutive code units ofS beginning at indexinclusiveStart and ending immediately before indexexclusiveEnd (which is the empty String wheninclusiveStart =exclusiveEnd). If the "to" suffix is omitted, the length ofS is used as the value ofexclusiveEnd.
The abstract operation StringIndexOf takes argumentsstring (a String),searchValue (a String), andfromIndex (a non-negativeinteger). It performs the following steps when called:
5.IfsearchValue is the empty String andfromIndex ≤len, returnfromIndex.
6.LetsearchLen be the length ofsearchValue.
7.For eachintegeri starting withfromIndex such thati ≤len -searchLen, in ascending order, do
a.Letcandidate be thesubstring ofstring fromi toi +searchLen.
b.Ifcandidate is the same sequence of code units assearchValue, returni.
8.Return -1.
Note 1
IfsearchValue is the empty String andfromIndex is less than or equal to the length ofstring, this algorithm returnsfromIndex. The empty String is effectively found at every position within a string, including after the last code unit.
Note 2
This algorithm always returns -1 iffromIndex > the length ofstring.
6.1.5 The Symbol Type
The Symbol type is the set of all non-String values that may be used as the key of an Object property (6.1.7).
Each possible Symbol value is unique and immutable.
Each Symbol value immutably holds an associated value called [[Description]] that is eitherundefined or a String value.
6.1.5.1 Well-Known Symbols
Well-known symbols are built-in Symbol values that are explicitly referenced by algorithms of this specification. They are typically used as the keys of properties whose values serve as extension points of a specification algorithm. Unless otherwise specified, well-known symbols values are shared by all realms (9.2).
Within this specification a well-known symbol is referred to by using a notation of the form @@name, where “name” is one of the values listed inTable 1.
Table 1: Well-known Symbols
Specification Name
[[Description]]
Value and Purpose
@@asyncIterator
"Symbol.asyncIterator"
A method that returns the default AsyncIterator for an object. Called by the semantics of thefor-await-of statement.
@@hasInstance
"Symbol.hasInstance"
A method that determines if aconstructor object recognizes an object as one of theconstructor's instances. Called by the semantics of theinstanceof operator.
@@isConcatSpreadable
"Symbol.isConcatSpreadable"
A Boolean valued property that if true indicates that an object should be flattened to its array elements byArray.prototype.concat.
@@iterator
"Symbol.iterator"
A method that returns the default Iterator for an object. Called by the semantics of the for-of statement.
@@match
"Symbol.match"
A regular expression method that matches the regular expression against a string. Called by theString.prototype.match method.
@@matchAll
"Symbol.matchAll"
A regular expression method that returns an iterator, that yields matches of the regular expression against a string. Called by theString.prototype.matchAll method.
@@replace
"Symbol.replace"
A regular expression method that replaces matched substrings of a string. Called by theString.prototype.replace method.
@@search
"Symbol.search"
A regular expression method that returns the index within a string that matches the regular expression. Called by theString.prototype.search method.
@@species
"Symbol.species"
A function valued property that is theconstructor function that is used to create derived objects.
@@split
"Symbol.split"
A regular expression method that splits a string at the indices that match the regular expression. Called by theString.prototype.split method.
@@toPrimitive
"Symbol.toPrimitive"
A method that converts an object to a corresponding primitive value. Called by theToPrimitive abstract operation.
@@toStringTag
"Symbol.toStringTag"
A String valued property that is used in the creation of the default string description of an object. Accessed by the built-in methodObject.prototype.toString.
@@unscopables
"Symbol.unscopables"
An object valued property whose own and inherited property names are property names that are excluded from thewith environment bindings of the associated object.
6.1.6 Numeric Types
ECMAScript has two built-in numeric types: Number and BigInt. In this specification, every numeric typeT contains a multiplicative identity value denotedT::unit. The specification types also have the followingabstract operations, likewise denotedT::op for a given operation with specification nameop. All argument types areT. The "Result" column shows the return type, along with an indication if it is possible for some invocations of the operation to return anabrupt completion.
TheT::unit value andT::op operations are not a part of the ECMAScript language; they are defined here solely to aid the specification of the semantics of the ECMAScript language. Otherabstract operations are defined throughout this specification.
Because the numeric types are in general not convertible without loss of precision or truncation, the ECMAScript language provides no implicit conversion among these types. Programmers must explicitly callNumber andBigInt functions to convert among types when calling a function which requires another type.
Note
The first and subsequent editions of ECMAScript have provided, for certain operators, implicit numeric conversions that could lose precision or truncate. These legacy implicit conversions are maintained for backward compatibility, but not provided for BigInt in order to minimize opportunity for programmer error, and to leave open the option of generalizedvalue types in a future edition.
6.1.6.1 The Number Type
The Number type has exactly 18,437,736,874,454,810,627 (that is,264 - 253 + 3) values, representing the double-precision 64-bit formatIEEE 754-2019 values as specified in the IEEE Standard for Binary Floating-Point Arithmetic, except that the 9,007,199,254,740,990 (that is,253 - 2) distinct “Not-a-Number” values of the IEEE Standard are represented in ECMAScript as a single specialNaN value. (Note that theNaN value is produced by the program expressionNaN.) In some implementations, external code might be able to detect a difference between various Not-a-Number values, but such behaviour isimplementation-defined; to ECMAScript code, allNaN values are indistinguishable from each other.
Note
The bit pattern that might be observed in an ArrayBuffer (see25.1) or a SharedArrayBuffer (see25.2) after aNumber value has been stored into it is not necessarily the same as the internal representation of thatNumber value used by the ECMAScript implementation.
There are two other special values, calledpositive Infinity andnegative Infinity. For brevity, these values are also referred to for expository purposes by the symbols+∞𝔽 and-∞𝔽, respectively. (Note that these two infinite Number values are produced by the program expressions+Infinity (or simplyInfinity) and-Infinity.)
The other 18,437,736,874,454,810,624 (that is,264 - 253) values are called the finite numbers. Half of these are positive numbers and half are negative numbers; for every finite positiveNumber value there is a corresponding negative value having the same magnitude.
Note that there is both apositive zero and anegative zero. For brevity, these values are also referred to for expository purposes by the symbols+0𝔽 and-0𝔽, respectively. (Note that these two different zero Number values are produced by the program expressions+0 (or simply0) and-0.)
The 18,437,736,874,454,810,622 (that is,264 - 253 - 2) finite non-zero values are of two kinds:
18,428,729,675,200,069,632 (that is,264 - 254) of them are normalized, having the form
s ×m × 2e
wheres is 1 or -1,m is aninteger such that 252 ≤m < 253, ande is aninteger such that -1074 ≤e ≤ 971.
The remaining 9,007,199,254,740,990 (that is,253 - 2) values are denormalized, having the form
s ×m × 2e
wheres is 1 or -1,m is aninteger such that 0 <m < 252, ande is -1074.
Note that all the positive and negative integers whose magnitude is no greater than 253 are representable in the Number type. Theinteger 0 has two representations in the Number type:+0𝔽 and-0𝔽.
A finite number has anodd significand if it is non-zero and theintegerm used to express it (in one of the two forms shown above) is odd. Otherwise, it has aneven significand.
In this specification, the phrase “theNumber value forx” wherex represents an exact real mathematical quantity (which might even be an irrational number such as π) means aNumber value chosen in the following manner. Consider the set of all finite values of the Number type, with-0𝔽 removed and with two additional values added to it that are not representable in the Number type, namely 21024 (which is+1 × 253 × 2971) and-21024 (which is-1 × 253 × 2971). Choose the member of this set that is closest in value tox. If two values of the set are equally close, then the one with an even significand is chosen; for this purpose, the two extra values 21024 and-21024 are considered to have even significands. Finally, if 21024 was chosen, replace it with+∞𝔽; if-21024 was chosen, replace it with-∞𝔽; if+0𝔽 was chosen, replace it with-0𝔽 if and only ifx < 0; any other chosen value is used unchanged. The result is theNumber value forx. (This procedure corresponds exactly to the behaviour of theIEEE 754-2019 roundTiesToEven mode.)
Some ECMAScript operators deal only with integers in specific ranges such as-231 through231 - 1, inclusive, or in the range 0 through216 - 1, inclusive. These operators accept any value of the Number type but first convert each such value to aninteger value in the expected range. See the descriptions of the numeric conversion operations in7.1.
The Number::unit value is1𝔽.
6.1.6.1.1 Number::unaryMinus (x )
The abstract operation Number::unaryMinus takes argumentx (a Number). It performs the following steps when called:
1.Ifx isNaN, returnNaN.
2.Return the result of negatingx; that is, compute a Number with the same magnitude but opposite sign.
6.1.6.1.2 Number::bitwiseNOT (x )
The abstract operation Number::bitwiseNOT takes argumentx (a Number). It performs the following steps when called:
2.Return the result of applying bitwise complement tooldValue. Themathematical value of the result is exactly representable as a 32-bit two's complement bit string.
6.1.6.1.3 Number::exponentiate (base,exponent )
The abstract operation Number::exponentiate takes argumentsbase (a Number) andexponent (a Number). It returns animplementation-approximated value representing the result of raisingbase to theexponent power. It performs the following steps when called:
The result ofbase**exponent whenbase is1𝔽 or-1𝔽 andexponent is+∞𝔽 or-∞𝔽, or whenbase is1𝔽 andexponent isNaN, differs fromIEEE 754-2019. The first edition of ECMAScript specified a result ofNaN for this operation, whereas later versions ofIEEE 754-2019 specified1𝔽. The historical ECMAScript behaviour is preserved for compatibility reasons.
6.1.6.1.4 Number::multiply (x,y )
The abstract operation Number::multiply takes argumentsx (a Number) andy (a Number). It performs multiplication according to the rules ofIEEE 754-2019 binary double-precision arithmetic, producing the product ofx andy. It performs the following steps when called:
Finite-precision multiplication is commutative, but not always associative.
6.1.6.1.5 Number::divide (x,y )
The abstract operation Number::divide takes argumentsx (a Number) andy (a Number). It performs division according to the rules ofIEEE 754-2019 binary double-precision arithmetic, producing the quotient ofx andy wherex is the dividend andy is the divisor. It performs the following steps when called:
The abstract operation Number::remainder takes argumentsn (a Number) andd (a Number). It yields the remainder from an implied division of its operands wheren is the dividend andd is the divisor. It performs the following steps when called:
7.Letr beℝ(n) - (ℝ(d) ×q) whereq is aninteger that is negative if and only ifn andd have opposite sign, and whose magnitude is as large as possible without exceeding the magnitude ofℝ(n) /ℝ(d).
In C and C++, the remainder operator accepts only integral operands; in ECMAScript, it also accepts floating-point operands.
Note 2
The result of a floating-point remainder operation as computed by the% operator is not the same as the “remainder” operation defined byIEEE 754-2019. TheIEEE 754-2019 “remainder” operation computes the remainder from a rounding division, not a truncating division, and so its behaviour is not analogous to that of the usualinteger remainder operator. Instead the ECMAScript language defines% on floating-point operations to behave in a manner analogous to that of the Javainteger remainder operator; this may be compared with the C library function fmod.
6.1.6.1.7 Number::add (x,y )
The abstract operation Number::add takes argumentsx (a Number) andy (a Number). It performs addition according to the rules ofIEEE 754-2019 binary double-precision arithmetic, producing the sum of its arguments. It performs the following steps when called:
Finite-precision addition is commutative, but not always associative.
6.1.6.1.8 Number::subtract (x,y )
The abstract operation Number::subtract takes argumentsx (a Number) andy (a Number). It performs subtraction, producing the difference of its operands;x is the minuend andy is the subtrahend. It performs the following steps when called:
1.Return Number::add(x, Number::unaryMinus(y)).
Note
It is always the case thatx - y produces the same result asx + (-y).
6.1.6.1.9 Number::leftShift (x,y )
The abstract operation Number::leftShift takes argumentsx (a Number) andy (a Number). It performs the following steps when called:
4.Return the result of left shiftinglnum byshiftCount bits. Themathematical value of the result is exactly representable as a 32-bit two's complement bit string.
6.1.6.1.10 Number::signedRightShift (x,y )
The abstract operation Number::signedRightShift takes argumentsx (a Number) andy (a Number). It performs the following steps when called:
4.Return the result of performing a sign-extending right shift oflnum byshiftCount bits. The most significant bit is propagated. Themathematical value of the result is exactly representable as a 32-bit two's complement bit string.
6.1.6.1.11 Number::unsignedRightShift (x,y )
The abstract operation Number::unsignedRightShift takes argumentsx (a Number) andy (a Number). It performs the following steps when called:
4.Return the result of performing a zero-filling right shift oflnum byshiftCount bits. Vacated bits are filled with zero. Themathematical value of the result is exactly representable as a 32-bit unsigned bit string.
6.1.6.1.12 Number::lessThan (x,y )
The abstract operation Number::lessThan takes argumentsx (a Number) andy (a Number). It performs the following steps when called:
5.Otherwise, letn,k, ands be integers such thatk ≥ 1, 10k - 1 ≤s < 10k,s × 10n -k isℝ(x), andk is as small as possible. Note thatk is the number of digits in the decimal representation ofs, thats is not divisible by 10, and that the least significant digit ofs is not necessarily uniquely determined by these criteria.
The least significant digit of s is not always uniquely determined by the requirements listed in step5.
Note 2
For implementations that provide more accurate conversions than required by the rules above, it is recommended that the following alternative version of step5 be used as a guideline:
1.Otherwise, letn,k, ands be integers such thatk ≥ 1, 10k - 1 ≤s < 10k,s × 10n -k isℝ(x), andk is as small as possible. If there are multiple possibilities fors, choose the value ofs for whichs × 10n -k is closest in value toℝ(x). If there are two such possible values ofs, choose the one that is even. Note thatk is the number of digits in the decimal representation ofs and thats is not divisible by 10.
Note 3
Implementers of ECMAScript may find useful the paper and code written by David M. Gay for binary-to-decimal conversion of floating-point numbers:
The BigInt type represents aninteger value. The value may be any size and is not limited to a particular bit-width. Generally, where not otherwise noted, operations are designed to return exact mathematically-based answers. For binary operations, BigInts act as two's complement binary strings, with negative numbers treated as having bits set infinitely to the left.
The BigInt::unit value is1ℤ.
6.1.6.2.1 BigInt::unaryMinus (x )
The abstract operation BigInt::unaryMinus takes argumentx (a BigInt). It performs the following steps when called:
1.Ifx is0ℤ, return0ℤ.
2.Return the BigInt value that represents the negation ofℝ(x).
6.1.6.2.2 BigInt::bitwiseNOT (x )
The abstract operation BigInt::bitwiseNOT takes argumentx (a BigInt). It returns the one's complement ofx; that is, -x -1ℤ.
6.1.6.2.3 BigInt::exponentiate (base,exponent )
The abstract operation BigInt::exponentiate takes argumentsbase (a BigInt) andexponent (a BigInt). It performs the following steps when called:
1.Ifexponent <0ℤ, throw aRangeError exception.
2.Ifbase is0ℤ andexponent is0ℤ, return1ℤ.
3.Return the BigInt value that representsℝ(base) raised to the powerℝ(exponent).
6.1.6.2.4 BigInt::multiply (x,y )
The abstract operation BigInt::multiply takes argumentsx (a BigInt) andy (a BigInt). It returns the BigInt value that represents the result of multiplyingx andy.
Note
Even if the result has a much larger bit width than the input, the exact mathematical answer is given.
6.1.6.2.5 BigInt::divide (x,y )
The abstract operation BigInt::divide takes argumentsx (a BigInt) andy (a BigInt). It performs the following steps when called:
3.Return the BigInt value that representsquotient rounded towards 0 to the nextinteger value.
6.1.6.2.6 BigInt::remainder (n,d )
The abstract operation BigInt::remainder takes argumentsn (a BigInt) andd (a BigInt). It performs the following steps when called:
1.Ifd is0ℤ, throw aRangeError exception.
2.Ifn is0ℤ, return0ℤ.
3.Letr be the BigInt defined by the mathematical relationr =n - (d ×q) whereq is a BigInt that is negative only ifn/d is negative and positive only ifn/d is positive, and whose magnitude is as large as possible without exceeding the magnitude of the true mathematical quotient ofn andd.
4.Returnr.
Note
The sign of the result equals the sign of the dividend.
6.1.6.2.7 BigInt::add (x,y )
The abstract operation BigInt::add takes argumentsx (a BigInt) andy (a BigInt). It returns the BigInt value that represents the sum ofx andy.
6.1.6.2.8 BigInt::subtract (x,y )
The abstract operation BigInt::subtract takes argumentsx (a BigInt) andy (a BigInt). It returns the BigInt value that represents the differencex minusy.
6.1.6.2.9 BigInt::leftShift (x,y )
The abstract operation BigInt::leftShift takes argumentsx (a BigInt) andy (a BigInt). It performs the following steps when called:
1.Ify <0ℤ, then
a.Return the BigInt value that representsℝ(x) / 2-y, rounding down to the nearestinteger, including for negative numbers.
2.Return the BigInt value that representsℝ(x) × 2y.
Note
Semantics here should be equivalent to a bitwise shift, treating the BigInt as an infinite length string of binary two's complement digits.
6.1.6.2.10 BigInt::signedRightShift (x,y )
The abstract operation BigInt::signedRightShift takes argumentsx (a BigInt) andy (a BigInt). It performs the following steps when called:
1.Return BigInt::leftShift(x, -y).
6.1.6.2.11 BigInt::unsignedRightShift (x,y )
The abstract operation BigInt::unsignedRightShift takes argumentsx (a BigInt) andy (a BigInt). It performs the following steps when called:
1.Throw aTypeError exception.
6.1.6.2.12 BigInt::lessThan (x,y )
The abstract operation BigInt::lessThan takes argumentsx (a BigInt) andy (a BigInt). It returnstrue ifℝ(x) <ℝ(y) andfalse otherwise.
6.1.6.2.13 BigInt::equal (x,y )
The abstract operation BigInt::equal takes argumentsx (a BigInt) andy (a BigInt). It returnstrue ifℝ(x) =ℝ(y) andfalse otherwise.
6.1.6.2.14 BigInt::sameValue (x,y )
The abstract operation BigInt::sameValue takes argumentsx (a BigInt) andy (a BigInt). It performs the following steps when called:
1.Return BigInt::equal(x,y).
6.1.6.2.15 BigInt::sameValueZero (x,y )
The abstract operation BigInt::sameValueZero takes argumentsx (a BigInt) andy (a BigInt). It performs the following steps when called:
1.Return BigInt::equal(x,y).
6.1.6.2.16 BinaryAnd (x,y )
The abstract operation BinaryAnd takes argumentsx andy. It performs the following steps when called:
The abstract operation BigIntBitwiseOp takes argumentsop (a sequence of Unicode code points),x (a BigInt), andy (a BigInt). It performs the following steps when called:
2.Return the String value consisting of the code units of the digits of the decimal representation ofx.
6.1.7 The Object Type
An Object is logically a collection of properties. Each property is either a data property, or an accessor property:
Adata property associates a key value with anECMAScript language value and a set of Boolean attributes.
Anaccessor property associates a key value with one or two accessor functions, and a set of Boolean attributes. The accessor functions are used to store or retrieve anECMAScript language value that is associated with the property.
Properties are identified using key values. A property key value is either an ECMAScript String value or a Symbol value. All String and Symbol values, including the empty String, are valid as property keys. Aproperty name is a property key that is a String value.
Aninteger index is a String-valued property key that is a canonical numeric String (see7.1.21) and whose numeric value is either+0𝔽 or a positiveintegral Number ≤𝔽(253 - 1). Anarray index is aninteger index whose numeric valuei is in the range+0𝔽 ≤i <𝔽(232 - 1).
Property keys are used to access properties and their values. There are two kinds of access for properties:get andset, corresponding to value retrieval and assignment, respectively. The properties accessible via get and set access includes bothown properties that are a direct part of an object andinherited properties which are provided by another associated object via a property inheritance relationship. Inherited properties may be either own or inherited properties of the associated object. Each own property of an object must each have a key value that is distinct from the key values of the other own properties of that object.
All objects are logically collections of properties, but there are multiple forms of objects that differ in their semantics for accessing and manipulating their properties. Please see6.1.7.2 for definitions of the multiple forms of objects.
6.1.7.1 Property Attributes
Attributes are used in this specification to define and explain the state of Object properties. Adata property associates a key value with the attributes listed inTable 3.
The value retrieved by a get access of the property.
[[Writable]]
Boolean
Iffalse, attempts by ECMAScript code to change the property's [[Value]] attribute using [[Set]] will not succeed.
[[Enumerable]]
Boolean
Iftrue, the property will be enumerated by a for-in enumeration (see14.7.5). Otherwise, the property is said to be non-enumerable.
[[Configurable]]
Boolean
Iffalse, attempts to delete the property, change the property to be anaccessor property, or change its attributes (other than [[Value]], or changing [[Writable]] tofalse) will fail.
If the value is an Object it must be afunction object. The function's [[Call]] internal method (Table 7) is called with an empty arguments list to retrieve the property value each time a get access of the property is performed.
[[Set]]
Object | Undefined
If the value is an Object it must be afunction object. The function's [[Call]] internal method (Table 7) is called with an arguments list containing the assigned value as its sole argument each time a set access of the property is performed. The effect of a property's [[Set]] internal method may, but is not required to, have an effect on the value returned by subsequent calls to the property's [[Get]] internal method.
[[Enumerable]]
Boolean
Iftrue, the property is to be enumerated by a for-in enumeration (see14.7.5). Otherwise, the property is said to be non-enumerable.
[[Configurable]]
Boolean
Iffalse, attempts to delete the property, change the property to be adata property, or change its attributes will fail.
If the initial values of a property's attributes are not explicitly specified by this specification, the default value defined inTable 5 is used.
Table 5: Default Attribute Values
Attribute Name
Default Value
[[Value]]
undefined
[[Get]]
undefined
[[Set]]
undefined
[[Writable]]
false
[[Enumerable]]
false
[[Configurable]]
false
6.1.7.2 Object Internal Methods and Internal Slots
The actual semantics of objects, in ECMAScript, are specified via algorithms calledinternal methods. Each object in an ECMAScript engine is associated with a set of internal methods that defines its runtime behaviour. These internal methods are not part of the ECMAScript language. They are defined by this specification purely for expository purposes. However, each object within an implementation of ECMAScript must behave as specified by the internal methods associated with it. The exact manner in which this is accomplished is determined by the implementation.
Internal method names are polymorphic. This means that different object values may perform different algorithms when a common internal method name is invoked upon them. That actual object upon which an internal method is invoked is the “target” of the invocation. If, at runtime, the implementation of an algorithm attempts to use an internal method of an object that the object does not support, aTypeError exception is thrown.
Internal slots correspond to internal state that is associated with objects and used by various ECMAScript specification algorithms. Internal slots are not object properties and they are not inherited. Depending upon the specific internal slot specification, such state may consist of values of anyECMAScript language type or of specific ECMAScript specification type values. Unless explicitly specified otherwise, internal slots are allocated as part of the process of creating an object and may not be dynamically added to an object. Unless specified otherwise, the initial value of an internal slot is the valueundefined. Various algorithms within this specification create objects that have internal slots. However, the ECMAScript language provides no direct way to associate internal slots with an object.
Internal methods and internal slots are identified within this specification using names enclosed in double square brackets [[ ]].
Table 6 summarizes theessential internal methods used by this specification that are applicable to all objects created or manipulated by ECMAScript code. Every object must have algorithms for all of the essential internal methods. However, all objects do not necessarily use the same algorithms for those methods.
Anordinary object is an object that satisfies all of the following criteria:
For the internal methods listed inTable 6, the object uses those defined in10.1.
If the object has a [[Call]] internal method, it uses the one defined in10.2.1.
If the object has a [[Construct]] internal method, it uses the one defined in10.2.2.
This specification recognizes different kinds of exotic objects by those objects' internal methods. An object that is behaviourally equivalent to a particular kind ofexotic object (such as anArray exotic object or abound function exotic object), but does not have the same collection of internal methods specified for that kind, is not recognized as that kind ofexotic object.
The “Signature” column ofTable 6 and other similar tables describes the invocation pattern for each internal method. The invocation pattern always includes a parenthesized list of descriptive parameter names. If a parameter name is the same as an ECMAScript type name then the name describes the required type of the parameter value. If an internal method explicitly returns a value, its parameter list is followed by the symbol “→” and the type name of the returned value. The type names used in signatures refer to the types defined in clause6 augmented by the following additional names. “any” means the value may be anyECMAScript language type.
In addition to its parameters, an internal method always has access to the object that is the target of the method invocation.
An internal method implicitly returns aCompletion Record, either a normal completion that wraps a value of the return type shown in its invocation pattern, or a throw completion.
Table 6: Essential Internal Methods
Internal Method
Signature
Description
[[GetPrototypeOf]]
( )→ Object | Null
Determine the object that provides inherited properties for this object. Anull value indicates that there are no inherited properties.
[[SetPrototypeOf]]
(Object | Null)→ Boolean
Associate this object with another object that provides inherited properties. Passingnull indicates that there are no inherited properties. Returnstrue indicating that the operation was completed successfully orfalse indicating that the operation was not successful.
[[IsExtensible]]
( )→ Boolean
Determine whether it is permitted to add additional properties to this object.
[[PreventExtensions]]
( )→ Boolean
Control whether new properties may be added to this object. Returnstrue if the operation was successful orfalse if the operation was unsuccessful.
Return aProperty Descriptor for the own property of this object whose key ispropertyKey, orundefined if no such property exists.
[[DefineOwnProperty]]
(propertyKey,PropertyDescriptor)→ Boolean
Create or alter the own property, whose key ispropertyKey, to have the state described byPropertyDescriptor. Returntrue if that property was successfully created/updated orfalse if the property could not be created or updated.
[[HasProperty]]
(propertyKey)→ Boolean
Return a Boolean value indicating whether this object already has either an own or inherited property whose key ispropertyKey.
[[Get]]
(propertyKey,Receiver)→any
Return the value of the property whose key ispropertyKey from this object. If any ECMAScript code must be executed to retrieve the property value,Receiver is used as thethis value when evaluating the code.
[[Set]]
(propertyKey,value,Receiver)→ Boolean
Set the value of the property whose key ispropertyKey tovalue. If any ECMAScript code must be executed to set the property value,Receiver is used as thethis value when evaluating the code. Returnstrue if the property value was set orfalse if it could not be set.
[[Delete]]
(propertyKey)→ Boolean
Remove the own property whose key ispropertyKey from this object. Returnfalse if the property was not deleted and is still present. Returntrue if the property was deleted or is not present.
Return aList whose elements are all of the own property keys for the object.
Table 7 summarizes additional essential internal methods that are supported by objects that may be called as functions. Afunction object is an object that supports the [[Call]] internal method. Aconstructor is an object that supports the [[Construct]] internal method. Every object that supports [[Construct]] must support [[Call]]; that is, everyconstructor must be afunction object. Therefore, aconstructor may also be referred to as aconstructor function orconstructorfunction object.
Table 7: Additional Essential Internal Methods of Function Objects
Executes code associated with this object. Invoked via a function call expression. The arguments to the internal method are athis value and aList whose elements are the arguments passed to the function by a call expression. Objects that implement this internal method arecallable.
Creates an object. Invoked via thenew operator or asuper call. The first argument to the internal method is aList whose elements are the arguments of theconstructor invocation or thesuper call. The second argument is the object to which thenew operator was initially applied. Objects that implement this internal method are calledconstructors. Afunction object is not necessarily aconstructor and such non-constructor function objects do not have a [[Construct]] internal method.
The semantics of the essential internal methods for ordinary objects and standard exotic objects are specified in clause10. If any specified use of an internal method of anexotic object is not supported by an implementation, that usage must throw aTypeError exception when attempted.
6.1.7.3 Invariants of the Essential Internal Methods
The Internal Methods of Objects of an ECMAScript engine must conform to the list of invariants specified below. Ordinary ECMAScript Objects as well as all standard exotic objects in this specification maintain these invariants. ECMAScript Proxy objects maintain these invariants by means of runtime checks on the result of traps invoked on the [[ProxyHandler]] object.
Any implementation provided exotic objects must also maintain these invariants for those objects. Violation of these invariants may cause ECMAScript code to have unpredictable behaviour and create security issues. However, violation of these invariants must never compromise the memory safety of an implementation.
An implementation must not allow these invariants to be circumvented in any manner such as by providing alternative interfaces that implement the functionality of the essential internal methods without enforcing their invariants.
Definitions:
Thetarget of an internal method is the object upon which the internal method is called.
A target isnon-extensible if it has been observed to returnfalse from its [[IsExtensible]] internal method, ortrue from its [[PreventExtensions]] internal method.
Anon-existent property is a property that does not exist as an own property on a non-extensible target.
All references toSameValue are according to the definition of theSameValue algorithm.
Return value:
The value returned by any internal method must be aCompletion Record with either:
[[Type]] =normal, [[Target]] =empty, and [[Value]] = a value of the "normal return type" shown below for that internal method, or
An internal method must not return a completion with [[Type]] =continue,break, orreturn.
[[GetPrototypeOf]] ( )
The normal return type is either Object or Null.
If target is non-extensible, and [[GetPrototypeOf]] returns a valueV, then any future calls to [[GetPrototypeOf]] should return theSameValue asV.
Note 2
An object's prototype chain should have finite length (that is, starting from any object, recursively applying the [[GetPrototypeOf]] internal method to its result should eventually lead to the valuenull). However, this requirement is not enforceable as an object level invariant if the prototype chain includes any exotic objects that do not use theordinary object definition of [[GetPrototypeOf]]. Such a circular prototype chain may result in infinite loops when accessing object properties.
[[SetPrototypeOf]] (V )
The normal return type is Boolean.
If target is non-extensible, [[SetPrototypeOf]] must returnfalse, unlessV is theSameValue as the target's observed [[GetPrototypeOf]] value.
[[IsExtensible]] ( )
The normal return type is Boolean.
If [[IsExtensible]] returnsfalse, all future calls to [[IsExtensible]] on the target must returnfalse.
[[PreventExtensions]] ( )
The normal return type is Boolean.
If [[PreventExtensions]] returnstrue, all future calls to [[IsExtensible]] on the target must returnfalse and the target is now considered non-extensible.
IfP is described as a non-configurable, non-writable owndata property, all future calls to [[GetOwnProperty]] (P ) must returnProperty Descriptor whose [[Value]] isSameValue asP's [[Value]] attribute.
IfP's attributes other than [[Writable]] may change over time or if the property might be deleted, thenP's [[Configurable]] attribute must betrue.
If the [[Writable]] attribute may change fromfalse totrue, then the [[Configurable]] attribute must betrue.
If the target is non-extensible andP is non-existent, then all future calls to [[GetOwnProperty]] (P) on the target must describeP as non-existent (i.e. [[GetOwnProperty]] (P) must returnundefined).
Note 3
As a consequence of the third invariant, if a property is described as adata property and it may return different values over time, then either or both of the [[Writable]] and [[Configurable]] attributes must betrue even if no mechanism to change the value is exposed via the other essential internal methods.
[[DefineOwnProperty]] (P,Desc )
The normal return type is Boolean.
[[DefineOwnProperty]] must returnfalse ifP has previously been observed as a non-configurable own property of the target, unless either:
All attributes ofDesc are theSameValue asP's attributes.
[[DefineOwnProperty]] (P,Desc) must returnfalse if target is non-extensible andP is a non-existent own property. That is, a non-extensible target object cannot be extended with new properties.
[[HasProperty]] (P )
The normal return type is Boolean.
IfP was previously observed as a non-configurable own data oraccessor property of the target, [[HasProperty]] must returntrue.
IfP was previously observed as a non-configurable, non-writable owndata property of the target with valueV, then [[Get]] must return theSameValue asV.
IfP was previously observed as a non-configurable ownaccessor property of the target whose [[Get]] attribute isundefined, the [[Get]] operation must returnundefined.
[[Set]] (P,V,Receiver )
The normal return type is Boolean.
IfP was previously observed as a non-configurable, non-writable owndata property of the target, then [[Set]] must returnfalse unlessV is theSameValue asP's [[Value]] attribute.
IfP was previously observed as a non-configurable ownaccessor property of the target whose [[Set]] attribute isundefined, the [[Set]] operation must returnfalse.
[[Delete]] (P )
The normal return type is Boolean.
IfP was previously observed as a non-configurable own data oraccessor property of the target, [[Delete]] must returnfalse.
The returnedList must not contain any duplicate entries.
The Type of each element of the returnedList is either String or Symbol.
The returnedList must contain at least the keys of all non-configurable own properties that have previously been observed.
If the target is non-extensible, the returnedList must contain only the keys of all own properties of the target that are observable using [[GetOwnProperty]].
The target must also have a [[Call]] internal method.
6.1.7.4 Well-Known Intrinsic Objects
Well-known intrinsics are built-in objects that are explicitly referenced by the algorithms of this specification and which usually haverealm-specific identities. Unless otherwise specified each intrinsic object actually corresponds to a set of similar objects, one perrealm.
Within this specification a reference such as %name% means the intrinsic object, associated with the currentrealm, corresponding to the name. A reference such as %name.a.b% means, as if the "b" property of the "a" property of the intrinsic object %name% was accessed prior to any ECMAScript code being evaluated. Determination of the currentrealm and its intrinsics is described in9.3. The well-known intrinsics are listed inTable 8.
A specification type corresponds to meta-values that are used within algorithms to describe the semantics of ECMAScript language constructs and ECMAScript language types. The specification types includeReference,List,Completion,Property Descriptor,Environment Record,Abstract Closure, andData Block. Specification type values are specification artefacts that do not necessarily correspond to any specific entity within an ECMAScript implementation. Specification type values may be used to describe intermediate results of ECMAScript expression evaluation but such values cannot be stored as properties of objects or values of ECMAScript language variables.
6.2.1 The List and Record Specification Types
TheList type is used to explain the evaluation of argument lists (see13.3.8) innew expressions, in function calls, and in other algorithms where a simple ordered list of values is needed. Values of the List type are simply ordered sequences of list elements containing the individual values. These sequences may be of any length. The elements of a list may be randomly accessed using 0-origin indices. For notational convenience an array-like syntax can be used to access List elements. For example,arguments[2] is shorthand for saying the 3rd element of the Listarguments.
When an algorithm iterates over the elements of a List without specifying an order, the order used is the order of the elements in the List.
For notational convenience within this specification, a literal syntax can be used to express a new List value. For example, « 1, 2 » defines a List value that has two elements each of which is initialized to a specific value. A new empty List can be expressed as « ».
TheRecord type is used to describe data aggregations within the algorithms of this specification. A Record type value consists of one or more named fields. The value of each field is either an ECMAScript value or an abstract value represented by a name associated with the Record type. Field names are always enclosed in double brackets, for example [[Value]].
For notational convenience within this specification, an object literal-like syntax can be used to express a Record value. For example, { [[Field1]]: 42, [[Field2]]:false, [[Field3]]:empty } defines a Record value that has three fields, each of which is initialized to a specific value. Field name order is not significant. Any fields that are not explicitly listed are considered to be absent.
In specification text and algorithms, dot notation may be used to refer to a specific field of a Record value. For example, if R is the record shown in the previous paragraph then R.[[Field2]] is shorthand for “the field of R named [[Field2]]”.
Schema for commonly used Record field combinations may be named, and that name may be used as a prefix to a literal Record value to identify the specific kind of aggregations that is being described. For example: PropertyDescriptor { [[Value]]: 42, [[Writable]]:false, [[Configurable]]:true }.
6.2.2 The Set and Relation Specification Types
TheSet type is used to explain a collection of unordered elements for use in thememory model. Values of the Set type are simple collections of elements, where no element appears more than once. Elements may be added to and removed from Sets. Sets may be unioned, intersected, or subtracted from each other.
TheRelation type is used to explain constraints on Sets. Values of the Relation type are Sets of ordered pairs of values from its value domain. For example, a Relation on events is a set of ordered pairs of events. For a RelationR and two valuesa andb in the value domain ofR,aRb is shorthand for saying the ordered pair (a,b) is a member ofR. A Relation is least with respect to some conditions when it is the smallest Relation that satisfies those conditions.
Astrict partial order is a Relation valueR that satisfies the following.
For alla,b, andc inR's domain:
It is not the case thataRa, and
IfaRb andbRc, thenaRc.
Note 1
The two properties above are called irreflexivity and transitivity, respectively.
Astrict total order is a Relation valueR that satisfies the following.
For alla,b, andc inR's domain:
a is identical tob oraRb orbRa, and
It is not the case thataRa, and
IfaRb andbRc, thenaRc.
Note 2
The three properties above are called totality, irreflexivity, and transitivity, respectively.
6.2.3 The Completion Record Specification Type
The Completion type is aRecord used to explain the runtime propagation of values and control flow such as the behaviour of statements (break,continue,return andthrow) that perform nonlocal transfers of control.
Values of the Completion type areRecord values whose fields are defined byTable 9. Such values are referred to asCompletion Records.
13.Set the code evaluation state ofasyncContext such that when evaluation is resumed with aCompletioncompletion, the following steps of the algorithm that invokedAwait will be performed, withcompletion available.
14.Return.
15.NOTE: This returns to the evaluation of the operation that had most previously resumed evaluation ofasyncContext.
where all aliases in the above steps, with the exception ofcompletion, are ephemeral and visible only in the steps pertaining to Await.
Note
Await can be combined with the? and! prefixes, so that for example
AnAwait fulfilled function is an anonymous built-in function that is used as part of theAwait specification device to deliver the promise fulfillment value to the caller as a normal completion. EachAwait fulfilled function has an [[AsyncContext]] internal slot.
When anAwait fulfilled function is called with argumentvalue, the following steps are taken:
The"length" property of anAwait fulfilled function is1𝔽.
6.2.3.1.2 Await Rejected Functions
AnAwait rejected function is an anonymous built-in function that is used as part of theAwait specification device to deliver the promise rejection reason to the caller as an abrupt throw completion. EachAwait rejected function has an [[AsyncContext]] internal slot.
When anAwait rejected function is called with argumentreason, the following steps are taken:
TheReference Record type is used to explain the behaviour of such operators asdelete,typeof, the assignment operators, thesuperkeyword and other language features. For example, the left-hand operand of an assignment is expected to produce a Reference Record.
A Reference Record is a resolved name or property binding; its fields are defined byTable 10.
If notempty, theReference Record represents a property binding that was expressed using thesuperkeyword; it is called aSuper Reference Record and its [[Base]] value will never be anEnvironment Record. In that case, the [[ThisValue]] field holds thethis value at the time theReference Record was created.
The followingabstract operations are used in this specification to operate upon References:
6.2.4.1 IsPropertyReference (V )
The abstract operation IsPropertyReference takes argumentV. It performs the following steps when called:
The object that may be created in step4.a is not accessible outside of the above abstract operation and theordinary object [[Get]] internal method. An implementation might choose to avoid the actual creation of the object.
6.2.4.5 PutValue (V,W )
The abstract operation PutValue takes argumentsV andW. It performs the following steps when called:
The object that may be created in step5.a is not accessible outside of the above abstract operation and theordinary object [[Set]] internal method. An implementation might choose to avoid the actual creation of that object.
6.2.4.6 GetThisValue (V )
The abstract operation GetThisValue takes argumentV. It performs the following steps when called:
TheProperty Descriptor type is used to explain the manipulation and reification of Object property attributes. Values of the Property Descriptor type are Records. Each field's name is an attribute name and its value is a corresponding attribute value as specified in6.1.7.1. In addition, any field may be present or absent. The schema name used within this specification to tag literal descriptions of Property Descriptor records is “PropertyDescriptor”.
Property Descriptor values may be further classified as data Property Descriptors and accessor Property Descriptors based upon the existence or use of certain fields. A data Property Descriptor is one that includes any fields named either [[Value]] or [[Writable]]. An accessor Property Descriptor is one that includes any fields named either [[Get]] or [[Set]]. Any Property Descriptor may have fields named [[Enumerable]] and [[Configurable]]. A Property Descriptor value may not be both a data Property Descriptor and an accessor Property Descriptor; however, it may be neither. A generic Property Descriptor is a Property Descriptor value that is neither a data Property Descriptor nor an accessor Property Descriptor. A fully populated Property Descriptor is one that is either an accessor Property Descriptor or a data Property Descriptor and that has all of the fields that correspond to the property attributes defined in eitherTable 3 orTable 4.
The followingabstract operations are used in this specification to operate upon Property Descriptor values:
6.2.5.1 IsAccessorDescriptor (Desc )
The abstract operation IsAccessorDescriptor takes argumentDesc (aProperty Descriptor orundefined). It performs the following steps when called:
1.IfDesc isundefined, returnfalse.
2.If bothDesc.[[Get]] andDesc.[[Set]] are absent, returnfalse.
3.Returntrue.
6.2.5.2 IsDataDescriptor (Desc )
The abstract operation IsDataDescriptor takes argumentDesc (aProperty Descriptor orundefined). It performs the following steps when called:
1.IfDesc isundefined, returnfalse.
2.If bothDesc.[[Value]] andDesc.[[Writable]] are absent, returnfalse.
3.Returntrue.
6.2.5.3 IsGenericDescriptor (Desc )
The abstract operation IsGenericDescriptor takes argumentDesc (aProperty Descriptor orundefined). It performs the following steps when called:
a.IfDesc does not have a [[Value]] field, setDesc.[[Value]] tolike.[[Value]].
b.IfDesc does not have a [[Writable]] field, setDesc.[[Writable]] tolike.[[Writable]].
4.Else,
a.IfDesc does not have a [[Get]] field, setDesc.[[Get]] tolike.[[Get]].
b.IfDesc does not have a [[Set]] field, setDesc.[[Set]] tolike.[[Set]].
5.IfDesc does not have an [[Enumerable]] field, setDesc.[[Enumerable]] tolike.[[Enumerable]].
6.IfDesc does not have a [[Configurable]] field, setDesc.[[Configurable]] tolike.[[Configurable]].
7.ReturnDesc.
6.2.6 The Environment Record Specification Type
TheEnvironment Record type is used to explain the behaviour of name resolution in nested functions and blocks. This type and the operations upon it are defined in9.1.
6.2.7 The Abstract Closure Specification Type
TheAbstract Closure specification type is used to refer to algorithm steps together with a collection of values. Abstract Closures are meta-values and are invoked using function application style such asclosure(arg1,arg2). Likeabstract operations, invocations perform the algorithm steps described by the Abstract Closure.
In algorithm steps that create an Abstract Closure, values are captured with the verb "capture" followed by a list of aliases. When an Abstract Closure is created, it captures the value that is associated with each alias at that time. In steps that specify the algorithm to be performed when an Abstract Closure is called, each captured value is referred to by the alias that was used to capture the value.
TheData Block specification type is used to describe a distinct and mutable sequence of byte-sized (8 bit) numeric values. Abyte value is aninteger value in the range 0 through 255, inclusive. A Data Block value is created with a fixed number of bytes that each have the initial value 0.
For notational convenience within this specification, an array-like syntax can be used to access the individual bytes of a Data Block value. This notation presents a Data Block value as a 0-originedinteger-indexed sequence of bytes. For example, ifdb is a 5 byte Data Block value thendb[2] can be used to access its 3rd byte.
A data block that resides in memory that can be referenced from multiple agents concurrently is designated aShared Data Block. A Shared Data Block has an identity (for the purposes of equality testing Shared Data Block values) that isaddress-free: it is tied not to the virtual addresses the block is mapped to in any process, but to the set of locations in memory that the block represents. Two data blocks are equal only if the sets of the locations they contain are equal; otherwise, they are not equal and the intersection of the sets of locations they contain is empty. Finally, Shared Data Blocks can be distinguished from Data Blocks.
The semantics of Shared Data Blocks is defined using Shared Data Block events by thememory model.Abstract operations below introduce Shared Data Block events and act as the interface between evaluation semantics and the event semantics of thememory model. The events form acandidate execution, on which thememory model acts as a filter. Please consult thememory model for full semantics.
Shared Data Block events are modeled by Records, defined in thememory model.
The followingabstract operations are used in this specification to operate upon Data Block values:
6.2.8.1 CreateByteDataBlock (size )
The abstract operation CreateByteDataBlock takes argumentsize (aninteger). It performs the following steps when called:
The abstract operation CopyDataBlockBytes takes argumentstoBlock,toIndex (a non-negativeinteger),fromBlock,fromIndex (a non-negativeinteger), andcount (a non-negativeinteger). It performs the following steps when called:
ii.LeteventList be the [[EventList]] field of the element inexecution.[[EventsRecords]] whose [[AgentSignifier]] isAgentSignifier().
iii.Letbytes be aList whose sole element is a nondeterministically chosenbyte value.
iv.NOTE: In implementations,bytes is the result of a non-atomic read instruction on the underlying hardware. The nondeterminism is a semantic prescription of thememory model to describe observable behaviour of hardware with weak consistency.
These operations are not a part of the ECMAScript language; they are defined here solely to aid the specification of the semantics of the ECMAScript language. Other, more specializedabstract operations are defined throughout this specification.
7.1 Type Conversion
The ECMAScript language implicitly performs automatic type conversion as needed. To clarify the semantics of certain constructs it is useful to define a set of conversionabstract operations. The conversionabstract operations are polymorphic; they can accept a value of anyECMAScript language type. But no other specification types are used with these operations.
The BigInt type has no implicit conversions in the ECMAScript language; programmers must call BigInt explicitly to convert values from other types.
7.1.1 ToPrimitive (input [ ,preferredType ] )
The abstract operation ToPrimitive takes argumentinput and optional argumentpreferredType. It converts itsinput argument to a non-Object type. If an object is capable of converting to more than one primitive type, it may use the optional hintpreferredType to favour that type. It performs the following steps when called:
When ToPrimitive is called with no hint, then it generally behaves as if the hint werenumber. However, objects may over-ride this behaviour by defining a@@toPrimitive method. Of the objects defined in this specification only Date objects (see21.4.4.45) and Symbol objects (see20.4.3.5) over-ride the default ToPrimitive behaviour. Date objects treat no hint as if the hint werestring.
7.1.1.1 OrdinaryToPrimitive (O,hint )
The abstract operation OrdinaryToPrimitive takes argumentsO andhint. It performs the following steps when called:
ToNumber applied to Strings applies the following grammar to the input String interpreted as a sequence of UTF-16 encoded code points (6.1.4). If the grammar cannot interpret the String as an expansion ofStringNumericLiteral, then the result ofToNumber isNaN.
Note 1
The terminal symbols of this grammar are all composed of characters in the Unicode Basic Multilingual Plane (BMP). Therefore, the result ofToNumber will beNaN if the string contains anyleading surrogate ortrailing surrogate code units, whether paired or unpaired.
The conversion of a String to aNumber value is similar overall to the determination of theNumber value for a numeric literal (see12.8.3), but some of the details are different, so the process for converting a String numeric literal to a value of Number type is given here. This value is determined in two steps: first, amathematical value (MV) is derived from the String numeric literal; second, thismathematical value is rounded as described below. The MV on any grammar symbol, not provided below, is the MV for that symbol defined in12.8.3.1.
Once the exact MV for a String numeric literal has been determined, it is then rounded to a value of the Number type. If the MV is 0, then the rounded value is+0𝔽 unless the first non white space code point in the String numeric literal is-, in which case the rounded value is-0𝔽. Otherwise, the rounded value must be theNumber value for the MV (in the sense defined in6.1.6.1), unless the literal includes aStrUnsignedDecimalLiteral and the literal has more than 20 significant digits, in which case theNumber value may be either theNumber value for the MV of a literal produced by replacing each significant digit after the 20th with a 0 digit or theNumber value for the MV of a literal produced by replacing each significant digit after the 20th with a 0 digit and then incrementing the literal at the 20th digit position. A digit is significant if it is not part of anExponentPart and
it is not0; or
there is a non-zero digit to its left and there is a non-zero digit, not in theExponentPart, to its right.
7.1.5 ToIntegerOrInfinity (argument )
The abstract operation ToIntegerOrInfinity takes argumentargument. It convertsargument to aninteger, +∞, or -∞. It performs the following steps when called:
The abstract operation ToInt32 takes argumentargument. It convertsargument to one of 232integral Number values in the range𝔽(-231) through𝔽(231 - 1), inclusive. It performs the following steps when called:
The ToInt32 abstract operation is idempotent: if applied to a result that it produced, the second application leaves that value unchanged.
ToInt32(ToUint32(x)) is the same value as ToInt32(x) for all values ofx. (It is to preserve this latter property that+∞𝔽 and-∞𝔽 are mapped to+0𝔽.)
ToInt32 maps-0𝔽 to+0𝔽.
7.1.7 ToUint32 (argument )
The abstract operation ToUint32 takes argumentargument. It convertsargument to one of 232integral Number values in the range+0𝔽 through𝔽(232 - 1), inclusive. It performs the following steps when called:
Step5 is the only difference between ToUint32 andToInt32.
The ToUint32 abstract operation is idempotent: if applied to a result that it produced, the second application leaves that value unchanged.
ToUint32(ToInt32(x)) is the same value as ToUint32(x) for all values ofx. (It is to preserve this latter property that+∞𝔽 and-∞𝔽 are mapped to+0𝔽.)
ToUint32 maps-0𝔽 to+0𝔽.
7.1.8 ToInt16 (argument )
The abstract operation ToInt16 takes argumentargument. It convertsargument to one of 216integral Number values in the range𝔽(-215) through𝔽(215 - 1), inclusive. It performs the following steps when called:
The abstract operation ToUint16 takes argumentargument. It convertsargument to one of 216integral Number values in the range+0𝔽 through𝔽(216 - 1), inclusive. It performs the following steps when called:
The substitution of 216 for 232 in step4 is the only difference betweenToUint32 and ToUint16.
ToUint16 maps-0𝔽 to+0𝔽.
7.1.10 ToInt8 (argument )
The abstract operation ToInt8 takes argumentargument. It convertsargument to one of 28integral Number values in the range-128𝔽 through127𝔽, inclusive. It performs the following steps when called:
The abstract operation ToUint8 takes argumentargument. It convertsargument to one of 28integral Number values in the range+0𝔽 through255𝔽, inclusive. It performs the following steps when called:
The abstract operation ToUint8Clamp takes argumentargument. It convertsargument to one of 28integral Number values in the range+0𝔽 through255𝔽, inclusive. It performs the following steps when called:
Unlike the other ECMAScriptinteger conversion abstract operation, ToUint8Clamp rounds rather than truncates non-integral values and does not convert+∞𝔽 to+0𝔽. ToUint8Clamp does “round half to even” tie-breaking. This differs fromMath.round which does “round half up” tie-breaking.
7.1.13 ToBigInt (argument )
The abstract operation ToBigInt takes argumentargument. It convertsargument to a BigInt value, or throws if an implicit conversion from Number would be required. It performs the following steps when called:
If the MV isNaN, returnNaN, otherwise return the BigInt which exactly corresponds to the MV, rather than rounding to a Number.
7.1.15 ToBigInt64 (argument )
The abstract operation ToBigInt64 takes argumentargument. It convertsargument to one of 264 BigInt values in the rangeℤ(-263) throughℤ(263-1), inclusive. It performs the following steps when called:
The abstract operation ToBigUint64 takes argumentargument. It convertsargument to one of 264 BigInt values in the range0ℤ through the BigInt value forℤ(264-1), inclusive. It performs the following steps when called:
Return a new Boolean object whose [[BooleanData]] internal slot is set toargument. See20.3 for a description of Boolean objects.
Number
Return a new Number object whose [[NumberData]] internal slot is set toargument. See21.1 for a description of Number objects.
String
Return a new String object whose [[StringData]] internal slot is set toargument. See22.1 for a description of String objects.
Symbol
Return a new Symbol object whose [[SymbolData]] internal slot is set toargument. See20.4 for a description of Symbol objects.
BigInt
Return a new BigInt object whose [[BigIntData]] internal slot is set toargument. See21.2 for a description of BigInt objects.
Object
Returnargument.
7.1.19 ToPropertyKey (argument )
The abstract operation ToPropertyKey takes argumentargument. It convertsargument to a value that can be used as a property key. It performs the following steps when called:
The abstract operation ToLength takes argumentargument. It convertsargument to anintegral Number suitable for use as the length of anarray-like object. It performs the following steps when called:
The abstract operation CanonicalNumericIndexString takes argumentargument. It returnsargument converted to aNumber value if it is a String representation of a Number that would be produced byToString, or the string"-0". Otherwise, it returnsundefined. It performs the following steps when called:
Acanonical numeric string is any String value for which the CanonicalNumericIndexString abstract operation does not returnundefined.
7.1.22 ToIndex (value )
The abstract operation ToIndex takes argumentvalue. It returnsvalue argument converted to a non-negativeinteger if it is a validinteger index value. It performs the following steps when called:
The abstract operation RequireObjectCoercible takes argumentargument. It throws an error ifargument is a value that cannot be converted to an Object usingToObject. It is defined byTable 16:
The abstract operation IsCallable takes argumentargument (anECMAScript language value). It determines ifargument is a callable function with a [[Call]] internal method. It performs the following steps when called:
2.Ifargument has a [[Call]] internal method, returntrue.
3.Returnfalse.
7.2.4 IsConstructor (argument )
The abstract operation IsConstructor takes argumentargument (anECMAScript language value). It determines ifargument is afunction object with a [[Construct]] internal method. It performs the following steps when called:
2.Ifargument has a [[Construct]] internal method, returntrue.
3.Returnfalse.
7.2.5 IsExtensible (O )
The abstract operation IsExtensible takes argumentO (an Object) and returns a completion record which, if its [[Type]] isnormal, has a [[Value]] which is a Boolean. It is used to determine whether additional properties can be added toO. It performs the following steps when called:
The abstract operation IsIntegralNumber takes argumentargument. It determines ifargument is a finiteintegral Number value. It performs the following steps when called:
The abstract operation IsPropertyKey takes argumentargument (anECMAScript language value). It determines ifargument is a value that may be used as a property key. It performs the following steps when called:
3.Ifmatcher is notundefined, return ! ToBoolean(matcher).
4.Ifargument has a [[RegExpMatcher]] internal slot, returntrue.
5.Returnfalse.
7.2.9 IsStringPrefix (p,q )
The abstract operation IsStringPrefix takes argumentsp (a String) andq (a String). It determines ifp is a prefix ofq. It performs the following steps when called:
3.Ifq can be thestring-concatenation ofp and some other Stringr, returntrue. Otherwise, returnfalse.
Note
Any String is a prefix of itself, becauser may be the empty String.
7.2.10 SameValue (x,y )
The abstract operation SameValue takes argumentsx (anECMAScript language value) andy (anECMAScript language value) and returns a completion record whose [[Type]] isnormal and whose [[Value]] is a Boolean. It performs the following steps when called:
1.IfType(x) is different fromType(y), returnfalse.
This algorithm differs from theStrict Equality Comparison Algorithm in its treatment of signed zeroes and NaNs.
7.2.11 SameValueZero (x,y )
The abstract operation SameValueZero takes argumentsx (anECMAScript language value) andy (anECMAScript language value) and returns a completion record whose [[Type]] isnormal and whose [[Value]] is a Boolean. It performs the following steps when called:
1.IfType(x) is different fromType(y), returnfalse.
SameValueZero differs fromSameValue only in its treatment of+0𝔽 and-0𝔽.
7.2.12 SameValueNonNumeric (x,y )
The abstract operation SameValueNonNumeric takes argumentsx (anECMAScript language value) andy (anECMAScript language value) and returns a completion record whose [[Type]] isnormal and whose [[Value]] is a Boolean. It performs the following steps when called:
a.Ifx andy are both the same Symbol value, returntrue; otherwise, returnfalse.
8.Ifx andy are the same Object value, returntrue. Otherwise, returnfalse.
7.2.13 Abstract Relational Comparison
The comparisonx <y, wherex andy are values, producestrue,false, orundefined (which indicates that at least one operand isNaN). In addition tox andy the algorithm takes a Boolean flag namedLeftFirst as a parameter. The flag is used to control the order in which operations with potentially visible side-effects are performed uponx andy. It is necessary because ECMAScript specifies left to right evaluation of expressions. The default value ofLeftFirst istrue and indicates that thex parameter corresponds to an expression that occurs to the left of they parameter's corresponding expression. IfLeftFirst isfalse, the reverse is the case and operations must be performed upony beforex. Such a comparison is performed as follows:
c.Letk be the smallest non-negativeinteger such that the code unit at indexk withinpx is different from the code unit at indexk withinpy. (There must be such ak, for neither String is a prefix of the other.)
d.Letm be theinteger that is the numeric value of the code unit at indexk withinpx.
e.Letn be theinteger that is the numeric value of the code unit at indexk withinpy.
f.Ifm <n, returntrue. Otherwise, returnfalse.
4.Else,
a.IfType(px) is BigInt andType(py) is String, then
Step3 differs from step2.c in the algorithm that handles the addition operator+ (13.15.3) by using the logical-and operation instead of the logical-or operation.
Note 2
The comparison of Strings uses a simple lexicographic ordering on sequences of code unit values. There is no attempt to use the more complex, semantically oriented definitions of character or string equality and collating order defined in the Unicode specification. Therefore String values that are canonically equal according to the Unicode standard could test as unequal. In effect this algorithm assumes that both Strings are already in normalized form. Also, note that for strings containing supplementary characters, lexicographic ordering on sequences of UTF-16 code unit values differs from that on sequences of code point values.
7.2.14 Abstract Equality Comparison
The comparisonx ==y, wherex andy are values, producestrue orfalse. Such a comparison is performed as follows:
This algorithm differs from theSameValue Algorithm in its treatment of signed zeroes and NaNs.
7.3 Operations on Objects
7.3.1 MakeBasicObject (internalSlotsList )
The abstract operation MakeBasicObject takes argumentinternalSlotsList. It is the source of all ECMAScript objects that are created algorithmically, including both ordinary objects and exotic objects. It factors out common steps used in creating all objects, and centralizes object creation. It performs the following steps when called:
1.Assert:internalSlotsList is aList of internal slot names.
2.Letobj be a newly created object with an internal slot for each name ininternalSlotsList.
3.Setobj's essential internal methods to the defaultordinary object definitions specified in10.1.
4.Assert: If the caller will not be overriding bothobj's [[GetPrototypeOf]] and [[SetPrototypeOf]] essential internal methods, theninternalSlotsList contains [[Prototype]].
5.Assert: If the caller will not be overriding all ofobj's [[SetPrototypeOf]], [[IsExtensible]], and [[PreventExtensions]] essential internal methods, theninternalSlotsList contains [[Extensible]].
Within this specification, exotic objects are created inabstract operations such asArrayCreate andBoundFunctionCreate by first calling MakeBasicObject to obtain a basic, foundational object, and then overriding some or all of that object's internal methods. In order to encapsulateexotic object creation, the object's essential internal methods are never modified outside those operations.
7.3.2 Get (O,P )
The abstract operation Get takes argumentsO (an Object) andP (a property key). It is used to retrieve the value of a specific property of an object. It performs the following steps when called:
The abstract operation GetV takes argumentsV (anECMAScript language value) andP (a property key). It is used to retrieve the value of a specific property of anECMAScript language value. If the value is not an object, the property lookup is performed using a wrapper object appropriate for the type of the value. It performs the following steps when called:
The abstract operation Set takes argumentsO (an Object),P (a property key),V (anECMAScript language value), andThrow (a Boolean). It is used to set the value of a specific property of an object.V is the new value for the property. It performs the following steps when called:
The abstract operation CreateDataProperty takes argumentsO (an Object),P (a property key), andV (anECMAScript language value). It is used to create a new own property of an object. It performs the following steps when called:
3.LetnewDesc be the PropertyDescriptor { [[Value]]:V, [[Writable]]:true, [[Enumerable]]:true, [[Configurable]]:true }.
4.Return ?O.[[DefineOwnProperty]](P,newDesc).
Note
This abstract operation creates a property whose attributes are set to the same defaults used for properties created by the ECMAScript language assignment operator. Normally, the property will not already exist. If it does exist and is not configurable or ifO is not extensible, [[DefineOwnProperty]] will returnfalse.
7.3.6 CreateMethodProperty (O,P,V )
The abstract operation CreateMethodProperty takes argumentsO (an Object),P (a property key), andV (anECMAScript language value). It is used to create a new own property of an object. It performs the following steps when called:
3.LetnewDesc be the PropertyDescriptor { [[Value]]:V, [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:true }.
4.Return ?O.[[DefineOwnProperty]](P,newDesc).
Note
This abstract operation creates a property whose attributes are set to the same defaults used for built-in methods and methods defined using class declaration syntax. Normally, the property will not already exist. If it does exist and is not configurable or ifO is not extensible, [[DefineOwnProperty]] will returnfalse.
7.3.7 CreateDataPropertyOrThrow (O,P,V )
The abstract operation CreateDataPropertyOrThrow takes argumentsO (an Object),P (a property key), andV (anECMAScript language value). It is used to create a new own property of an object. It throws aTypeError exception if the requested property update cannot be performed. It performs the following steps when called:
This abstract operation creates a property whose attributes are set to the same defaults used for properties created by the ECMAScript language assignment operator. Normally, the property will not already exist. If it does exist and is not configurable or ifO is not extensible, [[DefineOwnProperty]] will returnfalse causing this operation to throw aTypeError exception.
7.3.8 DefinePropertyOrThrow (O,P,desc )
The abstract operation DefinePropertyOrThrow takes argumentsO (an Object),P (a property key), anddesc (aProperty Descriptor). It is used to call the [[DefineOwnProperty]] internal method of an object in a manner that will throw aTypeError exception if the requested property update cannot be performed. It performs the following steps when called:
The abstract operation DeletePropertyOrThrow takes argumentsO (an Object) andP (a property key). It is used to remove a specific own property of an object. It throws an exception if the property is not configurable. It performs the following steps when called:
The abstract operation GetMethod takes argumentsV (anECMAScript language value) andP (a property key). It is used to get the value of a specific property of anECMAScript language value when the value of the property is expected to be a function. It performs the following steps when called:
The abstract operation HasProperty takes argumentsO (an Object) andP (a property key) and returns a completion record which, if its [[Type]] isnormal, has a [[Value]] which is a Boolean. It is used to determine whether an object has a property with the specified property key. The property may be either an own or inherited. It performs the following steps when called:
The abstract operation HasOwnProperty takes argumentsO (an Object) andP (a property key) and returns a completion record which, if its [[Type]] isnormal, has a [[Value]] which is a Boolean. It is used to determine whether an object has an own property with the specified property key. It performs the following steps when called:
The abstract operation Call takes argumentsF (anECMAScript language value) andV (anECMAScript language value) and optional argumentargumentsList (aList of ECMAScript language values). It is used to call the [[Call]] internal method of afunction object.F is thefunction object,V is anECMAScript language value that is thethis value of the [[Call]], andargumentsList is the value passed to the corresponding argument of the internal method. IfargumentsList is not present, a new emptyList is used as its value. It performs the following steps when called:
1.IfargumentsList is not present, setargumentsList to a new emptyList.
The abstract operation Construct takes argumentF (afunction object) and optional argumentsargumentsList andnewTarget. It is used to call the [[Construct]] internal method of afunction object.argumentsList andnewTarget are the values to be passed as the corresponding arguments of the internal method. IfargumentsList is not present, a new emptyList is used as its value. IfnewTarget is not present,F is used as its value. It performs the following steps when called:
1.IfnewTarget is not present, setnewTarget toF.
2.IfargumentsList is not present, setargumentsList to a new emptyList.
IfnewTarget is not present, this operation is equivalent to:new F(...argumentsList)
7.3.15 SetIntegrityLevel (O,level )
The abstract operation SetIntegrityLevel takes argumentsO andlevel. It is used to fix the set of own properties of an object. It performs the following steps when called:
The abstract operation TestIntegrityLevel takes argumentsO andlevel. It is used to determine if the set of own properties of an object are fixed. It performs the following steps when called:
ii.Iflevel isfrozen andIsDataDescriptor(currentDesc) istrue, then
1.IfcurrentDesc.[[Writable]] istrue, returnfalse.
8.Returntrue.
7.3.17 CreateArrayFromList (elements )
The abstract operation CreateArrayFromList takes argumentelements (aList). It is used to create an Array object whose elements are provided byelements. It performs the following steps when called:
1.Assert:elements is aList whose elements are all ECMAScript language values.
The abstract operation LengthOfArrayLike takes argumentobj. It returns the value of the"length" property of an array-like object (as a non-negativeinteger). It performs the following steps when called:
The abstract operation CreateListFromArrayLike takes argumentobj and optional argumentelementTypes (aList of names of ECMAScript Language Types). It is used to create aList value whose elements are provided by the indexed properties ofobj.elementTypes contains the names of ECMAScript Language Types that are allowed for element values of theList that is created. It performs the following steps when called:
1.IfelementTypes is not present, setelementTypes to « Undefined, Null, Boolean, String, Symbol, Number, BigInt, Object ».
2.IfType(obj) is not Object, throw aTypeError exception.
c.IfType(next) is not an element ofelementTypes, throw aTypeError exception.
d.Appendnext as the last element oflist.
e.Setindex toindex + 1.
7.Returnlist.
7.3.20 Invoke (V,P [ ,argumentsList ] )
The abstract operation Invoke takes argumentsV (anECMAScript language value) andP (a property key) and optional argumentargumentsList (aList of ECMAScript language values). It is used to call a method property of anECMAScript language value.V serves as both the lookup point for the property and thethis value of the call.argumentsList is the list of arguments values passed to the method. IfargumentsList is not present, a new emptyList is used as its value. It performs the following steps when called:
The abstract operation OrdinaryHasInstance takes argumentsC (anECMAScript language value) andO. It implements the default algorithm for determining ifO inherits from the instance object inheritance path provided byC. It performs the following steps when called:
The abstract operation SpeciesConstructor takes argumentsO (an Object) anddefaultConstructor (aconstructor). It is used to retrieve theconstructor that should be used to create new objects that are derived fromO.defaultConstructor is theconstructor to use if aconstructor@@species property cannot be found starting fromO. It performs the following steps when called:
The abstract operation EnumerableOwnPropertyNames takes argumentsO (an Object) andkind (one ofkey,value, orkey+value). It performs the following steps when called:
The abstract operation IteratorStep takes argumentiteratorRecord. It requests the next value fromiteratorRecord.[[Iterator]] by callingiteratorRecord.[[NextMethod]] and returns eitherfalse indicating that the iterator has reached its end or the IteratorResult object if a next value is available. It performs the following steps when called:
The abstract operation IteratorClose takes argumentsiteratorRecord andcompletion. It is used to notify an iterator that it should perform any actions it would normally perform when it has reached its completed state. It performs the following steps when called:
1.Assert:Type(iteratorRecord.[[Iterator]]) is Object.
The abstract operation AsyncIteratorClose takes argumentsiteratorRecord andcompletion. It is used to notify an async iterator that it should perform any actions it would normally perform when it has reached its completed state. It performs the following steps when called:
1.Assert:Type(iteratorRecord.[[Iterator]]) is Object.
The abstract operation CreateIterResultObject takes argumentsvalue anddone. It creates an object that supports the IteratorResult interface. It performs the following steps when called:
The abstract operation CreateListIteratorRecord takes argumentlist. It creates an Iterator (27.1.1.2) object record whose next method returns the successive elements oflist. It performs the following steps when called:
1.Letclosure be a newAbstract Closure with no parameters that captureslist and performs the following steps when called:
It is not necessary to treatexport defaultAssignmentExpression as a constant declaration because there is no syntax that permits assignment to the internal bound name used to reference a module's default object.
The abstract operation IsAnonymousFunctionDefinition takes argumentexpr (aParse Node forAssignmentExpression or aParse Node forInitializer). It determines if its argument is a function definition that does not bind a name. It performs the following steps when called:
undefined is passed forenvironment to indicate that aPutValue operation should be used to assign the initialization value. This is the case forvar statements and formal parameter lists of some non-strict functions (See10.2.10). In those cases a lexical binding is hoisted and preinitialized prior to evaluation of its initializer.
Whenundefined is passed forenvironment it indicates that aPutValue operation should be used to assign the initialization value. This is the case for formal parameter lists of non-strict functions. In that case the formal parameter bindings are preinitialized in order to deal with the possibility of multiple parameters with the same name.
Environment Record is a specification type used to define the association ofIdentifiers to specific variables and functions, based upon the lexical nesting structure of ECMAScript code. Usually an Environment Record is associated with some specific syntactic structure of ECMAScript code such as aFunctionDeclaration, aBlockStatement, or aCatch clause of aTryStatement. Each time such code is evaluated, a new Environment Record is created to record the identifier bindings that are created by that code.
Every Environment Record has an [[OuterEnv]] field, which is eithernull or a reference to an outer Environment Record. This is used to model the logical nesting of Environment Record values. The outer reference of an (inner) Environment Record is a reference to the Environment Record that logically surrounds the inner Environment Record. An outer Environment Record may, of course, have its own outer Environment Record. An Environment Record may serve as the outer environment for multiple inner Environment Records. For example, if aFunctionDeclaration contains two nestedFunctionDeclarations then the Environment Records of each of the nested functions will have as their outer Environment Record the Environment Record of the current evaluation of the surrounding function.
Environment Records are purely specification mechanisms and need not correspond to any specific artefact of an ECMAScript implementation. It is impossible for an ECMAScript program to directly access or manipulate such values.
Afunction Environment Record corresponds to the invocation of an ECMAScriptfunction object, and contains bindings for the top-level declarations within that function. It may establish a newthis binding. It also captures the state necessary to supportsuper method invocations.
Anobject Environment Record is used to define the effect of ECMAScript elements such asWithStatement that associate identifier bindings with the properties of some object.
Aglobal Environment Record is used forScript global declarations. It does not have an outer environment; its [[OuterEnv]] isnull. It may be prepopulated with identifier bindings and it includes an associatedglobal object whose properties provide some of theglobal environment's identifier bindings. As ECMAScript code is executed, additional properties may be added to theglobal object and the initial properties may be modified.
TheEnvironment Record abstract class includes the abstract specification methods defined inTable 17. These abstract methods have distinct concrete algorithms for each of the concrete subclasses.
Table 17: Abstract Methods of Environment Records
Method
Purpose
HasBinding(N)
Determine if anEnvironment Record has a binding for the String valueN. Returntrue if it does andfalse if it does not.
CreateMutableBinding(N, D)
Create a new but uninitialized mutable binding in anEnvironment Record. The String valueN is the text of the bound name. If the Boolean argumentD istrue the binding may be subsequently deleted.
CreateImmutableBinding(N, S)
Create a new but uninitialized immutable binding in anEnvironment Record. The String valueN is the text of the bound name. IfS istrue then attempts to set it after it has been initialized will always throw an exception, regardless of the strict mode setting of operations that reference that binding.
InitializeBinding(N, V)
Set the value of an already existing but uninitialized binding in anEnvironment Record. The String valueN is the text of the bound name.V is the value for the binding and is a value of anyECMAScript language type.
SetMutableBinding(N, V, S)
Set the value of an already existing mutable binding in anEnvironment Record. The String valueN is the text of the bound name.V is the value for the binding and may be a value of anyECMAScript language type.S is a Boolean flag. IfS istrue and the binding cannot be set throw aTypeError exception.
GetBindingValue(N, S)
Returns the value of an already existing binding from anEnvironment Record. The String valueN is the text of the bound name.S is used to identify references originating instrict mode code or that otherwise require strict mode reference semantics. IfS istrue and the binding does not exist throw aReferenceError exception. If the binding exists but is uninitialized aReferenceError is thrown, regardless of the value ofS.
DeleteBinding(N)
Delete a binding from anEnvironment Record. The String valueN is the text of the bound name. If a binding forN exists, remove the binding and returntrue. If the binding exists but cannot be removed returnfalse. If the binding does not exist returntrue.
HasThisBinding()
Determine if anEnvironment Record establishes athis binding. Returntrue if it does andfalse if it does not.
HasSuperBinding()
Determine if anEnvironment Record establishes asuper method binding. Returntrue if it does andfalse if it does not.
WithBaseObject()
If thisEnvironment Record is associated with awith statement, return the with object. Otherwise, returnundefined.
9.1.1.1 Declarative Environment Records
Eachdeclarative Environment Record is associated with an ECMAScript program scope containing variable, constant, let, class, module, import, and/or function declarations. A declarative Environment Record binds the set of identifiers defined by the declarations contained within its scope.
The behaviour of the concrete specification methods for declarative Environment Records is defined by the following algorithms.
9.1.1.1.1 HasBinding (N )
The HasBinding concrete method of adeclarative Environment RecordenvRec takes argumentN (a String). It determines if the argument identifier is one of the identifiers bound by the record. It performs the following steps when called:
1.IfenvRec has a binding for the name that is the value ofN, returntrue.
2.Returnfalse.
9.1.1.1.2 CreateMutableBinding (N,D )
The CreateMutableBinding concrete method of adeclarative Environment RecordenvRec takes argumentsN (a String) andD (a Boolean). It creates a new mutable binding for the nameN that is uninitialized. A binding must not already exist in thisEnvironment Record forN. IfD has the valuetrue, the new binding is marked as being subject to deletion. It performs the following steps when called:
1.Assert:envRec does not already have a binding forN.
2.Create a mutable binding inenvRec forN and record that it is uninitialized. IfD istrue, record that the newly created binding may be deleted by a subsequent DeleteBinding call.
The CreateImmutableBinding concrete method of adeclarative Environment RecordenvRec takes argumentsN (a String) andS (a Boolean). It creates a new immutable binding for the nameN that is uninitialized. A binding must not already exist in thisEnvironment Record forN. IfS has the valuetrue, the new binding is marked as a strict binding. It performs the following steps when called:
1.Assert:envRec does not already have a binding forN.
2.Create an immutable binding inenvRec forN and record that it is uninitialized. IfS istrue, record that the newly created binding is a strict binding.
The InitializeBinding concrete method of adeclarative Environment RecordenvRec takes argumentsN (a String) andV (anECMAScript language value). It is used to set the bound value of the current binding of the identifier whose name is the value of the argumentN to the value of argumentV. An uninitialized binding forN must already exist. It performs the following steps when called:
1.Assert:envRec must have an uninitialized binding forN.
2.Set the bound value forN inenvRec toV.
3.Record that the binding forN inenvRec has been initialized.
The SetMutableBinding concrete method of adeclarative Environment RecordenvRec takes argumentsN (a String),V (anECMAScript language value), andS (a Boolean). It attempts to change the bound value of the current binding of the identifier whose name is the value of the argumentN to the value of argumentV. A binding forN normally already exists, but in rare cases it may not. If the binding is an immutable binding, aTypeError is thrown ifS istrue. It performs the following steps when called:
An example of ECMAScript code that results in a missing binding at step1 is:
functionf(){eval("var x; x = (delete x, 0);"); }
9.1.1.1.6 GetBindingValue (N,S )
The GetBindingValue concrete method of adeclarative Environment RecordenvRec takes argumentsN (a String) andS (a Boolean). It returns the value of its bound identifier whose name is the value of the argumentN. If the binding exists but is uninitialized aReferenceError is thrown, regardless of the value ofS. It performs the following steps when called:
2.If the binding forN inenvRec is an uninitialized binding, throw aReferenceError exception.
3.Return the value currently bound toN inenvRec.
9.1.1.1.7 DeleteBinding (N )
The DeleteBinding concrete method of adeclarative Environment RecordenvRec takes argumentN (a String). It can only delete bindings that have been explicitly designated as being subject to deletion. It performs the following steps when called:
1.Assert:envRec has a binding for the name that is the value ofN.
2.If the binding forN inenvRec cannot be deleted, returnfalse.
3.Remove the binding forN fromenvRec.
4.Returntrue.
9.1.1.1.8 HasThisBinding ( )
The HasThisBinding concrete method of adeclarative Environment RecordenvRec takes no arguments. It performs the following steps when called:
The WithBaseObject concrete method of adeclarative Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returnundefined.
9.1.1.2 Object Environment Records
Eachobject Environment Record is associated with an object called itsbinding object. An object Environment Record binds the set of string identifier names that directly correspond to the property names of its binding object. Property keys that are not strings in the form of anIdentifierName are not included in the set of bound identifiers. Both own and inherited properties are included in the set regardless of the setting of their [[Enumerable]] attribute. Because properties can be dynamically added and deleted from objects, the set of identifiers bound by an object Environment Record may potentially change as a side-effect of any operation that adds or deletes properties. Any bindings that are created as a result of such a side-effect are considered to be a mutable binding even if the Writable attribute of the corresponding property has the valuefalse. Immutable bindings do not exist for object Environment Records.
Object Environment Records created forwith statements (14.11) can provide their binding object as an implicitthis value for use in function calls. The capability is controlled by awithEnvironment Boolean value that is associated with each object Environment Record. By default, the value ofwithEnvironment isfalse for any object Environment Record.
The behaviour of the concrete specification methods for object Environment Records is defined by the following algorithms.
9.1.1.2.1 HasBinding (N )
The HasBinding concrete method of anobject Environment RecordenvRec takes argumentN (a String). It determines if its associated binding object has a property whose name is the value of the argumentN. It performs the following steps when called:
The CreateMutableBinding concrete method of anobject Environment RecordenvRec takes argumentsN (a String) andD (a Boolean). It creates in anEnvironment Record's associated binding object a property whose name is the String value and initializes it to the valueundefined. IfD has the valuetrue, the new property's [[Configurable]] attribute is set totrue; otherwise it is set tofalse. It performs the following steps when called:
NormallyenvRec will not have a binding forN but if it does, the semantics ofDefinePropertyOrThrow may result in an existing binding being replaced or shadowed or cause anabrupt completion to be returned.
9.1.1.2.3 CreateImmutableBinding (N,S )
The CreateImmutableBinding concrete method of anobject Environment Record is never used within this specification.
9.1.1.2.4 InitializeBinding (N,V )
The InitializeBinding concrete method of anobject Environment RecordenvRec takes argumentsN (a String) andV (anECMAScript language value). It is used to set the bound value of the current binding of the identifier whose name is the value of the argumentN to the value of argumentV. It performs the following steps when called:
1.Return ?envRec.SetMutableBinding(N,V,false).
Note
In this specification, all uses of CreateMutableBinding for object Environment Records are immediately followed by a call to InitializeBinding for the same name. Hence, this specification does not explicitly track the initialization state of bindings in object Environment Records.
9.1.1.2.5 SetMutableBinding (N,V,S )
The SetMutableBinding concrete method of anobject Environment RecordenvRec takes argumentsN (a String),V (anECMAScript language value), andS (a Boolean). It attempts to set the value of theEnvironment Record's associated binding object's property whose name is the value of the argumentN to the value of argumentV. A property namedN normally already exists but if it does not or is not currently writable, error handling is determined byS. It performs the following steps when called:
The GetBindingValue concrete method of anobject Environment RecordenvRec takes argumentsN (a String) andS (a Boolean). It returns the value of its associated binding object's property whose name is the String value of the argument identifierN. The property should already exist but if it does not the result depends uponS. It performs the following steps when called:
The DeleteBinding concrete method of anobject Environment RecordenvRec takes argumentN (a String). It can only delete bindings that correspond to properties of the environment object whose [[Configurable]] attribute have the valuetrue. It performs the following steps when called:
1.Letbindings be the binding object forenvRec.
2.Return ?bindings.[[Delete]](N).
9.1.1.2.8 HasThisBinding ( )
The HasThisBinding concrete method of anobject Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returnfalse.
Note
Object Environment Records do not provide athis binding.
9.1.1.2.9 HasSuperBinding ( )
The HasSuperBinding concrete method of anobject Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returnfalse.
Note
Object Environment Records do not provide asuper binding.
9.1.1.2.10 WithBaseObject ( )
The WithBaseObject concrete method of anobject Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.If thewithEnvironment flag ofenvRec istrue, return the binding object forenvRec.
2.Otherwise, returnundefined.
9.1.1.3 Function Environment Records
Afunction Environment Record is adeclarative Environment Record that is used to represent the top-level scope of a function and, if the function is not anArrowFunction, provides athis binding. If a function is not anArrowFunction function and referencessuper, its function Environment Record also contains the state that is used to performsuper method invocations from within the function.
Function Environment Records have the additional state fields listed inTable 18.
Table 18: Additional Fields of Function Environment Records
Field Name
Value
Meaning
[[ThisValue]]
Any
This is thethis value used for this invocation of the function.
[[ThisBindingStatus]]
lexical |initialized |uninitialized
If the value islexical, this is anArrowFunction and does not have a localthis value.
If thisEnvironment Record was created by the [[Construct]] internal method, [[NewTarget]] is the value of the [[Construct]]newTarget parameter. Otherwise, its value isundefined.
Function Environment Records support all of thedeclarative Environment Record methods listed inTable 17 and share the same specifications for all of those methods except for HasThisBinding and HasSuperBinding. In addition, function Environment Records support the methods listed inTable 19:
Table 19: Additional Methods of Function Environment Records
Method
Purpose
BindThisValue(V)
Set the [[ThisValue]] and record that it has been initialized.
GetThisBinding()
Return the value of thisEnvironment Record'sthis binding. Throws aReferenceError if thethis binding has not been initialized.
GetSuperBase()
Return the object that is the base forsuper property accesses bound in thisEnvironment Record. The valueundefined indicates thatsuper property accesses will produce runtime errors.
The behaviour of the additional concrete specification methods for function Environment Records is defined by the following algorithms:
Aglobal Environment Record is used to represent the outer most scope that is shared by all of the ECMAScriptScript elements that are processed in a commonrealm. A global Environment Record provides the bindings for built-in globals (clause19), properties of theglobal object, and for all top-level declarations (8.1.9,8.1.11) that occur within aScript.
Determines if the argument is the name of aglobal object property that may not be shadowed by a global lexical binding.
CanDeclareGlobalVar (N)
Determines if a corresponding CreateGlobalVarBinding call would succeed if called for the same argumentN.
CanDeclareGlobalFunction (N)
Determines if a corresponding CreateGlobalFunctionBinding call would succeed if called for the same argumentN.
CreateGlobalVarBinding(N, D)
Used to create and initialize toundefined a globalvar binding in the [[ObjectRecord]] component of aglobal Environment Record. The binding will be a mutable binding. The correspondingglobal object property will have attribute values appropriate for avar. The String valueN is the bound name. IfD istrue the binding may be deleted. Logically equivalent to CreateMutableBinding followed by a SetMutableBinding but it allows var declarations to receive special treatment.
CreateGlobalFunctionBinding(N, V, D)
Create and initialize a globalfunction binding in the [[ObjectRecord]] component of aglobal Environment Record. The binding will be a mutable binding. The correspondingglobal object property will have attribute values appropriate for afunction. The String valueN is the bound name.V is the initialization value. If the Boolean argumentD istrue the binding may be deleted. Logically equivalent to CreateMutableBinding followed by a SetMutableBinding but it allows function declarations to receive special treatment.
The behaviour of the concrete specification methods for global Environment Records is defined by the following algorithms.
9.1.1.4.1 HasBinding (N )
The HasBinding concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It determines if the argument identifier is one of the identifiers bound by the record. It performs the following steps when called:
1.LetDclRec beenvRec.[[DeclarativeRecord]].
2.IfDclRec.HasBinding(N) istrue, returntrue.
3.LetObjRec beenvRec.[[ObjectRecord]].
4.Return ?ObjRec.HasBinding(N).
9.1.1.4.2 CreateMutableBinding (N,D )
The CreateMutableBinding concrete method of aglobal Environment RecordenvRec takes argumentsN (a String) andD (a Boolean). It creates a new mutable binding for the nameN that is uninitialized. The binding is created in the associated DeclarativeRecord. A binding forN must not already exist in the DeclarativeRecord. IfD has the valuetrue, the new binding is marked as being subject to deletion. It performs the following steps when called:
The CreateImmutableBinding concrete method of aglobal Environment RecordenvRec takes argumentsN (a String) andS (a Boolean). It creates a new immutable binding for the nameN that is uninitialized. A binding must not already exist in thisEnvironment Record forN. IfS has the valuetrue, the new binding is marked as a strict binding. It performs the following steps when called:
The InitializeBinding concrete method of aglobal Environment RecordenvRec takes argumentsN (a String) andV (anECMAScript language value). It is used to set the bound value of the current binding of the identifier whose name is the value of the argumentN to the value of argumentV. An uninitialized binding forN must already exist. It performs the following steps when called:
The SetMutableBinding concrete method of aglobal Environment RecordenvRec takes argumentsN (a String),V (anECMAScript language value), andS (a Boolean). It attempts to change the bound value of the current binding of the identifier whose name is the value of the argumentN to the value of argumentV. If the binding is an immutable binding, aTypeError is thrown ifS istrue. A property namedN normally already exists but if it does not or is not currently writable, error handling is determined byS. It performs the following steps when called:
1.LetDclRec beenvRec.[[DeclarativeRecord]].
2.IfDclRec.HasBinding(N) istrue, then
a.ReturnDclRec.SetMutableBinding(N,V,S).
3.LetObjRec beenvRec.[[ObjectRecord]].
4.Return ?ObjRec.SetMutableBinding(N,V,S).
9.1.1.4.6 GetBindingValue (N,S )
The GetBindingValue concrete method of aglobal Environment RecordenvRec takes argumentsN (a String) andS (a Boolean). It returns the value of its bound identifier whose name is the value of the argumentN. If the binding is an uninitialized binding throw aReferenceError exception. A property namedN normally already exists but if it does not or is not currently writable, error handling is determined byS. It performs the following steps when called:
1.LetDclRec beenvRec.[[DeclarativeRecord]].
2.IfDclRec.HasBinding(N) istrue, then
a.ReturnDclRec.GetBindingValue(N,S).
3.LetObjRec beenvRec.[[ObjectRecord]].
4.Return ?ObjRec.GetBindingValue(N,S).
9.1.1.4.7 DeleteBinding (N )
The DeleteBinding concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It can only delete bindings that have been explicitly designated as being subject to deletion. It performs the following steps when called:
1.LetDclRec beenvRec.[[DeclarativeRecord]].
2.IfDclRec.HasBinding(N) istrue, then
a.ReturnDclRec.DeleteBinding(N).
3.LetObjRec beenvRec.[[ObjectRecord]].
4.LetglobalObject be the binding object forObjRec.
ii.IfN is an element ofvarNames, remove that element from thevarNames.
c.Returnstatus.
7.Returntrue.
9.1.1.4.8 HasThisBinding ( )
The HasThisBinding concrete method of aglobal Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returntrue.
Note
Global Environment Records always provide athis binding.
9.1.1.4.9 HasSuperBinding ( )
The HasSuperBinding concrete method of aglobal Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returnfalse.
Note
Global Environment Records do not provide asuper binding.
9.1.1.4.10 WithBaseObject ( )
The WithBaseObject concrete method of aglobal Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returnundefined.
9.1.1.4.11 GetThisBinding ( )
The GetThisBinding concrete method of aglobal Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.ReturnenvRec.[[GlobalThisValue]].
9.1.1.4.12 HasVarDeclaration (N )
The HasVarDeclaration concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It determines if the argument identifier has a binding in this record that was created using aVariableStatement or aFunctionDeclaration. It performs the following steps when called:
1.LetvarDeclaredNames beenvRec.[[VarNames]].
2.IfvarDeclaredNames containsN, returntrue.
3.Returnfalse.
9.1.1.4.13 HasLexicalDeclaration (N )
The HasLexicalDeclaration concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It determines if the argument identifier has a binding in this record that was created using a lexical declaration such as aLexicalDeclaration or aClassDeclaration. It performs the following steps when called:
1.LetDclRec beenvRec.[[DeclarativeRecord]].
2.ReturnDclRec.HasBinding(N).
9.1.1.4.14 HasRestrictedGlobalProperty (N )
The HasRestrictedGlobalProperty concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It determines if the argument identifier is the name of a property of theglobal object that must not be shadowed by a global lexical binding. It performs the following steps when called:
1.LetObjRec beenvRec.[[ObjectRecord]].
2.LetglobalObject be the binding object forObjRec.
3.LetexistingProp be ?globalObject.[[GetOwnProperty]](N).
Properties may exist upon aglobal object that were directly created rather than being declared using a var or function declaration. A global lexical binding may not be created that has the same name as a non-configurable property of theglobal object. The global property"undefined" is an example of such a property.
9.1.1.4.15 CanDeclareGlobalVar (N )
The CanDeclareGlobalVar concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It determines if a corresponding CreateGlobalVarBinding call would succeed if called for the same argumentN. Redundant var declarations and var declarations for pre-existingglobal object properties are allowed. It performs the following steps when called:
1.LetObjRec beenvRec.[[ObjectRecord]].
2.LetglobalObject be the binding object forObjRec.
The CanDeclareGlobalFunction concrete method of aglobal Environment RecordenvRec takes argumentN (a String). It determines if a corresponding CreateGlobalFunctionBinding call would succeed if called for the same argumentN. It performs the following steps when called:
1.LetObjRec beenvRec.[[ObjectRecord]].
2.LetglobalObject be the binding object forObjRec.
3.LetexistingProp be ?globalObject.[[GetOwnProperty]](N).
The CreateGlobalVarBinding concrete method of aglobal Environment RecordenvRec takes argumentsN (a String) andD (a Boolean). It creates and initializes a mutable binding in the associatedobject Environment Record and records the bound name in the associated [[VarNames]]List. If a binding already exists, it is reused and assumed to be initialized. It performs the following steps when called:
1.LetObjRec beenvRec.[[ObjectRecord]].
2.LetglobalObject be the binding object forObjRec.
The CreateGlobalFunctionBinding concrete method of aglobal Environment RecordenvRec takes argumentsN (a String),V (anECMAScript language value), andD (a Boolean). It creates and initializes a mutable binding in the associatedobject Environment Record and records the bound name in the associated [[VarNames]]List. If a binding already exists, it is replaced. It performs the following steps when called:
1.LetObjRec beenvRec.[[ObjectRecord]].
2.LetglobalObject be the binding object forObjRec.
3.LetexistingProp be ?globalObject.[[GetOwnProperty]](N).
4.IfexistingProp isundefined orexistingProp.[[Configurable]] istrue, then
a.Letdesc be the PropertyDescriptor { [[Value]]:V, [[Writable]]:true, [[Enumerable]]:true, [[Configurable]]:D }.
5.Else,
a.Letdesc be the PropertyDescriptor { [[Value]]:V }.
Global function declarations are always represented as own properties of theglobal object. If possible, an existing own property is reconfigured to have a standard set of attribute values. Step7 is equivalent to what calling the InitializeBinding concrete method would do and ifglobalObject is a Proxy will produce the same sequence of Proxy trap calls.
9.1.1.5 Module Environment Records
Amodule Environment Record is adeclarative Environment Record that is used to represent the outer scope of an ECMAScriptModule. In additional to normal mutable and immutable bindings, module Environment Records also provide immutable import bindings which are bindings that provide indirect access to a target binding that exists in anotherEnvironment Record.
Module Environment Records support all of thedeclarative Environment Record methods listed inTable 17 and share the same specifications for all of those methods except for GetBindingValue, DeleteBinding, HasThisBinding and GetThisBinding. In addition, module Environment Records support the methods listed inTable 22:
Table 22: Additional Methods of Module Environment Records
The behaviour of the additional concrete specification methods for module Environment Records are defined by the following algorithms:
9.1.1.5.1 GetBindingValue (N,S )
The GetBindingValue concrete method of amodule Environment RecordenvRec takes argumentsN (a String) andS (a Boolean). It returns the value of its bound identifier whose name is the value of the argumentN. However, if the binding is an indirect binding the value of the target binding is returned. If the binding exists but is uninitialized aReferenceError is thrown. It performs the following steps when called:
The HasThisBinding concrete method of amodule Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returntrue.
Note
Module Environment Records always provide athis binding.
9.1.1.5.4 GetThisBinding ( )
The GetThisBinding concrete method of amodule Environment RecordenvRec takes no arguments. It performs the following steps when called:
1.Returnundefined.
9.1.1.5.5 CreateImportBinding (N,M,N2 )
The CreateImportBinding concrete method of amodule Environment RecordenvRec takes argumentsN (a String),M (aModule Record), andN2 (a String). It creates a new initialized immutable indirect binding for the nameN. A binding must not already exist in thisEnvironment Record forN.N2 is the name of a binding that exists inM'smodule Environment Record. Accesses to the value of the new binding will indirectly access the bound value of the target binding. It performs the following steps when called:
1.Assert:envRec does not already have a binding forN.
The followingabstract operations are used in this specification to operate upon Environment Records:
9.1.2.1 GetIdentifierReference (env,name,strict )
The abstract operation GetIdentifierReference takes argumentsenv (anEnvironment Record ornull),name (a String), andstrict (a Boolean). It performs the following steps when called:
1.Ifenv is the valuenull, then
a.Return theReference Record { [[Base]]:unresolvable, [[ReferencedName]]:name, [[Strict]]:strict, [[ThisValue]]:empty }.
2.Letexists be ?env.HasBinding(name).
3.Ifexists istrue, then
a.Return theReference Record { [[Base]]:env, [[ReferencedName]]:name, [[Strict]]:strict, [[ThisValue]]:empty }.
Before it is evaluated, all ECMAScript code must be associated with arealm. Conceptually, arealm consists of a set of intrinsic objects, an ECMAScriptglobal environment, all of the ECMAScript code that is loaded within the scope of thatglobal environment, and other associated state and resources.
Arealm is represented in this specification as aRealm Record with the fields specified inTable 23:
Template objects are canonicalized separately for eachrealm using itsRealm Record's [[TemplateMap]]. Each [[Site]] value is aParse Node that is aTemplateLiteral. The associated [[Array]] value is the corresponding template object that is passed to a tag function.
Note
Once aParse Node becomes unreachable, the corresponding [[Array]] is also unreachable, and it would be unobservable if an implementation removed the pair from the [[TemplateMap]] list.
[[HostDefined]]
Any, default value isundefined.
Field reserved for use by hosts that need to associate additional information with aRealm Record.
9.2.1 CreateRealm ( )
The abstract operation CreateRealm takes no arguments. It performs the following steps when called:
3.Set fields ofintrinsics with the values listed inTable 8. The field names are the names listed in column one of the table. The value of each field is a new object value fully and recursively populated with property values as defined by the specification of each object in clauses19 through28. All object property values are newly created object values. All values that are built-in function objects are created by performingCreateBuiltinFunction(steps,length,name,slots,realmRec,prototype) wheresteps is the definition of that function provided by this specification,name is the initial value of the function'sname property,length is the initial value of the function'slength property,slots is a list of the names, if any, of the function's specified internal slots, andprototype is the specified value of the function's [[Prototype]] internal slot. The creation of the intrinsics and their properties must be ordered to avoid any dependencies upon objects that have not yet been created.
b.Letdesc be the fully populated dataProperty Descriptor for the property, containing the specified attributes for the property. For properties listed in19.2,19.3, or19.4 the value of the [[Value]] attribute is the corresponding intrinsic object fromrealmRec.
Anexecution context is a specification device that is used to track the runtime evaluation of code by an ECMAScript implementation. At any point in time, there is at most one execution context peragent that is actually executing code. This is known as theagent'srunning execution context. All references to therunning execution context in this specification denote therunning execution context of thesurrounding agent.
Theexecution context stack is used to track execution contexts. Therunning execution context is always the top element of this stack. A new execution context is created whenever control is transferred from the executable code associated with the currentlyrunning execution context to executable code that is not associated with that execution context. The newly created execution context is pushed onto the stack and becomes therunning execution context.
An execution context contains whatever implementation specific state is necessary to track the execution progress of its associated code. Each execution context has at least the state components listed inTable 24.
Table 24: State Components for All Execution Contexts
Component
Purpose
code evaluation state
Any state needed to perform, suspend, and resume evaluation of the code associated with thisexecution context.
Evaluation of code by therunning execution context may be suspended at various points defined within this specification. Once therunning execution context has been suspended a different execution context may become therunning execution context and commence evaluating its code. At some later time a suspended execution context may again become therunning execution context and continue evaluating its code at the point where it had previously been suspended. Transition of therunning execution context status among execution contexts usually occurs in stack-like last-in/first-out manner. However, some ECMAScript features require non-LIFO transitions of therunning execution context.
In most situations only therunning execution context (the top of theexecution context stack) is directly manipulated by algorithms within this specification. Hence when the terms “LexicalEnvironment”, and “VariableEnvironment” are used without qualification they are in reference to those components of therunning execution context.
An execution context is purely a specification mechanism and need not correspond to any particular artefact of an ECMAScript implementation. It is impossible for ECMAScript code to directly access or observe an execution context.
9.3.1 GetActiveScriptOrModule ( )
The abstract operation GetActiveScriptOrModule takes no arguments. It is used to determine the running script or module, based on therunning execution context. It performs the following steps when called:
3.If no suchexecution context exists, returnnull. Otherwise, returnec's ScriptOrModule.
9.3.2 ResolveBinding (name [ ,env ] )
The abstract operation ResolveBinding takes argumentname (a String) and optional argumentenv (anEnvironment Record). It is used to determine the binding ofname.env can be used to explicitly provide theEnvironment Record that is to be searched for the binding. It performs the following steps when called:
The result of ResolveBinding is always aReference Record whose [[ReferencedName]] field isname.
9.3.3 GetThisEnvironment ( )
The abstract operation GetThisEnvironment takes no arguments. It finds theEnvironment Record that currently supplies the binding of thekeywordthis. It performs the following steps when called:
The loop in step2 will always terminate because the list of environments always ends with theglobal environment which has athis binding.
9.3.4 ResolveThisBinding ( )
The abstract operation ResolveThisBinding takes no arguments. It determines the binding of thekeywordthis using the LexicalEnvironment of therunning execution context. It performs the following steps when called:
The abstract operation GetNewTarget takes no arguments. It determines the NewTarget value using the LexicalEnvironment of therunning execution context. It performs the following steps when called:
The abstract operation GetGlobalObject takes no arguments. It returns theglobal object used by the currentlyrunning execution context. It performs the following steps when called:
AJob is anAbstract Closure with no parameters that initiates an ECMAScript computation when no other ECMAScript computation is currently in progress.
Jobs are scheduled for execution by ECMAScripthost environments. This specification describes thehost hookHostEnqueuePromiseJob to schedule one kind of job; hosts may define additionalabstract operations which schedule jobs. Such operations accept aJobAbstract Closure as the parameter and schedule it to be performed at some future time. Their implementations must conform to the following requirements:
Only oneJob may be actively undergoing evaluation at any point in time.
Once evaluation of aJob starts, it must run to completion before evaluation of any otherJob starts.
TheAbstract Closure must return a normal completion, implementing its own handling of errors.
Note 1
Host environments are not required to treat Jobs uniformly with respect to scheduling. For example, web browsers and Node.js treat Promise-handling Jobs as a higher priority than other work; future features may add Jobs that are not treated at such a high priority.
At any particular time,scriptOrModule (aScript Record, aModule Record, ornull) is theactive script or module if all of the following conditions are true:
The specific choice ofRealm is up to thehost environment. This initialexecution context andRealm is only in use before any callback function is invoked. When a callback function related to aJob, like a Promise handler, is invoked, the invocation pushes its ownexecution context andRealm.
Particular kinds of Jobs have additional conformance requirements.
The WHATWG HTML specification (https://html.spec.whatwg.org/), for example, uses thehost-defined value to propagate the incumbent settings object for Promise callbacks.
JobCallback Records have the fields listed inTable 27.
2.Return theJobCallback Record { [[Callback]]:callback, [[HostDefined]]:empty }.
ECMAScript hosts that are not web browsers must use the default implementation of HostMakeJobCallback.
Note
This is called at the time that the callback is passed to the function that is responsible for its being eventually scheduled and run. For example,promise.then(thenAction) calls MakeJobCallback onthenAction at the time of invokingPromise.prototype.then, not at the time of scheduling the reactionJob.
ECMAScript hosts that are not web browsers must use the default implementation of HostCallJobCallback.
9.4.4 HostEnqueuePromiseJob (job,realm )
Thehost-defined abstract operation HostEnqueuePromiseJob takes argumentsjob (aJobAbstract Closure) andrealm (aRealm Record ornull). It schedulesjob to be performed at some future time. The Abstract Closures used with this algorithm are intended to be related to the handling of Promises, or otherwise, to be scheduled with equal priority to Promise handling operations.
The implementation of HostEnqueuePromiseJob must conform to the requirements in9.4 as well as the following:
LetscriptOrModule beGetActiveScriptOrModule() at the time HostEnqueuePromiseJob is invoked. Ifrealm is notnull, each timejob is invoked the implementation must performimplementation-defined steps such thatscriptOrModule is theactive script or module at the time ofjob's invocation.
Jobs must run in the same order as the HostEnqueuePromiseJob invocations that scheduled them.
Note
Therealm for Jobs returned byNewPromiseResolveThenableJob is usually the result of callingGetFunctionRealm on thethenfunction object. Therealm for Jobs returned byNewPromiseReactionJob is usually the result of callingGetFunctionRealm on the handler if the handler is notundefined. If the handler isundefined,realm isnull. For both kinds of Jobs, whenGetFunctionRealm completes abnormally (i.e. called on a revoked Proxy),realm is the currentRealm at the time of theGetFunctionRealm call. When therealm isnull, no user ECMAScript code will be evaluated and no new ECMAScript objects (e.g. Error objects) will be created. The WHATWG HTML specification (https://html.spec.whatwg.org/), for example, usesrealm to check for the ability to run script and for theentry concept.
9.5 InitializeHostDefinedRealm ( )
The abstract operation InitializeHostDefinedRealm takes no arguments. It performs the following steps when called:
8.If thehost requires that thethis binding inrealm's global scope return an object other than theglobal object, letthisValue be such an object created in ahost-defined manner. Otherwise, letthisValue beundefined, indicating thatrealm's globalthis binding should be theglobal object.
Anagent'sexecuting thread executes a job on theagent's execution contexts independently of other agents, except that anexecuting thread may be used as theexecuting thread by multiple agents, provided none of the agents sharing the thread have anAgent Record whose [[CanBlock]] property istrue.
Note 1
Some web browsers share a singleexecuting thread across multiple unrelated tabs of a browser window, for example.
The default value computed for theisLittleEndian parameter when it is needed by the algorithmsGetValueFromBuffer andSetValueInBuffer. The choice isimplementation-defined and should be the alternative that is most efficient for the implementation. Once the value has been observed it cannot change.
Initially a new emptyList, representing the list of objects to be kept alive until the end of the currentJob
Once the values of [[Signifier]], [[IsLockFree1]], and [[IsLockFree2]] have been observed by anyagent in theagent cluster they cannot change.
Note 2
The values of [[IsLockFree1]] and [[IsLockFree2]] are not necessarily determined by the hardware, but may also reflect implementation choices that can vary over time and between ECMAScript implementations.
There is no [[IsLockFree4]] property: 4-byte atomic operations are always lock-free.
In practice, if an atomic operation is implemented with any type of lock the operation is not lock-free. Lock-free does not imply wait-free: there is no upper bound on how many machine steps may be required to complete a lock-free atomic operation.
That an atomic access of sizen is lock-free does not imply anything about the (perceived) atomicity of non-atomic accesses of sizen, specifically, non-atomic accesses may still be performed as a sequence of several separate memory accesses. SeeReadSharedMemory andWriteSharedMemory for details.
Note 3
Anagent is a specification mechanism and need not correspond to any particular artefact of an ECMAScript implementation.
9.6.1 AgentSignifier ( )
The abstract operation AgentSignifier takes no arguments. It performs the following steps when called:
In some environments it may not be reasonable for a givenagent to suspend. For example, in a web browser environment, it may be reasonable to disallow suspending a document's main event handling thread, while still allowing workers' event handling threads to suspend.
9.7 Agent Clusters
Anagent cluster is a maximal set of agents that can communicate by operating on shared memory.
Note 1
Programs within different agents may share memory by unspecified means. At a minimum, the backing memory for SharedArrayBuffer objects can be shared among the agents in the cluster.
There may be agents that can communicate by message passing that cannot share memory; they are never in the same agent cluster.
The agents in a cluster need not all be alive at some particular point in time. IfagentA creates anotheragentB, after whichA terminates andB createsagentC, the three agents are in the same cluster ifA could share some memory withB andB could share some memory withC.
All agents within a cluster must have the same value for the [[LittleEndian]] property in their respectiveAgent Records.
Note 3
If different agents within an agent cluster have different values of [[LittleEndian]] it becomes hard to use shared memory for multi-byte data.
All agents within a cluster must have the same values for the [[IsLockFree1]] property in their respectiveAgent Records; similarly for the [[IsLockFree2]] property.
All agents within a cluster must have different values for the [[Signifier]] property in their respectiveAgent Records.
An embedding may deactivate (stop forward progress) or activate (resume forward progress) anagent without theagent's knowledge or cooperation. If the embedding does so, it must not leave some agents in the cluster active while other agents in the cluster are deactivated indefinitely.
Note 4
The purpose of the preceding restriction is to avoid a situation where anagent deadlocks or starves because anotheragent has been deactivated. For example, if an HTML shared worker that has a lifetime independent of documents in any windows were allowed to share memory with the dedicated worker of such an independent document, and the document and its dedicated worker were to be deactivated while the dedicated worker holds a lock (say, the document is pushed into its window's history), and the shared worker then tries to acquire the lock, then the shared worker will be blocked until the dedicated worker is activated again, if ever. Meanwhile other workers trying to access the shared worker from other windows will starve.
The implication of the restriction is that it will not be possible to share memory between agents that don't belong to the same suspend/wake collective within the embedding.
An embedding may terminate anagent without any of theagent's cluster's other agents' prior knowledge or cooperation. If anagent is terminated not by programmatic action of its own or of anotheragent in the cluster but by forces external to the cluster, then the embedding must choose one of two strategies: Either terminate all the agents in the cluster, or provide reliable APIs that allow the agents in the cluster to coordinate so that at least one remaining member of the cluster will be able to detect the termination, with the termination data containing enough information to identify theagent that was terminated.
Note 5
Examples of that type of termination are: operating systems or users terminating agents that are running in separate processes; the embedding itself terminating anagent that is running in-process with the other agents when per-agent resource accounting indicates that theagent is runaway.
Prior to any evaluation of any ECMAScript code by anyagent in a cluster, the [[CandidateExecution]] field of theAgent Record for all agents in the cluster is set to the initialcandidate execution. The initialcandidate execution is anempty candidate execution whose [[EventsRecords]] field is aList containing, for eachagent, anAgent Events Record whose [[AgentSignifier]] field is thatagent's signifier, and whose [[EventList]] and [[AgentSynchronizesWith]] fields are empty Lists.
An agent cluster is a specification mechanism and need not correspond to any particular artefact of an ECMAScript implementation.
9.8 Forward Progress
For anagent tomake forward progress is for it to perform an evaluation step according to this specification.
Anagent becomesblocked when itsrunning execution context waits synchronously and indefinitely for an external event. Only agents whoseAgent Record's [[CanBlock]] property istrue can become blocked in this sense. Anunblockedagent is one that is not blocked.
Implementations must ensure that:
every unblockedagent with a dedicatedexecuting thread eventually makes forward progress
in a set of agents that share anexecuting thread, oneagent eventually makes forward progress
anagent does not cause anotheragent to become blocked except via explicit APIs that provide blocking.
Note
This, along with the liveness guarantee in thememory model, ensures that allSeqCst writes eventually become observable to all agents.
9.9 Processing Model of WeakRef and FinalizationRegistry Objects
9.9.1 Objectives
This specification does not make any guarantees that any object will be garbage collected. Objects which are notlive may be released after long periods of time, or never at all. For this reason, this specification uses the term "may" when describing behaviour triggered by garbage collection.
The semantics ofWeakRef andFinalizationRegistry objects is based on two operations which happen at particular points in time:
WhenWeakRef.prototype.deref is called, the referent (ifundefined is not returned) is kept alive so that subsequent, synchronous accesses also return the object. This list is reset when synchronous work is done using theClearKeptObjects abstract operation.
Some ECMAScript implementations include garbage collector implementations which run in the background, including when ECMAScript is idle. Letting thehost environment scheduleCleanupFinalizationRegistry allows it to resume ECMAScript execution in order to run finalizer work, which may free up held values, reducing overall memory usage.
9.9.2 Liveness
For some set of objectsS, ahypothetical WeakRef-oblivious execution with respect toS is an execution whereby the abstract operationWeakRefDeref of aWeakRef whose referent is an element ofS always returnsundefined.
Note 1
WeakRef-obliviousness, together with liveness, capture two notions. One, that aWeakRef itself does not keep an object alive. Two, that cycles in liveness does not imply that an object is live. To be concrete, if determiningobj's liveness depends on determining the liveness of anotherWeakRef referent,obj2,obj2's liveness cannot assumeobj's liveness, which would be circular reasoning.
Note 2
WeakRef-obliviousness is defined on sets of objects instead of individual objects to account for cycles. If it were defined on individual objects, then an object in a cycle will be considered live even though its Object value is only observed via WeakRefs of other objects in the cycle.
Note 3
Colloquially, we say that an individual object is live if every set of objects containing it is live.
At any point during evaluation, a set of objectsS is consideredlive if either of the following conditions is met:
Any element inS is included in anyagent's [[KeptAlive]]List.
There exists a valid future hypothetical WeakRef-oblivious execution with respect toS that observes the Object value of any object inS.
Note 4
The intuition the second condition above intends to capture is that an object is live if its identity is observable via non-WeakRef means. An object's identity may be observed by observing a strict equality comparison between objects or observing the object being used as key in a Map.
Note 5
Presence of an object in a field, an internal slot, or a property does not imply that the object is live. For example if the object in question is never passed back to the program, then it cannot be observed.
This is the case for keys in a WeakMap, members of a WeakSet, as well as the [[WeakRefTarget]] and [[UnregisterToken]] fields of aFinalizationRegistry Cell record.
The above definition implies that, if a key in a WeakMap is not live, then its corresponding value is not necessarily live either.
Note 6
Liveness is the lower bound for guaranteeing which WeakRefs engines must not empty. Liveness as defined here is undecidable. In practice, engines use conservative approximations such as reachability. There is expected to be significant implementation leeway.
9.9.3 Execution
At any time, if a set of objectsS is notlive, an ECMAScript implementation may perform the following steps atomically:
1.For each elementobj ofS, do
a.For eachWeakRefref such thatref.[[WeakRefTarget]] isobj, do
i.Setref.[[WeakRefTarget]] toempty.
b.For eachFinalizationRegistryfg such thatfg.[[Cells]] contains aRecordcell such thatcell.[[WeakRefTarget]] isobj, do
c.For each WeakMapmap such thatmap.[[WeakMapData]] contains aRecordr such thatr.[[Key]] isobj, do
i.Setr.[[Key]] toempty.
ii.Setr.[[Value]] toempty.
d.For each WeakSetset such thatset.[[WeakSetData]] containsobj, do
i.Replace the element ofset.[[WeakSetData]] whose value isobj with an element whose value isempty.
Note 1
Together with the definition of liveness, this clause prescribes legal optimizations that an implementation may apply regarding WeakRefs.
It is possible to access an object without observing its identity. Optimizations such as dead variable elimination and scalar replacement on properties of non-escaping objects whose identity is not observed are allowed. These optimizations are thus allowed to observably empty WeakRefs that point to such objects.
On the other hand, if an object's identity is observable, and that object is in the [[WeakRefTarget]] internal slot of aWeakRef, optimizations such as rematerialization that observably empty theWeakRef are prohibited.
Implementations are not obligated to empty WeakRefs for maximal sets of non-live objects.
If an implementation chooses a non-live setS in which to empty WeakRefs, it must empty WeakRefs for all objects inS simultaneously. In other words, an implementation must not empty aWeakRef pointing to an objectobj without emptying out other WeakRefs that, if not emptied, could result in an execution that observes the Object value ofobj.
The abstract operation HostEnqueueFinalizationRegistryCleanupJob takes argumentfinalizationRegistry (aFinalizationRegistry). HostEnqueueFinalizationRegistryCleanupJob is animplementation-defined abstract operation that is expected to callCleanupFinalizationRegistry(finalizationRegistry) at some point in the future, if possible. Thehost's responsibility is to make this call at a time which does not interrupt synchronous ECMAScript code execution.
9.10 ClearKeptObjects ( )
The abstract operation ClearKeptObjects takes no arguments. ECMAScript implementations are expected to call ClearKeptObjects when a synchronous sequence of ECMAScript executions completes. It performs the following steps when called:
When the abstract operation AddToKeptObjects is called with a target object reference, it adds the target to a list that will point strongly at the target untilClearKeptObjects is called.
The abstract operation CleanupFinalizationRegistry takes argumentfinalizationRegistry (aFinalizationRegistry). It performs the following steps when called:
1.Assert:finalizationRegistry has [[Cells]] and [[CleanupCallback]] internal slots.
10.1 Ordinary Object Internal Methods and Internal Slots
All ordinary objects have an internal slot called [[Prototype]]. The value of this internal slot is eithernull or an object and is used for implementing inheritance. Data properties of the [[Prototype]] object are inherited (and visible as properties of the child object) for the purposes of get access, but not for set access. Accessor properties are inherited for both get access and set access.
Everyordinary object has a Boolean-valued [[Extensible]] internal slot which is used to fulfill the extensibility-related internal method invariants specified in6.1.7.3. Namely, once the value of an object's [[Extensible]] internal slot has been set tofalse, it is no longer possible to add properties to the object, to modify the value of the object's [[Prototype]] internal slot, or to subsequently change the value of [[Extensible]] totrue.
Eachordinary object internal method delegates to a similarly-named abstract operation. If such an abstract operation depends on another internal method, then the internal method is invoked onO rather than calling the similarly-named abstract operation directly. These semantics ensure that exotic objects have their overridden internal methods invoked whenordinary object internal methods are applied to them.
10.1.1 [[GetPrototypeOf]] ( )
The [[GetPrototypeOf]] internal method of anordinary objectO takes no arguments. It performs the following steps when called:
The abstract operation OrdinarySetPrototypeOf takes argumentsO (an Object) andV (anECMAScript language value). It performs the following steps when called:
i.Ifp.[[GetPrototypeOf]] is not theordinary object internal method defined in10.1.1, setdone totrue.
ii.Else, setp top.[[Prototype]].
9.SetO.[[Prototype]] toV.
10.Returntrue.
Note
The loop in step8 guarantees that there will be no circularities in any prototype chain that only includes objects that use theordinary object definitions for [[GetPrototypeOf]] and [[SetPrototypeOf]].
10.1.3 [[IsExtensible]] ( )
The [[IsExtensible]] internal method of anordinary objectO takes no arguments. It performs the following steps when called:
b.SetD.[[Get]] to the value ofX's [[Get]] attribute.
c.SetD.[[Set]] to the value ofX's [[Set]] attribute.
7.SetD.[[Enumerable]] to the value ofX's [[Enumerable]] attribute.
8.SetD.[[Configurable]] to the value ofX's [[Configurable]] attribute.
9.ReturnD.
10.1.6 [[DefineOwnProperty]] (P,Desc )
The [[DefineOwnProperty]] internal method of anordinary objectO takes argumentsP (a property key) andDesc (aProperty Descriptor). It performs the following steps when called:
The abstract operation OrdinaryDefineOwnProperty takes argumentsO (an Object),P (a property key), andDesc (aProperty Descriptor). It performs the following steps when called:
The abstract operation IsCompatiblePropertyDescriptor takes argumentsExtensible (a Boolean),Desc (aProperty Descriptor), andCurrent (aProperty Descriptor). It performs the following steps when called:
The abstract operation ValidateAndApplyPropertyDescriptor takes argumentsO (an Object orundefined),P (a property key),extensible (a Boolean),Desc (aProperty Descriptor), andcurrent (aProperty Descriptor). It performs the following steps when called:
Note
Ifundefined is passed asO, only validation is performed and no object updates are performed.
i.IfO is notundefined, create an owndata property namedP of objectO whose [[Value]], [[Writable]], [[Enumerable]], and [[Configurable]] attribute values are described byDesc. If the value of an attribute field ofDesc is absent, the attribute of the newly created property is set to itsdefault value.
ii.IfO is notundefined, create an ownaccessor property namedP of objectO whose [[Get]], [[Set]], [[Enumerable]], and [[Configurable]] attribute values are described byDesc. If the value of an attribute field ofDesc is absent, the attribute of the newly created property is set to itsdefault value.
e.Returntrue.
3.If every field inDesc is absent, returntrue.
4.Ifcurrent.[[Configurable]] isfalse, then
a.IfDesc.[[Configurable]] is present and its value istrue, returnfalse.
b.IfDesc.[[Enumerable]] is present and ! SameValue(Desc.[[Enumerable]],current.[[Enumerable]]) isfalse, returnfalse.
i.IfO is notundefined, convert the property namedP of objectO from adata property to anaccessor property. Preserve the existing values of the converted property's [[Configurable]] and [[Enumerable]] attributes and set the rest of the property's attributes to theirdefault values.
c.Else,
i.IfO is notundefined, convert the property namedP of objectO from anaccessor property to adata property. Preserve the existing values of the converted property's [[Configurable]] and [[Enumerable]] attributes and set the rest of the property's attributes to theirdefault values.
The [[Get]] internal method of anordinary objectO takes argumentsP (a property key) andReceiver (anECMAScript language value). It performs the following steps when called:
The abstract operation OrdinaryGet takes argumentsO (an Object),P (a property key), andReceiver (anECMAScript language value). It performs the following steps when called:
The abstract operation OrdinarySet takes argumentsO (an Object),P (a property key),V (anECMAScript language value), andReceiver (anECMAScript language value). It performs the following steps when called:
The abstract operation OrdinaryObjectCreate takes argumentproto (an Object ornull) and optional argumentadditionalInternalSlotsList (aList of names of internal slots). It is used to specify the runtime creation of new ordinary objects.additionalInternalSlotsList contains the names of additional internal slots that must be defined as part of the object, beyond [[Prototype]] and [[Extensible]]. IfadditionalInternalSlotsList is not provided, a new emptyList is used. It performs the following steps when called:
1.LetinternalSlotsList be « [[Prototype]], [[Extensible]] ».
2.IfadditionalInternalSlotsList is present, append each of its elements tointernalSlotsList.
Although OrdinaryObjectCreate does little more than callMakeBasicObject, its use communicates the intention to create anordinary object, and not an exotic one. Thus, within this specification, it is not called by any algorithm that subsequently modifies the internal methods of the object in ways that would make the result non-ordinary. Operations that create exotic objects invokeMakeBasicObject directly.
The abstract operation OrdinaryCreateFromConstructor takes argumentsconstructor andintrinsicDefaultProto and optional argumentinternalSlotsList (aList of names of internal slots). It creates anordinary object whose [[Prototype]] value is retrieved from aconstructor's"prototype" property, if it exists. Otherwise the intrinsic named byintrinsicDefaultProto is used for [[Prototype]].internalSlotsList contains the names of additional internal slots that must be defined as part of the object. IfinternalSlotsList is not provided, a new emptyList is used. It performs the following steps when called:
1.Assert:intrinsicDefaultProto is a String value that is this specification's name of an intrinsic object. The corresponding object must be an intrinsic that is intended to be used as the [[Prototype]] value of an object.
The abstract operation GetPrototypeFromConstructor takes argumentsconstructor andintrinsicDefaultProto. It determines the [[Prototype]] value that should be used to create an object corresponding to a specificconstructor. The value is retrieved from theconstructor's"prototype" property, if it exists. Otherwise the intrinsic named byintrinsicDefaultProto is used for [[Prototype]]. It performs the following steps when called:
1.Assert:intrinsicDefaultProto is a String value that is this specification's name of an intrinsic object. The corresponding object must be an intrinsic that is intended to be used as the [[Prototype]] value of an object.
Ifconstructor does not supply a [[Prototype]] value, the default value that is used is obtained from therealm of theconstructor function rather than from therunning execution context.
10.1.15 RequireInternalSlot (O,internalSlot )
The abstract operation RequireInternalSlot takes argumentsO andinternalSlot. It throws an exception unlessO is an Object and has the given internal slot. It performs the following steps when called:
1.IfType(O) is not Object, throw aTypeError exception.
2.IfO does not have aninternalSlot internal slot, throw aTypeError exception.
10.2 ECMAScript Function Objects
ECMAScript function objects encapsulate parameterized ECMAScript code closed over a lexical environment and support the dynamic evaluation of that code. An ECMAScriptfunction object is anordinary object and has the same internal slots and the same internal methods as other ordinary objects. The code of an ECMAScriptfunction object may be eitherstrict mode code (11.2.2) ornon-strict code. An ECMAScriptfunction object whose code isstrict mode code is called astrict function. One whose code is notstrict mode code is called anon-strict function.
In addition to [[Extensible]] and [[Prototype]], ECMAScript function objects also have the internal slots listed inTable 29.
Table 29: Internal Slots of ECMAScript Function Objects
The script or module in which the function was created.
[[ThisMode]]
lexical |strict |global
Defines howthis references are interpreted within the formal parameters and code body of the function.lexical means thatthis refers to thethis value of a lexically enclosing function.strict means that thethis value is used exactly as provided by an invocation of the function.global means that athis value ofundefined ornull is interpreted as a reference to theglobal object, and any otherthis value is first passed toToObject.
Indicates whether the function is a classconstructor. (Iftrue, invoking the function's [[Call]] will immediately throw aTypeError exception.)
All ECMAScript function objects have the [[Call]] internal method defined here. ECMAScript functions that are also constructors in addition have the [[Construct]] internal method.
10.2.1 [[Call]] (thisArgument,argumentsList )
The [[Call]] internal method of an ECMAScriptfunction objectF takes argumentsthisArgument (anECMAScript language value) andargumentsList (aList of ECMAScript language values). It performs the following steps when called:
WhencalleeContext is removed from theexecution context stack in step8 it must not be destroyed if it is suspended and retained for later resumption by an accessible generator object.
10.2.1.1 PrepareForOrdinaryCall (F,newTarget )
The abstract operation PrepareForOrdinaryCall takes argumentsF (afunction object) andnewTarget (anECMAScript language value). It performs the following steps when called:
The abstract operation OrdinaryCallEvaluateBody takes argumentsF (afunction object) andargumentsList (aList). It performs the following steps when called:
1.Return the result ofEvaluateBody of the parsed code that isF.[[ECMAScriptCode]] passingF andargumentsList as the arguments.
10.2.2 [[Construct]] (argumentsList,newTarget )
The [[Construct]] internal method of an ECMAScriptfunction objectF takes argumentsargumentsList (aList of ECMAScript language values) andnewTarget (aconstructor). It performs the following steps when called:
The abstract operation OrdinaryFunctionCreate takes argumentsfunctionPrototype (an Object),sourceText (a sequence of Unicode code points),ParameterList (aParse Node),Body (aParse Node),thisMode (eitherlexical-this ornon-lexical-this), andScope (anEnvironment Record).sourceText is the source text of the syntactic definition of the function to be created. It performs the following steps when called:
The abstract operation AddRestrictedFunctionProperties takes argumentsF (afunction object) andrealm (aRealm Record). It performs the following steps when called:
The%ThrowTypeError% intrinsic is an anonymous built-infunction object that is defined once for eachrealm. When %ThrowTypeError% is called it performs the following steps:
1.Throw aTypeError exception.
The value of the [[Extensible]] internal slot of a %ThrowTypeError% function isfalse.
The"length" property of a %ThrowTypeError% function has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
The"name" property of a %ThrowTypeError% function has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
The abstract operation MakeConstructor takes argumentF (afunction object) and optional argumentswritablePrototype (a Boolean) andprototype (an Object). It convertsF into aconstructor. It performs the following steps when called:
The abstract operation SetFunctionName takes argumentsF (afunction object) andname (a property key) and optional argumentprefix (a String). It adds a"name" property toF. It performs the following steps when called:
1.Assert:F is an extensible object that does not have a"name" own property.
The abstract operation SetFunctionLength takes argumentsF (afunction object) andlength (a non-negativeinteger or +∞). It adds a"length" property toF. It performs the following steps when called:
1.Assert:F is an extensible object that does not have a"length" own property.
When anexecution context is established for evaluating an ECMAScript function a newfunction Environment Record is created and bindings for each formal parameter are instantiated in thatEnvironment Record. Each declaration in the function body is also instantiated. If the function's formal parameters do not include any default value initializers then the body declarations are instantiated in the sameEnvironment Record as the parameters. If default value parameter initializers exist, a secondEnvironment Record is created for the body declarations. Formal parameters and functions are initialized as part of FunctionDeclarationInstantiation. All other bindings are initialized during evaluation of the function body.
The abstract operation FunctionDeclarationInstantiation takes argumentsfunc (afunction object) andargumentsList.func is thefunction object for which theexecution context is being established. It performs the following steps when called:
ii.Letfn be the sole element of theBoundNames ofd.
iii.Iffn is not an element offunctionNames, then
1.Insertfn as the first element offunctionNames.
2.NOTE: If there are multiple function declarations for the same name, the last declaration is used.
3.Insertd as the first element offunctionsToInitialize.
15.LetargumentsObjectNeeded betrue.
16.Iffunc.[[ThisMode]] islexical, then
a.NOTE: Arrow functions never have an arguments objects.
b.SetargumentsObjectNeeded tofalse.
17.Else if"arguments" is an element ofparameterNames, then
a.SetargumentsObjectNeeded tofalse.
18.Else ifhasParameterExpressions isfalse, then
a.If"arguments" is an element offunctionNames or if"arguments" is an element oflexicalNames, then
i.SetargumentsObjectNeeded tofalse.
19.Ifstrict istrue or ifhasParameterExpressions isfalse, then
a.NOTE: Only a singleEnvironment Record is needed for the parameters and top-level vars.
b.Letenv be the LexicalEnvironment ofcalleeContext.
20.Else,
a.NOTE: A separateEnvironment Record is needed to ensure that bindings created bydirect eval calls in the formal parameter list are outside the environment where parameters are declared.
b.LetcalleeEnv be the LexicalEnvironment ofcalleeContext.
d.Assert: The VariableEnvironment ofcalleeContext iscalleeEnv.
e.Set the LexicalEnvironment ofcalleeContext toenv.
21.For each StringparamName ofparameterNames, do
a.LetalreadyDeclared beenv.HasBinding(paramName).
b.NOTE: Early errors ensure that duplicate parameter names can only occur in non-strict functions that do not have parameter default values or rest parameters.
i.NOTE: A mapped argument object is only provided for non-strict functions that don't have a rest parameter, any parameter default value initializers, or any destructured parameters.
a.NOTE: Only a singleEnvironment Record is needed for the parameters and top-level vars.
b.LetinstantiatedVarNames be a copy of theListparameterBindings.
c.For each elementn ofvarNames, do
i.Ifn is not an element ofinstantiatedVarNames, then
1.Appendn toinstantiatedVarNames.
2.Perform !env.CreateMutableBinding(n,false).
3.Callenv.InitializeBinding(n,undefined).
d.LetvarEnv beenv.
28.Else,
a.NOTE: A separateEnvironment Record is needed to ensure that closures created by expressions in the formal parameter list do not have visibility of declarations in the function body.
b.NOTE: Non-strict functions use a separateEnvironment Record for top-level lexical declarations so that adirect eval can determine whether any var scoped declarations introduced by the eval code conflict with pre-existing top-level lexically scoped declarations. This is not needed for strict functions because a strictdirect eval always places all declarations into a newEnvironment Record.
31.Else, letlexEnv bevarEnv.
32.Set the LexicalEnvironment ofcalleeContext tolexEnv.
a.NOTE: A lexically declared name cannot be the same as a function/generator declaration, formal parameter, or a var name. Lexically declared names are only instantiated here but not initialized.
B.3.3 provides an extension to the above algorithm that is necessary for backwards compatibility with web browser implementations of ECMAScript that predate ECMAScript 2015.
Note 3
ParameterInitializers may containdirect eval expressions. Any top level declarations of such evals are only visible to the eval code (11.2). The creation of the environment for such declarations is described in8.5.3.
10.3 Built-in Function Objects
The built-in function objects defined in this specification may be implemented as either ECMAScript function objects (10.2) whose behaviour is provided using ECMAScript code or as implementation provided function exotic objects whose behaviour is provided in some other manner. In either case, the effect of calling such functions must conform to their specifications. An implementation may also provide additional built-in function objects that are not defined in this specification.
If a built-infunction object is implemented as anexotic object it must have theordinary object behaviour specified in10.1. All such function exotic objects also have [[Prototype]], [[Extensible]], and [[Realm]] internal slots.
Unless otherwise specified every built-infunction object has the%Function.prototype% object as the initial value of its [[Prototype]] internal slot.
The behaviour specified for each built-in function via algorithm steps or other means is the specification of the function body behaviour for both [[Call]] and [[Construct]] invocations of the function. However, [[Construct]] invocation is not supported by all built-in functions. For each built-in function, when invoked with [[Call]], the [[Call]]thisArgument provides thethis value, the [[Call]]argumentsList provides the named parameters, and the NewTarget value isundefined. When invoked with [[Construct]], thethis value is uninitialized, the [[Construct]]argumentsList provides the named parameters, and the [[Construct]]newTarget parameter provides the NewTarget value. If the built-in function is implemented as an ECMAScriptfunction object then this specified behaviour must be implemented by the ECMAScript code that is the body of the function. Built-in functions that are ECMAScript function objects must be strict functions. If a built-inconstructor has any [[Call]] behaviour other than throwing aTypeError exception, an ECMAScript implementation of the function must be done in a manner that does not cause the function's [[IsClassConstructor]] internal slot to have the valuetrue.
Built-in function objects that are not identified as constructors do not implement the [[Construct]] internal method unless otherwise specified in the description of a particular function. When a built-inconstructor is called as part of anew expression theargumentsList parameter of the invoked [[Construct]] internal method provides the values for the built-inconstructor's named parameters.
Built-in functions that are not constructors do not have a"prototype" property unless otherwise specified in the description of a particular function.
Built-in functions have an [[InitialName]] internal slot.
If a built-infunction object is not implemented as an ECMAScript function it must provide [[Call]] and [[Construct]] internal methods that conform to the following definitions:
10.3.1 [[Call]] (thisArgument,argumentsList )
The [[Call]] internal method of a built-infunction objectF takes argumentsthisArgument (anECMAScript language value) andargumentsList (aList of ECMAScript language values). It performs the following steps when called:
10.Letresult be theCompletion Record that is the result of evaluatingF in a manner that conforms to the specification ofF.thisArgument is thethis value,argumentsList provides the named parameters, and the NewTarget value isundefined.
WhencalleeContext is removed from theexecution context stack it must not be destroyed if it has been suspended and retained by an accessible generator object for later resumption.
10.3.2 [[Construct]] (argumentsList,newTarget )
The [[Construct]] internal method of a built-infunction objectF takes argumentsargumentsList (aList of ECMAScript language values) andnewTarget (aconstructor). The steps performed are the same as [[Call]] (see10.3.1) except that step10 is replaced by:
1.Letresult be theCompletion Record that is the result of evaluatingF in a manner that conforms to the specification ofF. Thethis value is uninitialized,argumentsList provides the named parameters, andnewTarget provides the NewTarget value.
The abstract operation CreateBuiltinFunction takes argumentssteps,length,name, andinternalSlotsList (aList of names of internal slots) and optional argumentsrealm,prototype, andprefix.internalSlotsList contains the names of additional internal slots that must be defined as part of the object. This operation creates a built-infunction object. It performs the following steps when called:
1.Assert:steps is either a set of algorithm steps or other definition of a function's behaviour provided in this specification.
4.Ifprototype is not present, setprototype torealm.[[Intrinsics]].[[%Function.prototype%]].
5.Letfunc be a new built-infunction object that when called performs the action described bysteps. The newfunction object has internal slots whose names are the elements ofinternalSlotsList, and an [[InitialName]] internal slot.
Each built-in function defined in this specification is created by calling the CreateBuiltinFunction abstract operation.
10.4 Built-in Exotic Object Internal Methods and Slots
This specification defines several kinds of built-in exotic objects. These objects generally behave similar to ordinary objects except for a few specific situations. The following exotic objects use theordinary object internal methods except where it is explicitly specified otherwise below:
An object is abound function exotic object if its [[Call]] and (if applicable) [[Construct]] internal methods use the following implementations, and its other essential internal methods use the definitions found in10.1. These methods are installed inBoundFunctionCreate.
Bound function exotic objects do not have the internal slots of ECMAScript function objects listed inTable 29. Instead they have the internal slots listed inTable 30, in addition to [[Prototype]] and [[Extensible]].
Table 30: Internal Slots of Bound Function Exotic Objects
The [[Construct]] internal method of abound function exotic objectF takes argumentsargumentsList (aList of ECMAScript language values) andnewTarget (aconstructor). It performs the following steps when called:
The abstract operation BoundFunctionCreate takes argumentstargetFunction,boundThis, andboundArgs. It is used to specify the creation of newbound function exotic objects. It performs the following steps when called:
An Array object is anexotic object that gives special treatment toarray index property keys (see6.1.7). A property whoseproperty name is anarray index is also called anelement. Every Array object has a non-configurable"length" property whose value is always a non-negativeintegral Number whosemathematical value is less than 232. The value of the"length" property is numerically greater than the name of every own property whose name is anarray index; whenever an own property of an Array object is created or changed, other properties are adjusted as necessary to maintain this invariant. Specifically, whenever an own property is added whose name is anarray index, the value of the"length" property is changed, if necessary, to be one more than the numeric value of thatarray index; and whenever the value of the"length" property is changed, every own property whose name is anarray index whose value is not smaller than the new length is deleted. This constraint applies only to own properties of an Array object and is unaffected by"length" orarray index properties that may be inherited from its prototypes.
An object is anArray exotic object (or simply, an Array object) if its [[DefineOwnProperty]] internal method uses the following implementation, and its other essential internal methods use the definitions found in10.1. These methods are installed inArrayCreate.
10.4.2.1 [[DefineOwnProperty]] (P,Desc )
The [[DefineOwnProperty]] internal method of anArray exotic objectA takes argumentsP (a property key) andDesc (aProperty Descriptor). It performs the following steps when called:
The abstract operation ArrayCreate takes argumentlength (a non-negativeinteger) and optional argumentproto. It is used to specify the creation of new Array exotic objects. It performs the following steps when called:
The abstract operation ArraySpeciesCreate takes argumentsoriginalArray andlength (a non-negativeinteger). It is used to specify the creation of a new Array object using aconstructor function that is derived fromoriginalArray. It performs the following steps when called:
IforiginalArray was created using the standard built-in Arrayconstructor for arealm that is not therealm of therunning execution context, then a new Array is created using therealm of therunning execution context. This maintains compatibility with Web browsers that have historically had that behaviour for theArray.prototype methods that now are defined using ArraySpeciesCreate.
10.4.2.4 ArraySetLength (A,Desc )
The abstract operation ArraySetLength takes argumentsA (an Array object) andDesc (aProperty Descriptor). It performs the following steps when called:
In steps3 and4, ifDesc.[[Value]] is an object then itsvalueOf method is called twice. This is legacy behaviour that was specified with this effect starting with the 2nd Edition of this specification.
10.4.3 String Exotic Objects
A String object is anexotic object that encapsulates a String value and exposes virtualinteger-indexed data properties corresponding to the individual code unit elements of the String value. String exotic objects always have adata property named"length" whose value is the number of code unit elements in the encapsulated String value. Both the code unit data properties and the"length" property are non-writable and non-configurable.
An object is aString exotic object (or simply, a String object) if its [[GetOwnProperty]], [[DefineOwnProperty]], and [[OwnPropertyKeys]] internal methods use the following implementations, and its other essential internal methods use the definitions found in10.1. These methods are installed inStringCreate.
String exotic objects have the same internal slots as ordinary objects. They also have a [[StringData]] internal slot.
10.4.3.1 [[GetOwnProperty]] (P )
The [[GetOwnProperty]] internal method of aString exotic objectS takes argumentP (a property key). It performs the following steps when called:
The [[DefineOwnProperty]] internal method of aString exotic objectS takes argumentsP (a property key) andDesc (aProperty Descriptor). It performs the following steps when called:
5.For eachintegeri starting with 0 such thati <len, in ascending order, do
a.Add ! ToString(𝔽(i)) as the last element ofkeys.
6.For each own property keyP ofO such thatP is anarray index and ! ToIntegerOrInfinity(P) ≥len, in ascending numeric index order, do
a.AddP as the last element ofkeys.
7.For each own property keyP ofO such thatType(P) is String andP is not anarray index, in ascending chronological order of property creation, do
a.AddP as the last element ofkeys.
8.For each own property keyP ofO such thatType(P) is Symbol, in ascending chronological order of property creation, do
a.AddP as the last element ofkeys.
9.Returnkeys.
10.4.3.4 StringCreate (value,prototype )
The abstract operation StringCreate takes argumentsvalue (a String) andprototype. It is used to specify the creation of new String exotic objects. It performs the following steps when called:
1.LetS be ! MakeBasicObject(« [[Prototype]], [[Extensible]], [[StringData]] »).
2.SetS.[[Prototype]] toprototype.
3.SetS.[[StringData]] tovalue.
4.SetS.[[GetOwnProperty]] as specified in10.4.3.1.
5.SetS.[[DefineOwnProperty]] as specified in10.4.3.2.
6.SetS.[[OwnPropertyKeys]] as specified in10.4.3.3.
7.Letlength be the number of code unit elements invalue.
12.LetresultStr be the String value of length 1, containing one code unit fromstr, specifically the code unit at indexℝ(index).
13.Return the PropertyDescriptor { [[Value]]:resultStr, [[Writable]]:false, [[Enumerable]]:true, [[Configurable]]:false }.
10.4.4 Arguments Exotic Objects
Most ECMAScript functions make an arguments object available to their code. Depending upon the characteristics of the function definition, its arguments object is either anordinary object or anarguments exotic object. Anarguments exotic object is anexotic object whosearray index properties map to the formal parameters bindings of an invocation of its associated ECMAScript function.
An object is anarguments exotic object if its internal methods use the following implementations, with the ones not specified here using those found in10.1. These methods are installed inCreateMappedArgumentsObject.
Arguments exotic objects have the same internal slots as ordinary objects. They also have a [[ParameterMap]] internal slot. Ordinary arguments objects also have a [[ParameterMap]] internal slot whose value is always undefined. For ordinary argument objects the [[ParameterMap]] internal slot is only used byObject.prototype.toString (20.1.3.6) to identify them as such.
Note 2
Theinteger-indexed data properties of anarguments exotic object whose numeric name values are less than the number of formal parameters of the correspondingfunction object initially share their values with the corresponding argument bindings in the function'sexecution context. This means that changing the property changes the corresponding value of the argument binding and vice-versa. This correspondence is broken if such a property is deleted and then redefined or if the property is changed into anaccessor property. If the arguments object is anordinary object, the values of its properties are simply a copy of the arguments passed to the function and there is no dynamic linkage between the property values and the formal parameter values.
Note 3
The ParameterMap object and its property values are used as a device for specifying the arguments object correspondence to argument bindings. The ParameterMap object and the objects that are the values of its properties are not directly observable from ECMAScript code. An ECMAScript implementation does not need to actually create or use such objects to implement the specified semantics.
Note 4
Ordinary arguments objects define a non-configurableaccessor property named"callee" which throws aTypeError exception on access. The"callee" property has a more specific meaning for arguments exotic objects, which are created only for some class of non-strict functions. The definition of this property in the ordinary variant exists to ensure that it is not defined in any other manner by conforming ECMAScript implementations.
Note 5
ECMAScript implementations of arguments exotic objects have historically contained anaccessor property named"caller". Prior to ECMAScript 2017, this specification included the definition of a throwing"caller" property on ordinary arguments objects. Since implementations do not contain this extension any longer, ECMAScript 2017 dropped the requirement for a throwing"caller" accessor.
10.4.4.1 [[GetOwnProperty]] (P )
The [[GetOwnProperty]] internal method of anarguments exotic objectargs takes argumentP (a property key). It performs the following steps when called:
The [[DefineOwnProperty]] internal method of anarguments exotic objectargs takes argumentsP (a property key) andDesc (aProperty Descriptor). It performs the following steps when called:
The abstract operation CreateMappedArgumentsObject takes argumentsfunc (an Object),formals (aParse Node),argumentsList (aList), andenv (anEnvironment Record). It performs the following steps when called:
1.Assert:formals does not contain a rest parameter, any binding patterns, or any initializers. It may contain duplicate identifiers.
2.Letlen be the number of elements inargumentsList.
3.Letobj be ! MakeBasicObject(« [[Prototype]], [[Extensible]], [[ParameterMap]] »).
4.Setobj.[[GetOwnProperty]] as specified in10.4.4.1.
5.Setobj.[[DefineOwnProperty]] as specified in10.4.4.2.
The abstract operation MakeArgGetter takes argumentsname (a String) andenv (anEnvironment Record). It creates a built-infunction object that when executed returns the value bound forname inenv. It performs the following steps when called:
1.Letsteps be the steps of an ArgGetter function as specified below.
2.Letlength be the number of non-optional parameters of an ArgGetter function as specified below.
An ArgGetter function is an anonymous built-in function with [[Name]] and [[Env]] internal slots. When an ArgGetter function that expects no arguments is called it performs the following steps:
ArgGetter functions are never directly accessible to ECMAScript code.
10.4.4.7.2 MakeArgSetter (name,env )
The abstract operation MakeArgSetter takes argumentsname (a String) andenv (anEnvironment Record). It creates a built-infunction object that when executed sets the value bound forname inenv. It performs the following steps when called:
1.Letsteps be the steps of an ArgSetter function as specified below.
2.Letlength be the number of non-optional parameters of an ArgSetter function as specified below.
An ArgSetter function is an anonymous built-in function with [[Name]] and [[Env]] internal slots. When an ArgSetter function is called with argumentvalue it performs the following steps:
Integer-Indexed exotic objects have the same internal slots as ordinary objects and additionally [[ViewedArrayBuffer]], [[ArrayLength]], [[ByteOffset]], [[ContentType]], and [[TypedArrayName]] internal slots.
An object is anInteger-Indexed exotic object if its [[GetOwnProperty]], [[HasProperty]], [[DefineOwnProperty]], [[Get]], [[Set]], [[Delete]], and [[OwnPropertyKeys]] internal methods use the definitions in this section, and its other essential internal methods use the definitions found in10.1. These methods are installed byIntegerIndexedObjectCreate.
10.4.5.1 [[GetOwnProperty]] (P )
The [[GetOwnProperty]] internal method of anInteger-Indexed exotic objectO takes argumentP (a property key). It performs the following steps when called:
a.For eachintegeri starting with 0 such thati <O.[[ArrayLength]], in ascending order, do
i.Add ! ToString(𝔽(i)) as the last element ofkeys.
4.For each own property keyP ofO such thatType(P) is String andP is not aninteger index, in ascending chronological order of property creation, do
a.AddP as the last element ofkeys.
5.For each own property keyP ofO such thatType(P) is Symbol, in ascending chronological order of property creation, do
a.AddP as the last element ofkeys.
6.Returnkeys.
10.4.5.8 IntegerIndexedObjectCreate (prototype )
The abstract operation IntegerIndexedObjectCreate takes argumentprototype. It is used to specify the creation of newInteger-Indexed exotic objects. It performs the following steps when called:
This operation always appears to succeed, but it has no effect when attempting to write past the end of a TypedArray or to a TypedArray which is backed by a detached ArrayBuffer.
10.4.6 Module Namespace Exotic Objects
Amodule namespace exotic object is anexotic object that exposes the bindings exported from an ECMAScriptModule (See16.2.3). There is a one-to-one correspondence between the String-keyed own properties of amodule namespace exotic object and the binding names exported by theModule. The exported bindings include any bindings that are indirectly exported usingexport * export items. Each String-valued own property key is theStringValue of the corresponding exported binding name. These are the only String-keyed properties of amodule namespace exotic object. Each such property has the attributes { [[Writable]]:true, [[Enumerable]]:true, [[Configurable]]:false }. Module namespace exotic objects are not extensible.
An object is amodule namespace exotic object if its [[SetPrototypeOf]], [[IsExtensible]], [[PreventExtensions]], [[GetOwnProperty]], [[DefineOwnProperty]], [[HasProperty]], [[Get]], [[Set]], [[Delete]], and [[OwnPropertyKeys]] internal methods use the definitions in this section, and its other essential internal methods use the definitions found in10.1. These methods are installed byModuleNamespaceCreate.
Module namespace exotic objects have the internal slots defined inTable 31.
Table 31: Internal Slots of Module Namespace Exotic Objects
AList whose elements are the String values of the exported names exposed as own properties of this object. The list is ordered as if an Array of those String values had been sorted using %Array.prototype.sort% usingundefined ascomparefn.
[[Prototype]]
Null
This slot always contains the valuenull (see10.4.6.1).
Module namespace exotic objects provide alternative definitions for all of the internal methods except [[GetPrototypeOf]], which behaves as defined in10.1.1.
10.4.6.1 [[SetPrototypeOf]] (V )
The [[SetPrototypeOf]] internal method of amodule namespace exotic objectO takes argumentV (an Object ornull). It performs the following steps when called:
The [[IsExtensible]] internal method of amodule namespace exotic object takes no arguments. It performs the following steps when called:
1.Returnfalse.
10.4.6.3 [[PreventExtensions]] ( )
The [[PreventExtensions]] internal method of amodule namespace exotic object takes no arguments. It performs the following steps when called:
1.Returntrue.
10.4.6.4 [[GetOwnProperty]] (P )
The [[GetOwnProperty]] internal method of amodule namespace exotic objectO takes argumentP (a property key). It performs the following steps when called:
ResolveExport is side-effect free. Each time this operation is called with a specificexportName,resolveSet pair as arguments it must return the same result. An implementation might choose to pre-compute or cache the ResolveExport results for the [[Exports]] of eachmodule namespace exotic object.
3.Append all the entries ofsymbolKeys to the end ofexports.
4.Returnexports.
10.4.6.11 ModuleNamespaceCreate (module,exports )
The abstract operation ModuleNamespaceCreate takes argumentsmodule andexports. It is used to specify the creation of new module namespace exotic objects. It performs the following steps when called:
6.SetM's essential internal methods to the definitions specified in10.4.6.
7.SetM.[[Prototype]] tonull.
8.SetM.[[Module]] tomodule.
9.LetsortedExports be aList whose elements are the elements ofexports ordered as if an Array of the same values had been sorted using %Array.prototype.sort% usingundefined ascomparefn.
10.SetM.[[Exports]] tosortedExports.
11.Create own properties ofM corresponding to the definitions in28.3.
An object is animmutable prototype exotic object if its [[SetPrototypeOf]] internal method uses the following implementation. (Its other essential internal methods may use any implementation, depending on the specificimmutable prototype exotic object in question.)
Note
Unlike other exotic objects, there is not a dedicated creation abstract operation provided for immutable prototype exotic objects. This is because they are only used by%Object.prototype% and byhost environments, and inhost environments, the relevant objects are potentially exotic in other ways and thus need their own dedicated creation operation.
10.4.7.1 [[SetPrototypeOf]] (V )
The [[SetPrototypeOf]] internal method of animmutable prototype exotic objectO takes argumentV (an Object ornull). It performs the following steps when called:
10.5 Proxy Object Internal Methods and Internal Slots
A proxy object is anexotic object whose essential internal methods are partially implemented using ECMAScript code. Every proxy object has an internal slot called [[ProxyHandler]]. The value of [[ProxyHandler]] is an object, called the proxy'shandler object, ornull. Methods (seeTable 32) of a handler object may be used to augment the implementation for one or more of the proxy object's internal methods. Every proxy object also has an internal slot called [[ProxyTarget]] whose value is either an object or thenull value. This object is called the proxy'starget object.
An object is aProxy exotic object if its essential internal methods (including [[Call]] and [[Construct]], if applicable) use the definitions in this section. These internal methods are installed inProxyCreate.
Table 32: Proxy Handler Methods
Internal Method
Handler Method
[[GetPrototypeOf]]
getPrototypeOf
[[SetPrototypeOf]]
setPrototypeOf
[[IsExtensible]]
isExtensible
[[PreventExtensions]]
preventExtensions
[[GetOwnProperty]]
getOwnPropertyDescriptor
[[DefineOwnProperty]]
defineProperty
[[HasProperty]]
has
[[Get]]
get
[[Set]]
set
[[Delete]]
deleteProperty
[[OwnPropertyKeys]]
ownKeys
[[Call]]
apply
[[Construct]]
construct
When a handler method is called to provide the implementation of a proxy object internal method, the handler method is passed the proxy's target object as a parameter. A proxy's handler object does not necessarily have a method corresponding to every essential internal method. Invoking an internal method on the proxy results in the invocation of the corresponding internal method on the proxy's target object if the handler object does not have a method corresponding to the internal trap.
The [[ProxyHandler]] and [[ProxyTarget]] internal slots of a proxy object are always initialized when the object is created and typically may not be modified. Some proxy objects are created in a manner that permits them to be subsequentlyrevoked. When a proxy is revoked, its [[ProxyHandler]] and [[ProxyTarget]] internal slots are set tonull causing subsequent invocations of internal methods on that proxy object to throw aTypeError exception.
Because proxy objects permit the implementation of internal methods to be provided by arbitrary ECMAScript code, it is possible to define a proxy object whose handler methods violates the invariants defined in6.1.7.3. Some of the internal method invariants defined in6.1.7.3 are essential integrity invariants. These invariants are explicitly enforced by the proxy object internal methods specified in this section. An ECMAScript implementation must be robust in the presence of all possible invariant violations.
In the following algorithm descriptions, assumeO is an ECMAScript proxy object,P is a property key value,V is anyECMAScript language value andDesc is aProperty Descriptor record.
10.5.1 [[GetPrototypeOf]] ( )
The [[GetPrototypeOf]] internal method of aProxy exotic objectO takes no arguments. It performs the following steps when called:
[[GetPrototypeOf]] for proxy objects enforces the following invariants:
The result of [[GetPrototypeOf]] must be either an Object ornull.
If the target object is not extensible, [[GetPrototypeOf]] applied to the proxy object must return the same value as [[GetPrototypeOf]] applied to the proxy object's target object.
10.5.2 [[SetPrototypeOf]] (V )
The [[SetPrototypeOf]] internal method of aProxy exotic objectO takes argumentV (an Object ornull). It performs the following steps when called:
[[IsExtensible]] for proxy objects enforces the following invariants:
The result of [[IsExtensible]] is a Boolean value.
[[IsExtensible]] applied to the proxy object must return the same value as [[IsExtensible]] applied to the proxy object's target object with the same argument.
10.5.4 [[PreventExtensions]] ( )
The [[PreventExtensions]] internal method of aProxy exotic objectO takes no arguments. It performs the following steps when called:
[[GetOwnProperty]] for proxy objects enforces the following invariants:
The result of [[GetOwnProperty]] must be either an Object orundefined.
A property cannot be reported as non-existent, if it exists as a non-configurable own property of the target object.
A property cannot be reported as non-existent, if the target object is not extensible, unless it does not exist as an own property of the target object.
A property cannot be reported as existent, if the target object is not extensible, unless it exists as an own property of the target object.
A property cannot be reported as non-configurable, unless it exists as a non-configurable own property of the target object.
A property cannot be reported as both non-configurable and non-writable, unless it exists as a non-configurable, non-writable own property of the target object.
10.5.6 [[DefineOwnProperty]] (P,Desc )
The [[DefineOwnProperty]] internal method of aProxy exotic objectO takes argumentsP (a property key) andDesc (aProperty Descriptor). It performs the following steps when called:
c.IfIsDataDescriptor(targetDesc) istrue,targetDesc.[[Configurable]] isfalse, andtargetDesc.[[Writable]] istrue, then
i.IfDesc has a [[Writable]] field andDesc.[[Writable]] isfalse, throw aTypeError exception.
17.Returntrue.
Note
[[DefineOwnProperty]] for proxy objects enforces the following invariants:
The result of [[DefineOwnProperty]] is a Boolean value.
A property cannot be added, if the target object is not extensible.
A property cannot be non-configurable, unless there exists a corresponding non-configurable own property of the target object.
A non-configurable property cannot be non-writable, unless there exists a corresponding non-configurable, non-writable own property of the target object.
If a property has a corresponding target object property then applying theProperty Descriptor of the property to the target object using [[DefineOwnProperty]] will not throw an exception.
10.5.7 [[HasProperty]] (P )
The [[HasProperty]] internal method of aProxy exotic objectO takes argumentP (a property key). It performs the following steps when called:
b.IfIsAccessorDescriptor(targetDesc) istrue andtargetDesc.[[Get]] isundefined, then
i.IftrapResult is notundefined, throw aTypeError exception.
11.ReturntrapResult.
Note
[[Get]] for proxy objects enforces the following invariants:
The value reported for a property must be the same as the value of the corresponding target object property if the target object property is a non-writable, non-configurable owndata property.
The value reported for a property must beundefined if the corresponding target object property is a non-configurable ownaccessor property that hasundefined as its [[Get]] attribute.
[[Set]] for proxy objects enforces the following invariants:
The result of [[Set]] is a Boolean value.
Cannot change the value of a property to be different from the value of the corresponding target object property if the corresponding target object property is a non-writable, non-configurable owndata property.
Cannot set the value of a property if the corresponding target object property is a non-configurable ownaccessor property that hasundefined as its [[Set]] attribute.
10.5.10 [[Delete]] (P )
The [[Delete]] internal method of aProxy exotic objectO takes argumentP (a property key). It performs the following steps when called:
The Type of each resultList element is either String or Symbol.
The resultList must contain the keys of all non-configurable own properties of the target object.
If the target object is not extensible, then the resultList must contain all the keys of the own properties of the target object and no other values.
10.5.12 [[Call]] (thisArgument,argumentsList )
The [[Call]] internal method of aProxy exotic objectO takes argumentsthisArgument (anECMAScript language value) andargumentsList (aList of ECMAScript language values). It performs the following steps when called:
AProxy exotic object only has a [[Call]] internal method if the initial value of its [[ProxyTarget]] internal slot is an object that has a [[Call]] internal method.
10.5.13 [[Construct]] (argumentsList,newTarget )
The [[Construct]] internal method of aProxy exotic objectO takes argumentsargumentsList (aList of ECMAScript language values) andnewTarget (aconstructor). It performs the following steps when called:
9.LetnewObj be ? Call(trap,handler, «target,argArray,newTarget »).
10.IfType(newObj) is not Object, throw aTypeError exception.
11.ReturnnewObj.
Note 1
AProxy exotic object only has a [[Construct]] internal method if the initial value of its [[ProxyTarget]] internal slot is an object that has a [[Construct]] internal method.
Note 2
[[Construct]] for proxy objects enforces the following invariants:
The result of [[Construct]] must be an Object.
10.5.14 ProxyCreate (target,handler )
The abstract operation ProxyCreate takes argumentstarget andhandler. It is used to specify the creation of new Proxy exotic objects. It performs the following steps when called:
1.IfType(target) is not Object, throw aTypeError exception.
2.IfType(handler) is not Object, throw aTypeError exception.
3.LetP be ! MakeBasicObject(« [[ProxyHandler]], [[ProxyTarget]] »).
4.SetP's essential internal methods, except for [[Call]] and [[Construct]], to the definitions specified in10.5.
ECMAScript code is expressed using Unicode. ECMAScript source text is a sequence of code points. All Unicode code point values from U+0000 to U+10FFFF, including surrogate code points, may occur in source text where permitted by the ECMAScript grammars. The actual encodings used to store and interchange ECMAScript source text is not relevant to this specification. Regardless of the external source text encoding, a conforming ECMAScript implementation processes the source text as if it was an equivalent sequence ofSourceCharacter values, eachSourceCharacter being a Unicode code point. Conforming ECMAScript implementations are not required to perform any normalization of source text, or behave as though they were performing normalization of source text.
The components of a combining character sequence are treated as individual Unicode code points even though a user might think of the whole sequence as a single character.
Note
In string literals, regular expression literals, template literals and identifiers, any Unicode code point may also be expressed using Unicode escape sequences that explicitly express a code point's numeric value. Within a comment, such an escape sequence is effectively ignored as part of the comment.
ECMAScript differs from the Java programming language in the behaviour of Unicode escape sequences. In a Java program, if the Unicode escape sequence\u000A, for example, occurs within a single-line comment, it is interpreted as a line terminator (Unicode code point U+000A is LINE FEED (LF)) and therefore the next code point is not part of the comment. Similarly, if the Unicode escape sequence\u000A occurs within a string literal in a Java program, it is likewise interpreted as a line terminator, which is not allowed within a string literal—one must write\n instead of\u000A to cause a LINE FEED (LF) to be part of the String value of a string literal. In an ECMAScript program, a Unicode escape sequence occurring within a comment is never interpreted and therefore cannot contribute to termination of the comment. Similarly, a Unicode escape sequence occurring within a string literal in an ECMAScript program always contributes to the literal and is never interpreted as a line terminator or as a code point that might terminate the string literal.
The abstract operation CodePointsToString takes argumenttext (a sequence of Unicode code points). It convertstext into a String value, as described in6.1.4. It performs the following steps when called:
The abstract operation UTF16SurrogatePairToCodePoint takes argumentslead (a code unit) andtrail (a code unit). Two code units that form a UTF-16surrogate pair are converted to a code point. It performs the following steps when called:
The abstract operation CodePointAt takes argumentsstring (a String) andposition (a non-negativeinteger). It interpretsstring as a sequence of UTF-16 encoded code points, as described in6.1.4, and reads from it a single code point starting with the code unit at indexposition. It performs the following steps when called:
The abstract operation StringToCodePoints takes argumentstring (a String). It returns the sequence of Unicode code points that results from interpretingstring as UTF-16 encoded Unicode text as described in6.1.4. It performs the following steps when called:
The abstract operation ParseText takes argumentssourceText (a sequence of Unicode code points) andgoalSymbol (a nonterminal in one of the ECMAScript grammars). It performs the following steps when called:
2.If the parse succeeded and no early errors were found, return theParse Node (an instance ofgoalSymbol) at the root of the parse tree resulting from the parse.
3.Otherwise, return aList of one or moreSyntaxError objects representing the parsing errors and/or early errors. If more than one parsing error orearly error is present, the number and ordering of error objects in the list isimplementation-defined, but at least one must be present.
Note 1
Consider a text that has anearly error at a particular point, and also a syntax error at a later point. An implementation that does a parse pass followed by an early errors pass might report the syntax error and not proceed to the early errors pass. An implementation that interleaves the two activities might report theearly error and not proceed to find the syntax error. A third implementation might report both errors. All of these behaviours are conformant.
Eval code is the source text supplied to the built-ineval function. More precisely, if the parameter to the built-ineval function is a String, it is treated as an ECMAScriptScript. The eval code for a particular invocation ofeval is the global code portion of thatScript.
then the source text matching theBindingIdentifier (if any) of that declaration or expression is also included in the function code of the corresponding function.
Function code is generally provided as the bodies of Function Definitions (15.2), Arrow Function Definitions (15.3), Method Definitions (15.4), Generator Function Definitions (15.5), Async Function Definitions (15.8), Async Generator Function Definitions (15.6), and Async Arrow Functions (15.9). Function code is also derived from the arguments to the Functionconstructor (20.2.1.1), the GeneratorFunctionconstructor (27.3.1.1), and the AsyncFunctionconstructor (27.7.1.1).
Note 2
The practical effect of including theBindingIdentifier in function code is that the Early Errors forstrict mode code are applied to aBindingIdentifier that is the name of a function whose body contains a "use strict" directive, even if the surrounding code is notstrict mode code.
11.2.1 Directive Prologues and the Use Strict Directive
An ECMAScript syntactic unit may be processed using either unrestricted or strict mode syntax and semantics (4.3.2). Code is interpreted asstrict mode code in the following situations:
Function code that is supplied as the arguments to the built-in Function, Generator, AsyncFunction, and AsyncGenerator constructors is strict mode code if the last argument is a String that when processed is aFunctionBody that begins with aDirective Prologue that contains aUse Strict Directive.
ECMAScript code that is not strict mode code is callednon-strict code.
11.2.3 Non-ECMAScript Functions
An ECMAScript implementation may support the evaluation of function exotic objects whose evaluative behaviour is expressed in somehost-defined form of executable code other than via ECMAScript code. Whether afunction object is an ECMAScript code function or a non-ECMAScript function is not semantically observable from the perspective of an ECMAScript code function that calls or is called by such a non-ECMAScript function.
12 ECMAScript Language: Lexical Grammar
The source text of an ECMAScriptScript orModule is first converted into a sequence of input elements, which are tokens, line terminators, comments, or white space. The source text is scanned from left to right, repeatedly taking the longest possible sequence of code points as the next input element.
The use of multiple lexical goals ensures that there are no lexical ambiguities that would affect automatic semicolon insertion. For example, there are no syntactic grammar contexts where both a leading division or division-assignment, and a leadingRegularExpressionLiteral are permitted. This is not affected by semicolon insertion (see12.9); in examples such as the following:
a = b/hi/g.exec(c).map(d);
where the first non-whitespace, non-comment code point after aLineTerminator is U+002F (SOLIDUS) and the syntactic context allows division or division-assignment, no semicolon is inserted at theLineTerminator. That is, the above example is interpreted in the same way as:
The Unicode format-control characters (i.e., the characters in category “Cf” in the Unicode Character Database such as LEFT-TO-RIGHT MARK or RIGHT-TO-LEFT MARK) are control codes used to control the formatting of a range of text in the absence of higher-level protocols for this (such as mark-up languages).
It is useful to allow format-control characters in source text to facilitate editing and display. All format control characters may be used within comments, and within string literals, template literals, and regular expression literals.
U+200C (ZERO WIDTH NON-JOINER) and U+200D (ZERO WIDTH JOINER) are format-control characters that are used to make necessary distinctions when forming words or phrases in certain languages. In ECMAScript source text these code points may also be used in anIdentifierName after the first character.
U+FEFF (ZERO WIDTH NO-BREAK SPACE) is a format-control character used primarily at the start of a text to mark it as Unicode and to allow detection of the text's encoding and byte order. <ZWNBSP> characters intended for this purpose can sometimes also appear after the start of a text, for example as a result of concatenating files. In ECMAScript source text <ZWNBSP> code points are treated as white space characters (see12.2).
The special treatment of certain format-control characters outside of comments, string literals, and regular expression literals is summarized inTable 33.
White space code points are used to improve source text readability and to separate tokens (indivisible lexical units) from each other, but are otherwise insignificant. White space code points may occur between any two tokens and at the start or end of input. White space code points may occur within aStringLiteral, aRegularExpressionLiteral, aTemplate, or aTemplateSubstitutionTail where they are considered significant code points forming part of a literal value. They may also occur within aComment, but cannot appear within any other kind of token.
The ECMAScript white space code points are listed inTable 34.
Table 34: White Space Code Points
Code Point
Name
Abbreviation
U+0009
CHARACTER TABULATION
<TAB>
U+000B
LINE TABULATION
<VT>
U+000C
FORM FEED (FF)
<FF>
U+0020
SPACE
<SP>
U+00A0
NO-BREAK SPACE
<NBSP>
U+FEFF
ZERO WIDTH NO-BREAK SPACE
<ZWNBSP>
Other category “Zs”
Any other Unicode “Space_Separator” code point
<USP>
ECMAScript implementations must recognize asWhiteSpace code points listed in the “Space_Separator” (“Zs”) category.
Note
Other than for the code points listed inTable 34, ECMAScriptWhiteSpace intentionally excludes all code points that have the Unicode “White_Space” property but which are not classified in category “Space_Separator” (“Zs”).
Like white space code points, line terminator code points are used to improve source text readability and to separate tokens (indivisible lexical units) from each other. However, unlike white space code points, line terminators have some influence over the behaviour of the syntactic grammar. In general, line terminators may occur between any two tokens, but there are a few places where they are forbidden by the syntactic grammar. Line terminators also affect the process of automatic semicolon insertion (12.9). A line terminator cannot occur within any token except aStringLiteral,Template, orTemplateSubstitutionTail. <LF> and <CR> line terminators cannot occur within aStringLiteral token except as part of aLineContinuation.
Line terminators are included in the set of white space code points that are matched by the\s class in regular expressions.
The ECMAScript line terminator code points are listed inTable 35.
Table 35: Line Terminator Code Points
Code Point
Unicode Name
Abbreviation
U+000A
LINE FEED (LF)
<LF>
U+000D
CARRIAGE RETURN (CR)
<CR>
U+2028
LINE SEPARATOR
<LS>
U+2029
PARAGRAPH SEPARATOR
<PS>
Only the Unicode code points inTable 35 are treated as line terminators. Other new line or line breaking Unicode code points are not treated as line terminators but are treated as white space if they meet the requirements listed inTable 34. The sequence <CR><LF> is commonly used as a line terminator. It should be considered a singleSourceCharacter for the purpose of reporting line numbers.
Comments can be either single or multi-line. Multi-line comments cannot nest.
Because a single-line comment can contain any Unicode code point except aLineTerminator code point, and because of the general rule that a token is always as long as possible, a single-line comment always consists of all code points from the// marker to the end of the line. However, theLineTerminator at the end of the line is not considered to be part of the single-line comment; it is recognized separately by the lexical grammar and becomes part of the stream of input elements for the syntactic grammar. This point is very important, because it implies that the presence or absence of single-line comments does not affect the process of automatic semicolon insertion (see12.9).
Comments behave like white space and are discarded except that, if aMultiLineComment contains a line terminator code point, then the entire comment is considered to be aLineTerminator for purposes of parsing by the syntactic grammar.
IdentifierName andReservedWord are tokens that are interpreted according to the Default Identifier Syntax given in Unicode Standard Annex #31, Identifier and Pattern Syntax, with some small modifications.ReservedWord is an enumerated subset ofIdentifierName. The syntactic grammar definesIdentifier as anIdentifierName that is not aReservedWord. The Unicode identifier grammar is based on character properties specified by the Unicode Standard. The Unicode code points in the specified categories in the latest version of the Unicode standard must be treated as in those categories by all conforming ECMAScript implementations. ECMAScript implementations may recognize identifier code points defined in later editions of the Unicode Standard.
Note 1
This standard specifies specific code point additions: U+0024 (DOLLAR SIGN) and U+005F (LOW LINE) are permitted anywhere in anIdentifierName, and the code points U+200C (ZERO WIDTH NON-JOINER) and U+200D (ZERO WIDTH JOINER) are permitted anywhere after the first code point of anIdentifierName.
Unicode escape sequences are permitted in anIdentifierName, where they contribute a single Unicode code point to theIdentifierName. The code point is expressed by theCodePoint of theUnicodeEscapeSequence (see12.8.4). The\ preceding theUnicodeEscapeSequence and theu and{ } code units, if they appear, do not contribute code points to theIdentifierName. AUnicodeEscapeSequence cannot be used to put a code point into anIdentifierName that would otherwise be illegal. In other words, if a\UnicodeEscapeSequence sequence were replaced by theSourceCharacter it contributes, the result must still be a validIdentifierName that has the exact same sequence ofSourceCharacter elements as the originalIdentifierName. All interpretations ofIdentifierName within this specification are based upon their actual code points regardless of whether or not an escape sequence was used to contribute any particular code point.
TwoIdentifierNames that are canonically equivalent according to the Unicode standard arenot equal unless, after replacement of eachUnicodeEscapeSequence, they are represented by the exact same sequence of code points.
The sets of code points with Unicode properties “ID_Start” and “ID_Continue” include, respectively, the code points with Unicode properties “Other_ID_Start” and “Other_ID_Continue”.
Akeyword is a token that matchesIdentifierName, but also has a syntactic use; that is, it appears literally, in afixed width font, in some syntactic production. The keywords of ECMAScript includeif,while,async,await, and many others.
Areserved word is anIdentifierName that cannot be used as an identifier. Many keywords are reserved words, but some are not, and some are reserved only in certain contexts.if andwhile are reserved words.await is reserved only inside async functions and modules.async is not reserved; it can be used as a variable name or statement label without restriction.
This specification uses a combination of grammatical productions andearly error rules to specify which names are valid identifiers and which are reserved words. All tokens in theReservedWord list below, except forawait andyield, are unconditionally reserved. Exceptions forawait andyield are specified in13.1, using parameterized syntactic productions. Lastly, severalearly error rules restrict the set of valid identifiers. See13.1.1,14.3.1.1,14.7.5.1, and15.7.1. In summary, there are five categories of identifier names:
Those that are always allowed as identifiers, and are not keywords, such asMath,window,toString, and_;
Those that are never allowed as identifiers, namely theReservedWords listed below exceptawait andyield;
Those that are contextually allowed as identifiers, namelyawait andyield;
Those that are contextually disallowed as identifiers, instrict mode code:let,static,implements,interface,package,private,protected, andpublic;
Those that are always allowed as identifiers, but also appear as keywords within certain syntactic productions, at places whereIdentifier is not allowed:as,async,from,get,of,set, andtarget.
The termconditional keyword, orcontextual keyword, is sometimes used to refer to the keywords that fall in the last three categories, and thus can be used as identifiers in some contexts and as keywords in others.
Per5.1.5, keywords in the grammar match literal sequences of specificSourceCharacter elements. A code point in a keyword cannot be expressed by a\UnicodeEscapeSequence.
enum is not currently used as a keyword in this specification. It is afuture reserved word, set aside for use as a keyword in future language extensions.
Similarly,implements,interface,package,private,protected, andpublic are future reserved words instrict mode code.
Once the exact MV for a numeric literal has been determined, it is then rounded to a value of the Number type. If the MV is 0, then the rounded value is+0𝔽; otherwise, the rounded value must be theNumber value for the MV (as specified in6.1.6.1), unless the literal is aDecimalLiteral and the literal has more than 20 significant digits, in which case theNumber value may be either theNumber value for the MV of a literal produced by replacing each significant digit after the 20th with a0 digit or theNumber value for the MV of a literal produced by replacing each significant digit after the 20th with a0 digit and then incrementing the literal at the 20th significant digit position. A digit issignificant if it is not part of anExponentPart and
it is not0; or
there is a non-zero digit to its left and there is a non-zero digit, not in theExponentPart, to its right.
A string literal is 0 or more Unicode code points enclosed in single or double quotes. Unicode code points may also be represented by an escape sequence. All code points may appear literally in a string literal except for the closing quote code points, U+005C (REVERSE SOLIDUS), U+000D (CARRIAGE RETURN), and U+000A (LINE FEED). Any code points may appear in the form of an escape sequence. String literals evaluate to ECMAScript String values. When generating these String values Unicode code points are UTF-16 encoded as defined in11.1.1. Code points belonging to the Basic Multilingual Plane are encoded as a single code unit element of the string. All other code points are encoded as two code unit elements of the string.
<LF> and <CR> cannot appear in a string literal, except as part of aLineContinuation to produce the empty code points sequence. The proper way to include either in the String value of a string literal is to use an escape sequence such as\n or\u000A.
12.8.4.1 Static Semantics: SV
A string literal stands for a value of the String type. The String value (SV) of the literal is described in terms of String values contributed by the various parts of the string literal. As part of this process, some Unicode code points within the string literal are interpreted as having amathematical value (MV), as described below or in12.8.3.
A regular expression literal is an input element that is converted to a RegExp object (see22.2) each time the literal is evaluated. Two regular expression literals in a program evaluate to regular expression objects that never compare as=== to each other even if the two literals' contents are identical. A RegExp object may also be created at runtime bynew RegExp or calling the RegExpconstructor as a function (see22.2.3).
The productions below describe the syntax for a regular expression literal and are used by the input element scanner to find the end of the regular expression literal. The source text comprising theRegularExpressionBody and theRegularExpressionFlags are subsequently parsed again using the more stringent ECMAScript Regular Expression grammar (22.2.1).
An implementation may extend the ECMAScript Regular Expression grammar defined in22.2.1, but it must not extend theRegularExpressionBody andRegularExpressionFlags productions defined below or the productions used by these productions.
Regular expression literals may not be empty; instead of representing an empty regular expression literal, the code unit sequence// starts a single-line comment. To specify an empty regular expression, use:/(?:)/.
A template literal component is interpreted as a sequence of Unicode code points. The Template Value (TV) of a literal component is described in terms of String values (SV,12.8.4) contributed by the various parts of the template literal component. As part of this process, some Unicode code points within the template component are interpreted as having amathematical value (MV,12.8.3). In determining a TV, escape sequences are replaced by the UTF-16 code unit(s) of the Unicode code point represented by the escape sequence. The Template Raw Value (TRV) is similar to a Template Value with the difference that in TRVs escape sequences are interpreted literally.
The TRV ofLineTerminatorSequence::<LF> is the String value consisting of the code unit 0x000A (LINE FEED).
The TRV ofLineTerminatorSequence::<CR> is the String value consisting of the code unit 0x000A (LINE FEED).
The TRV ofLineTerminatorSequence::<LS> is the String value consisting of the code unit 0x2028 (LINE SEPARATOR).
The TRV ofLineTerminatorSequence::<PS> is the String value consisting of the code unit 0x2029 (PARAGRAPH SEPARATOR).
The TRV ofLineTerminatorSequence::<CR><LF> is the String value consisting of the code unit 0x000A (LINE FEED).
Note
TV excludes the code units ofLineContinuation while TRV includes them. <CR><LF> and <CR>LineTerminatorSequences are normalized to <LF> for both TV and TRV. An explicitEscapeSequence is needed to include a <CR> or <CR><LF> sequence.
12.9 Automatic Semicolon Insertion
Most ECMAScript statements and declarations must be terminated with a semicolon. Such semicolons may always appear explicitly in the source text. For convenience, however, such semicolons may be omitted from the source text in certain situations. These situations are described by saying that semicolons are automatically inserted into the source code token stream in those situations.
12.9.1 Rules of Automatic Semicolon Insertion
In the following rules, “token” means the actual recognized lexical token determined using the current lexicalgoal symbol as described in clause12.
There are three basic rules of semicolon insertion:
When, as the source text is parsed from left to right, a token (called theoffending token) is encountered that is not allowed by any production of the grammar, then a semicolon is automatically inserted before the offending token if one or more of the following conditions is true:
The offending token is separated from the previous token by at least oneLineTerminator.
The offending token is}.
The previous token is) and the inserted semicolon would then be parsed as the terminating semicolon of a do-while statement (14.7.2).
When, as the source text is parsed from left to right, the end of the input stream of tokens is encountered and the parser is unable to parse the input token stream as a single instance of the goal nonterminal, then a semicolon is automatically inserted at the end of the input stream.
When, as the source text is parsed from left to right, a token is encountered that is allowed by some production of the grammar, but the production is arestricted production and the token would be the first token for a terminal or nonterminal immediately following the annotation “[noLineTerminator here]” within the restricted production (and therefore such a token is called a restricted token), and the restricted token is separated from the previous token by at least oneLineTerminator, then a semicolon is automatically inserted before the restricted token.
However, there is an additional overriding condition on the preceding rules: a semicolon is never inserted automatically if the semicolon would then be parsed as an empty statement or if that semicolon would become one of the two semicolons in the header of afor statement (see14.7.4).
Note
The following are the only restricted productions in the grammar:
The practical effect of these restricted productions is as follows:
When a++ or-- token is encountered where the parser would treat it as a postfix operator, and at least oneLineTerminator occurred between the preceding token and the++ or-- token, then a semicolon is automatically inserted before the++ or-- token.
When acontinue,break,return,throw, oryield token is encountered and aLineTerminator is encountered before the next token, a semicolon is automatically inserted after thecontinue,break,return,throw, oryield token.
The resulting practical advice to ECMAScript programmers is:
A postfix++ or-- operator should appear on the same line as its operand.
AnExpression in areturn orthrow statement or anAssignmentExpression in ayield expression should start on the same line as thereturn,throw, oryield token.
ALabelIdentifier in abreak orcontinue statement should be on the same line as thebreak orcontinue token.
12.9.2 Examples of Automatic Semicolon Insertion
This section is non-normative.
The source
{12 }3
is not a valid sentence in the ECMAScript grammar, even with the automatic semicolon insertion rules. In contrast, the source
{12 }3
is also not a valid ECMAScript sentence, but is transformed by automatic semicolon insertion into the following:
{1;2 ;}3;
which is a valid ECMAScript sentence.
The source
for (a; b)
is not a valid ECMAScript sentence and is not altered by automatic semicolon insertion because the semicolon is needed for the header of afor statement. Automatic semicolon insertion never inserts one of the two semicolons in the header of afor statement.
The source
returna + b
is transformed by automatic semicolon insertion into the following:
return;a + b;
Note 1
The expressiona + b is not treated as a value to be returned by thereturn statement, because aLineTerminator separates it from the tokenreturn.
The source
a = b++c
is transformed by automatic semicolon insertion into the following:
a = b;++c;
Note 2
The token++ is not treated as a postfix operator applying to the variableb, because aLineTerminator occurs betweenb and++.
The source
if (a > b)else c = d
is not a valid ECMAScript sentence and is not altered by automatic semicolon insertion before theelse token, even though no production of the grammar applies at that point, because an automatically inserted semicolon would then be parsed as an empty statement.
The source
a = b + c(d + e).print()
isnot transformed by automatic semicolon insertion, because the parenthesized expression that begins the second line can be interpreted as an argument list for a function call:
a = b + c(d + e).print()
In the circumstance that an assignment statement must begin with a left parenthesis, it is a good idea for the programmer to provide an explicit semicolon at the end of the preceding statement rather than to rely on automatic semicolon insertion.
12.9.3 Interesting Cases of Automatic Semicolon Insertion
This section is non-normative.
ECMAScript programs can be written in a style with very few semicolons by relying on automatic semicolon insertion. As described above, semicolons are not inserted at every newline, and automatic semicolon insertion can depend on multiple tokens across line terminators.
As new syntactic features are added to ECMAScript, additional grammar productions could be added that cause lines relying on automatic semicolon insertion preceding them to change grammar productions when parsed.
For the purposes of this section, a case of automatic semicolon insertion is considered interesting if it is a place where a semicolon may or may not be inserted, depending on the source text which precedes it. The rest of this section describes a number of interesting cases of automatic semicolon insertion in this version of ECMAScript.
12.9.3.1 Interesting Cases of Automatic Semicolon Insertion in Statement Lists
In aStatementList, manyStatementListItems end in semicolons, which may be omitted using automatic semicolon insertion. As a consequence of the rules above, at the end of a line ending an expression, a semicolon is required if the following line begins with any of the following:
An opening parenthesis ((). Without a semicolon, the two lines together are treated as aCallExpression.
An opening square bracket ([). Without a semicolon, the two lines together are treated as property access, rather than anArrayLiteral orArrayAssignmentPattern.
A template literal (`). Without a semicolon, the two lines together are interpreted as a tagged Template (13.3.11), with the previous expression as theMemberExpression.
Unary+ or-. Without a semicolon, the two lines together are interpreted as a usage of the corresponding binary operator.
A RegExp literal. Without a semicolon, the two lines together may be parsed instead as the/MultiplicativeOperator, for example if the RegExp has flags.
12.9.3.2 Cases of Automatic Semicolon Insertion and “[noLineTerminator here]”
This section is non-normative.
ECMAScript contains grammar productions which include “[noLineTerminator here]”. These productions are sometimes a means to have optional operands in the grammar. Introducing aLineTerminator in these locations would change the grammar production of a source text by using the grammar production without the optional operand.
The rest of this section describes a number of productions using “[noLineTerminator here]” in this version of ECMAScript.
12.9.3.2.1 List of Grammar Productions with Optional Operands and “[noLineTerminator here]”
yield andawait are permitted asBindingIdentifier in the grammar, and prohibited withstatic semantics below, to prohibit automatic semicolon insertion in cases such as
It is a Syntax Error if this phrase is contained instrict mode code and theStringValue ofIdentifierName is:"implements","interface","let","package","private","protected","public","static", or"yield".
AnArrayLiteral is an expression describing the initialization of an Array object, using a list, of zero or more expressions each of which represents an array element, enclosed in square brackets. The elements need not be literals; they are evaluated each time the array initializer is evaluated.
Array elements may be elided at the beginning, middle or end of the element list. Whenever a comma in the element list is not preceded by anAssignmentExpression (i.e., a comma at the beginning or after another comma), the missing array element contributes to the length of the Array and increases the index of subsequent elements. Elided array elements are not defined. If an element is elided at the end of an array, that element does not contribute to the length of the Array.
CreateDataPropertyOrThrow is used to ensure that own properties are defined for the array even if the standard built-inArray prototype object has been modified in a manner that would preclude the creation of new own properties using [[Set]].
An object initializer is an expression describing the initialization of an Object, written in a form resembling a literal. It is a list of zero or more pairs of property keys and associated values, enclosed in curly brackets. The values need not be literals; they are evaluated each time the object initializer is evaluated.
In certain contexts,ObjectLiteral is used as a cover grammar for a more restricted secondary grammar. TheCoverInitializedName production is necessary to fully cover these secondary grammars. However, use of this production results in an early Syntax Error in normal contexts where an actualObjectLiteral is expected.
The abstract operation IsValidRegularExpressionLiteral takes argumentliteral. It determines if its argument is a valid regular expression literal. It performs the following steps when called:
b.SetpatternText to the sequence of code points resulting from interpreting each of the 16-bit elements ofstringValue as a Unicode BMP code point. UTF-16 decoding is not applied to the elements.
The creation of a template object cannot result in anabrupt completion.
Note 2
EachTemplateLiteral in the program code of arealm is associated with a unique template object that is used in the evaluation of tagged Templates (13.2.9.5). The template objects are frozen and the same template object is used each time a specific tagged Template is evaluated. Whether template objects are created lazily upon first evaluation of theTemplateLiteral or eagerly prior to first evaluation is an implementation choice that is not observable to ECMAScript code.
Note 3
Future editions of this specification may define additional non-enumerable properties of template objects.
This algorithm does not applyGetValue to the result of evaluatingExpression. The principal motivation for this is so that operators such asdelete andtypeof may be applied to parenthesized expressions.
The abstract operation EvaluatePropertyAccessWithExpressionKey takes argumentsbaseValue (anECMAScript language value),expression (aParse Node), andstrict (a Boolean). It performs the following steps when called:
1.LetpropertyNameReference be the result of evaluatingexpression.
2.LetpropertyNameValue be ? GetValue(propertyNameReference).
The abstract operation EvaluatePropertyAccessWithIdentifierKey takes argumentsbaseValue (anECMAScript language value),identifierName (aParse Node), andstrict (a Boolean). It performs the following steps when called:
8.Assert: IftailPosition istrue, the above call will not return here, but instead evaluation will continue as if the following return has already occurred.
A tagged template is a function call where the arguments of the call are derived from aTemplateLiteral (13.2.9). The actual arguments include a template object (13.2.9.3) and the values produced by evaluating the expressions embedded within theTemplateLiteral.
Thehost-defined abstract operation HostGetImportMetaProperties takes argumentmoduleRecord (aModule Record). It allows hosts to provide property keys and values for the object returned fromimport.meta.
The implementation of HostGetImportMetaProperties must conform to the following requirements:
It must return aList, whose values are all Records with two fields, [[Key]] and [[Value]].
Each suchRecord's [[Key]] field must be a property key, i.e.,IsPropertyKey must returntrue when applied to it.
Each suchRecord's [[Value]] field must be an ECMAScript value.
It must always complete normally (i.e., not return anabrupt completion).
The default implementation of HostGetImportMetaProperties is to return a new emptyList.
Thehost-defined abstract operation HostFinalizeImportMeta takes argumentsimportMeta (an Object) andmoduleRecord (aModule Record). It allows hosts to perform any extraordinary operations to prepare the object returned fromimport.meta.
Most hosts will be able to simply defineHostGetImportMetaProperties, and leave HostFinalizeImportMeta with its default behaviour. However, HostFinalizeImportMeta provides an "escape hatch" for hosts which need to directly manipulate the object before it is exposed to ECMAScript code.
The implementation of HostFinalizeImportMeta must conform to the following requirements:
It must always complete normally (i.e., not return anabrupt completion).
The default implementation of HostFinalizeImportMeta is to returnNormalCompletion(empty).
When adelete operator occurs withinstrict mode code, aSyntaxError exception is thrown if itsUnaryExpression is a direct reference to a variable, function argument, or function name. In addition, if adelete operator occurs withinstrict mode code and the property to be deleted has the attribute { [[Configurable]]:false } (or otherwise cannot be deleted), aTypeError exception is thrown.
Note 2
The object that may be created in step5.b is not accessible outside of the above abstract operation and theordinary object [[Delete]] internal method. An implementation might choose to avoid the actual creation of that object.
The result of evaluating a relational operator is always of type Boolean, reflecting whether the relationship named by the operator holds between its two operands.
The abstract operation InstanceofOperator takes argumentsV (anECMAScript language value) andtarget (anECMAScript language value). It implements the generic algorithm for determining ifV is an instance oftarget either by consultingtarget's@@hasInstance method or, if absent, determining whether the value oftarget's"prototype" property is present inV's prototype chain. It performs the following steps when called:
1.IfType(target) is not Object, throw aTypeError exception.
Steps4 and5 provide compatibility with previous editions of ECMAScript that did not use a@@hasInstance method to define theinstanceof operator semantics. If an object does not define or inherit@@hasInstance it uses the defaultinstanceof semantics.
13.11 Equality Operators
Note
The result of evaluating an equality operator is always of type Boolean, reflecting whether the relationship named by the operator holds between its two operands.
String comparison can be forced by:`${a}` == `${b}`.
Numeric comparison can be forced by:+a == +b.
Boolean comparison can be forced by:!a == !b.
Note 2
The equality operators maintain the following invariants:
A != B is equivalent to!(A == B).
A == B is equivalent toB == A, except in the order of evaluation ofA andB.
Note 3
The equality operator is not always transitive. For example, there might be two distinct String objects, each representing the same String value; each String object would be considered equal to the String value by the== operator, but the two String objects would not be equal to each other. For example:
new String("a") == "a" and"a" == new String("a") are bothtrue.
new String("a") == new String("a") isfalse.
Note 4
Comparison of Strings uses a simple equality test on sequences of code unit values. There is no attempt to use the more complex, semantically oriented definitions of character or string equality and collating order defined in the Unicode specification. Therefore Strings values that are canonically equal according to the Unicode standard could test as unequal. In effect this algorithm assumes that both Strings are already in normalized form.
The value produced by a&& or|| operator is not necessarily of type Boolean. The value produced will always be the value of one of the two operand expressions.
The grammar for aConditionalExpression in ECMAScript is slightly different from that in C and Java, which each allow the second subexpression to be anExpression but restrict the third expression to be aConditionalExpression. The motivation for this difference in ECMAScript is to allow an assignment expression to be governed by either arm of a conditional and to eliminate the confusing and fairly useless case of a comma expression as the centre expression.
When this expression occurs withinstrict mode code, it is a runtime error iflref in step1.e,2,2,2,2 is an unresolvable reference. If it is, aReferenceError exception is thrown. Additionally, it is a runtime error if thelref in step8,7,7,6 is a reference to adata property with the attribute value { [[Writable]]:false }, to anaccessor property with the attribute value { [[Set]]:undefined }, or to a non-existent property of an object for which theIsExtensible predicate returns the valuefalse. In these cases aTypeError exception is thrown.
The abstract operation ApplyStringOrNumericBinaryOperator takes argumentslval (anECMAScript language value),opText (a sequence of Unicode code points), andrval (anECMAScript language value). It performs the following steps when called:
8.Letoperation be the abstract operation associated withopText in the following table:
opText
operation
**
T::exponentiate
*
T::multiply
/
T::divide
%
T::remainder
+
T::add
-
T::subtract
<<
T::leftShift
>>
T::signedRightShift
>>>
T::unsignedRightShift
&
T::bitwiseAND
^
T::bitwiseXOR
|
T::bitwiseOR
9.Return ?operation(lnum,rnum).
Note 1
No hint is provided in the calls toToPrimitive in steps2.a and2.b. All standard objects except Date objects handle the absence of a hint as ifnumber were given; Date objects handle the absence of a hint as ifstring were given. Exotic objects may handle the absence of a hint in some other manner.
Note 2
Step2.c differs from step3 of theAbstract Relational Comparison algorithm, by using the logical-or operation instead of the logical-and operation.
The abstract operation EvaluateStringOrNumericBinaryExpression takes argumentsleftOperand (aParse Node),opText (a sequence of Unicode code points), andrightOperand (aParse Node). It performs the following steps when called:
Left to right evaluation order is maintained by evaluating aDestructuringAssignmentTarget that is not a destructuring pattern prior to accessing the iterator or evaluating theInitializer.
The value of aStatementList is the value of the last value-producing item in theStatementList. For example, the following calls to theeval function all return the value 1:
The abstract operation BlockDeclarationInstantiation takes argumentscode (aParse Node) andenv (anEnvironment Record).code is theParse Node corresponding to the body of the block.env is theEnvironment Record in which bindings are to be created. It performs the following steps when called:
With parametersvalue,environment, andpropertyName.
Note
Whenundefined is passed forenvironment it indicates that aPutValue operation should be used to assign the initialization value. This is the case for formal parameter lists of non-strict functions. In that case the formal parameter bindings are preinitialized in order to deal with the possibility of multiple parameters with the same name.
The lookahead-restriction [lookahead ≠else] resolves the classic "dangling else" problem in the usual way. That is, when the choice of associatedif is otherwise ambiguous, theelse is associated with the nearest (innermost) of the candidateifs
The abstract operation ForBodyEvaluation takes argumentstest,increment,stmt,perIterationBindings, andlabelSet. It performs the following steps when called:
undefined is passed forenvironment to indicate that aPutValue operation should be used to assign the initialization value. This is the case forvar statements and the formal parameter lists of some non-strict functions (see10.2.10). In those cases a lexical binding is hoisted and preinitialized prior to evaluation of its initializer.
The abstract operation ForIn/OfHeadEvaluation takes argumentsuninitializedBoundNames,expr, anditerationKind (eitherenumerate,iterate, orasync-iterate). It performs the following steps when called:
The abstract operation ForIn/OfBodyEvaluation takes argumentslhs,stmt,iteratorRecord,iterationKind,lhsKind (eitherassignment,varBinding orlexicalBinding), andlabelSet and optional argumentiteratorKind (eithersync orasync). It performs the following steps when called:
1.IfiteratorKind is not present, setiteratorKind tosync.
2.Return an Iterator object (27.1.1.2) whosenext method iterates over all the String-valued keys of enumerable properties ofO. The iterator object is never directly accessible to ECMAScript code. The mechanics and order of enumerating the properties is not specified but must conform to the rules specified below.
The iterator'sthrow andreturn methods arenull and are never invoked. The iterator'snext method processes object properties to determine whether the property key should be returned as an iterator value. Returned property keys do not include keys that are Symbols. Properties of the target object may be deleted during enumeration. A property that is deleted before it is processed by the iterator'snext method is ignored. If new properties are added to the target object during enumeration, the newly added properties are not guaranteed to be processed in the active enumeration. Aproperty name will be returned by the iterator'snext method at most once in any enumeration.
Enumerating the properties of the target object includes enumerating properties of its prototype, and the prototype of the prototype, and so on, recursively; but a property of a prototype is not processed if it has the same name as a property that has already been processed by the iterator'snext method. The values of [[Enumerable]] attributes are not considered when determining if a property of a prototype object has already been processed. The enumerable property names of prototype objects must be obtained by invoking EnumerateObjectProperties passing the prototype object as the argument. EnumerateObjectProperties must obtain the own property keys of the target object by calling its [[OwnPropertyKeys]] internal method. Property attributes of the target object must be obtained by calling its [[GetOwnProperty]] internal method.
the value of the [[Prototype]] internal slot ofO or an object in its prototype chain changes,
a property is removed fromO or an object in its prototype chain,
a property is added to an object inO's prototype chain, or
the value of the [[Enumerable]] attribute of a property ofO or an object in its prototype chain changes.
Note 1
ECMAScript implementations are not required to implement the algorithm in14.7.5.10.2.1 directly. They may choose any implementation whose behaviour will not deviate from that algorithm unless one of the constraints in the previous paragraph is violated.
The following is an informative definition of an ECMAScript generator function that conforms to these rules:
The list of exotic objects for which implementations are not required to matchCreateForInIterator was chosen because implementations historically differed in behaviour for those cases, and agreed in all others.
14.7.5.10 For-In Iterator Objects
A For-In Iterator is an object that represents a specific iteration over some specific object. For-In Iterator objects are never directly accessible to ECMAScript code; they exist solely to illustrate the behaviour ofEnumerateObjectProperties.
14.7.5.10.1 CreateForInIterator (object )
The abstract operation CreateForInIterator takes argumentobject. It is used to create a For-In Iterator object which iterates over the own and inherited enumerable string properties ofobject in a specific order. It performs the following steps when called:
14.7.5.10.3 Properties of For-In Iterator Instances
For-In Iterator instances are ordinary objects that inherit properties from the%ForInIteratorPrototype% intrinsic object. For-In Iterator instances are initially created with the internal slots listed inTable 38.
Table 38: Internal Slots of For-In Iterator Instances
Internal Slot
Description
[[Object]]
The Object value whose properties are being iterated.
[[ObjectWasVisited]]
true if the iterator has invoked [[OwnPropertyKeys]] on [[Object]],false otherwise.
[[VisitedKeys]]
A list of String values which have been emitted by this iterator thus far.
[[RemainingKeys]]
A list of String values remaining to be emitted for the current object, before iterating the properties of its prototype (if its prototype is notnull).
It is a Syntax Error if thisContinueStatement is not nested, directly or indirectly (but not crossing function boundaries), within anIterationStatement.
Areturn statement causes a function to cease execution and, in most cases, returns a value to the caller. IfExpression is omitted, the return value isundefined. Otherwise, the return value is the value ofExpression. Areturn statement may not actually return a value to the caller depending on surrounding context. For example, in atry block, areturn statement's completion record may be replaced with another completion record during evaluation of thefinally block.
Thewith statement adds anobject Environment Record for a computed object to the lexical environment of therunning execution context. It then executes a statement using this augmented lexical environment. Finally, it restores the original lexical environment.
No matter how control leaves the embeddedStatement, whether normally or by some form ofabrupt completion or exception, the LexicalEnvironment is always restored to its former state.
The abstract operation CaseClauseIsSelected takes argumentsC (aParse Node forCaseClause) andinput (anECMAScript language value). It determines whetherC matchesinput. It performs the following steps when called:
This operation does not executeC'sStatementList (if any). TheCaseBlock algorithm uses its return value to determine whichStatementList to start executing.
AStatement may be prefixed by a label. Labelled statements are only used in conjunction with labelledbreak andcontinue statements. ECMAScript has nogoto statement. AStatement can be part of aLabelledStatement, which itself can be part of aLabelledStatement, and so on. The labels introduced this way are collectively referred to as the “current label set” when describing the semantics of individual statements.
Thetry statement encloses a block of code in which an exceptional condition can occur, such as a runtime error or athrow statement. Thecatch clause provides the exception-handling code. When a catch clause catches an exception, itsCatchParameter is bound to that exception.
Evaluating aDebuggerStatement may allow an implementation to cause a breakpoint when run under a debugger. If a debugger is not present or active this statement has no observable effect.
Various ECMAScript language elements cause the creation of ECMAScript function objects (10.2). Evaluation of such functions starts with the execution of their [[Call]] internal method (10.2.1).
The ExpectedArgumentCount of aFormalParameterList is the number ofFormalParameters to the left of either the rest parameter or the firstFormalParameter with an Initializer. AFormalParameter without an initializer is allowed after the first parameter with an initializer but such parameters are considered to be optional withundefined as their default value.
A"prototype" property is automatically created for every function defined using aFunctionDeclaration orFunctionExpression, to allow for the possibility that the function will be used as aconstructor.
AnArrowFunction does not define local bindings forarguments,super,this, ornew.target. Any reference toarguments,super,this, ornew.target within anArrowFunction must resolve to a binding in a lexically enclosing environment. Typically this will be the Function Environment of an immediately enclosing function. Even though anArrowFunction may contain references tosuper, thefunction object created in step5 is not made into a method by performingMakeMethod. AnArrowFunction that referencessuper is always contained within a non-ArrowFunction and the necessary state to implementsuper is accessible via thescope that is captured by thefunction object of theArrowFunction.
YieldExpression cannot be used within theFormalParameters of a generator function because any expressions that are part ofFormalParameters are evaluated before the resulting generator object is in a resumable state.
1.LetinnerResult be ? Call(throw,iterator, «received.[[Value]] »).
2.IfgeneratorKind isasync, setinnerResult to ? Await(innerResult).
3.NOTE: Exceptions from the inner iteratorthrow method are propagated. Normal completions from an innerthrow method are processed similarly to an innernext.
4.IfType(innerResult) is not Object, throw aTypeError exception.
1.NOTE: Ifiterator does not have athrow method, this throw is going to terminate theyield* loop. But first we need to giveiterator a chance to clean up.
a.NOTE: This branch behaves similarly toconstructor(...args) { super(...args); }. The most notable distinction is that while the aforementioned ECMAScript source text observably calls the@@iterator method on%Array.prototype%, a DefaultConstructor Function does not.
WhenModule is the syntacticgoal symbol and the[Await] parameter is absent,await is parsed as akeyword and will be a Syntax error. WhenScript is the syntacticgoal symbol,await may be parsed as an identifier when the[Await] parameter is absent. This includes the following contexts:
Tail Position calls are only defined instrict mode code because of a common non-standard language extension (see10.2.4) that enables observation of the chain of caller contexts.
15.10.2 Static Semantics: HasCallInTailPosition
With parametercall.
Note
call is aParse Node that represents a specific range of source text. When the following algorithms comparecall to anotherParse Node, it is a test of whether they represent the same source text.
A potential tail position call that is immediately followed by returnGetValue of the call result is also a possible tail position call. A function call cannot return aReference Record, so such aGetValue operation will always return the same value as the actual function call result.
A tail position call must either release any transient internal resources associated with the currently executing functionexecution context before invoking the target function or reuse those resources in support of the target function.
Note
For example, a tail position call should only grow an implementation's activation record stack by the amount that the size of the target function's activation record exceeds the size of the calling function's activation record. If the target function's activation record is smaller, then the total size of the stack should decrease.
The abstract operation ParseScript takes argumentssourceText,realm, andhostDefined. It creates aScript Record based upon the result of parsingsourceText as aScript. It performs the following steps when called:
1.Assert:sourceText is an ECMAScript source text (see clause11).
4.ReturnScript Record { [[Realm]]:realm, [[Environment]]:undefined, [[ECMAScriptCode]]:body, [[HostDefined]]:hostDefined }.
Note
An implementation may parse script source text and analyse it for Early Error conditions prior to evaluation of ParseScript for that script source text. However, the reporting of any errors must be deferred until the point where this specification actually performs ParseScript upon that source text.
16.1.6 ScriptEvaluation (scriptRecord )
The abstract operation ScriptEvaluation takes argumentscriptRecord. It performs the following steps when called:
When anexecution context is established for evaluating scripts, declarations are instantiated in the currentglobal environment. Each global binding declared in the code is instantiated.
12.NOTE: No abnormal terminations occur after this algorithm step if theglobal object is anordinary object. However, if theglobal object is aProxy exotic object it may exhibit behaviours that cause abnormal terminations in some of the following steps.
13.NOTE: AnnexB.3.3.2 adds additional steps at this point.
Early errors specified in16.1.1 prevent name conflicts between function/var declarations and let/const/class declarations as well as redeclaration of let/const/class bindings for declaration contained within a singleScript. However, such conflicts and redeclarations that span more than oneScript are detected as runtime errors during GlobalDeclarationInstantiation. If any such errors are detected, no bindings are instantiated for the script. However, if theglobal object is defined using Proxy exotic objects then the runtime tests for conflicting declarations may be unreliable resulting in anabrupt completion and some global declarations not being instantiated. If this occurs, the code for theScript is not evaluated.
Unlike explicit var or function declarations, properties that are directly created on theglobal object result in global bindings that may be shadowed by let/const/class declarations.
The duplicateExportedNames rule implies that multipleexport defaultExportDeclaration items within aModuleBody is a Syntax Error. Additional error conditions relating to conflicting or duplicate declarations are checked during module linking prior to evaluation of aModule. If any such errors are detected theModule is not evaluated.
The abstract operation ImportedLocalNames takes argumentimportEntries (aList of ImportEntry Records (seeTable 45)). It creates aList of all of the local name bindings defined byimportEntries. It performs the following steps when called:
AModule Record encapsulates structural information about the imports and exports of a single module. This information is used to link the imports and exports of sets of connected modules. A Module Record includes four fields that are only used when evaluating a module.
For specification purposes Module Record values are values of theRecord specification type and can be thought of as existing in a simple object-oriented hierarchy where Module Record is an abstract class with both abstract and concrete subclasses. This specification defines the abstract subclass namedCyclic Module Record and its concrete subclass namedSource Text Module Record. Other specifications and implementations may define additional Module Record subclasses corresponding to alternative module definition facilities that they defined.
Module Record defines the fields listed inTable 40. All Module Definition subclasses include at least those fields. Module Record also defines the abstract method list inTable 41. All Module definition subclasses must provide concrete implementations of these abstract methods.
TheEnvironment Record containing the top level bindings for this module. This field is set when the module is linked.
[[Namespace]]
Object |undefined
The Module Namespace Object (28.3) if one has been created for this module. Otherwiseundefined.
[[HostDefined]]
Any, default value isundefined.
Field reserved for use byhost environments that need to associate additional information with a module.
Table 41: Abstract Methods of Module Records
Method
Purpose
GetExportedNames([exportStarSet])
Return a list of all names that are either directly or indirectly exported from this module.
ResolveExport(exportName [,resolveSet])
Return the binding of a name exported by this module. Bindings are represented by aResolvedBinding Record, of the form { [[Module]]:Module Record, [[BindingName]]: String }. If the export is a Module Namespace Object without a direct binding in any module, [[BindingName]] will be set to"*namespace*". Returnnull if the name cannot be resolved, or"ambiguous" if multiple bindings were found.
Each time this operation is called with a specificexportName,resolveSet pair as arguments it must return the same result if it completes normally.
Link()
Prepare the module for evaluation by transitively resolving all module dependencies and creating amodule Environment Record.
Evaluate()
If this module has already been evaluated successfully, returnundefined; if it has already been evaluated unsuccessfully, throw the exception that was produced. Otherwise, transitively evaluate all module dependencies of this module and then evaluate this module.
Link must have completed successfully prior to invoking this method.
16.2.1.5 Cyclic Module Records
ACyclic Module Record is used to represent information about a module that can participate in dependency cycles with other modules that are subclasses of theCyclic Module Record type. Module Records that are not subclasses of theCyclic Module Record type must not participate in dependency cycles with Source Text Module Records.
In addition to the fields defined inTable 40 Cyclic Module Records have the additional fields listed inTable 42
Table 42: Additional Fields of Cyclic Module Records
Field Name
Value Type
Meaning
[[Status]]
unlinked |linking |linked |evaluating |evaluated
Initiallyunlinked. Transitions tolinking,linked,evaluating,evaluated (in that order) as the module progresses throughout its lifecycle.
A completion of typethrow representing the exception that occurred during evaluation.undefined if no exception occurred or if [[Status]] is notevaluated.
Auxiliary field used during Link and Evaluate only. If [[Status]] islinking orevaluating, this non-negative number records the point at which the module was first visited during the ongoing depth-first traversal of the dependency graph.
Auxiliary field used during Link and Evaluate only. If [[Status]] islinking orevaluating, this is either the module's own [[DFSIndex]] or that of an "earlier" module in the same strongly connected component.
AList of all theModuleSpecifier strings used by the module represented by this record to request the importation of a module. TheList is source code occurrence ordered.
In addition to the methods defined inTable 41 Cyclic Module Records have the additional methods listed inTable 43
Table 43: Additional Abstract Methods of Cyclic Module Records
The Link concrete method of aCyclic Module Recordmodule takes no arguments. On success, Link transitions this module's [[Status]] fromunlinked tolinked. On failure, an exception is thrown and this module's [[Status]] remainsunlinked. (Most of the work is done by the auxiliary functionInnerModuleLinking.) It performs the following steps when called:
1.Assert:module.[[Status]] is notlinking orevaluating.
The abstract operation InnerModuleLinking takes argumentsmodule (aCyclic Module Record),stack, andindex (a non-negativeinteger). It is used by Link to perform the actual linking process formodule, as well as recursively on all other modules in the dependency graph. Thestack andindex parameters, as well as a module's [[DFSIndex]] and [[DFSAncestorIndex]] fields, keep track of the depth-first search (DFS) traversal. In particular, [[DFSAncestorIndex]] is used to discover strongly connected components (SCCs), such that all modules in an SCC transition tolinked together. It performs the following steps when called:
v.IfrequiredModule andmodule are the sameModule Record, setdone totrue.
14.Returnindex.
16.2.1.5.2 Evaluate ( ) Concrete Method
The Evaluate concrete method of aCyclic Module Recordmodule takes no arguments. Evaluate transitions this module's [[Status]] fromlinked toevaluated. If execution results in an exception, that exception is recorded in the [[EvaluationError]] field and rethrown by future invocations of Evaluate. (Most of the work is done by the auxiliary functionInnerModuleEvaluation.) It performs the following steps when called:
1.Assert: This call to Evaluate is not happening at the same time as another call to Evaluate within thesurrounding agent.
The abstract operation InnerModuleEvaluation takes argumentsmodule (aModule Record),stack, andindex (a non-negativeinteger). It is used by Evaluate to perform the actual evaluation process formodule, as well as recursively on all other modules in the dependency graph. Thestack andindex parameters, as well asmodule's [[DFSIndex]] and [[DFSAncestorIndex]] fields, are used the same way as inInnerModuleLinking. It performs the following steps when called:
v.IfrequiredModule andmodule are the sameModule Record, setdone totrue.
15.Returnindex.
16.2.1.5.3 Example Cyclic Module Record Graphs
This non-normative section gives a series of examples of the linking and evaluation of a few common module graphs, with a specific focus on how errors can occur.
First consider the following simple module graph:
Figure 2: A simple module graph
Let's first assume that there are no error conditions. When ahost first callsA.Link(), this will complete successfully by assumption, and recursively link modulesB andC as well, such thatA.[[Status]] =B.[[Status]] =C.[[Status]] =linked. This preparatory step can be performed at any time. Later, when thehost is ready to incur any possible side effects of the modules, it can callA.Evaluate(), which will complete successfully (again by assumption), recursively having evaluated firstC and thenB. Each module's [[Status]] at this point will beevaluated.
Consider then cases involving linking errors. IfInnerModuleLinking ofC succeeds but, thereafter, fails forB, for example because it imports something thatC does not provide, then the originalA.Link() will fail, and bothA andB's [[Status]] remainunlinked.C's [[Status]] has becomelinked, though.
Finally, consider a case involving evaluation errors. IfInnerModuleEvaluation ofC succeeds but, thereafter, fails forB, for example becauseB contains code that throws an exception, then the originalA.Evaluate() will fail. The resulting exception will be recorded in bothA andB's [[EvaluationError]] fields, and their [[Status]] will becomeevaluated.C will also becomeevaluated but, in contrast toA andB, will remain without an [[EvaluationError]], as it successfully completed evaluation. Storing the exception ensures that any time ahost tries to reuseA orB by calling their Evaluate() method, it will encounter the same exception. (Hosts are not required to reuse Cyclic Module Records; similarly, hosts are not required to expose the exception objects thrown by these methods. However, the specification enables such uses.)
The difference here between linking and evaluation errors is due to how evaluation must be only performed once, as it can cause side effects; it is thus important to remember whether evaluation has already been performed, even if unsuccessfully. (In the error case, it makes sense to also remember the exception because otherwise subsequent Evaluate() calls would have to synthesize a new one.) Linking, on the other hand, is side-effect-free, and thus even if it fails, it can be retried at a later time with no issues.
Now consider a different type of error condition:
Figure 3: A module graph with an unresolvable module
In this scenario, moduleA declares a dependency on some other module, but noModule Record exists for that module, i.e.HostResolveImportedModule throws an exception when asked for it. This could occur for a variety of reasons, such as the corresponding resource not existing, or the resource existing butParseModule throwing an exception when trying to parse the resulting source text. Hosts can choose to expose the cause of failure via the exception they throw fromHostResolveImportedModule. In any case, this exception causes a linking failure, which as before results inA's [[Status]] remainingunlinked.
Lastly, consider a module graph with a cycle:
Figure 4: A cyclic module graph
Here we assume that the entry point is moduleA, so that thehost proceeds by callingA.Link(), which performsInnerModuleLinking onA. This in turn callsInnerModuleLinking onB. Because of the cycle, this again triggersInnerModuleLinking onA, but at this point it is a no-op sinceA.[[Status]] is alreadylinking.B.[[Status]] itself remainslinking when control gets back toA andInnerModuleLinking is triggered onC. After this returns withC.[[Status]] beinglinked, bothA andB transition fromlinking tolinked together; this is by design, since they form a strongly connected component.
An analogous story occurs for the evaluation phase of a cyclic module graph, in the success case.
Now consider a case whereA has an linking error; for example, it tries to import a binding fromC that does not exist. In that case, the above steps still occur, including the early return from the second call toInnerModuleLinking onA. However, once we unwind back to the originalInnerModuleLinking onA, it fails duringInitializeEnvironment, namely right afterC.ResolveExport(). The thrownSyntaxError exception propagates up toA.Link, which resets all modules that are currently on itsstack (these are always exactly the modules that are stilllinking). Hence bothA andB becomeunlinked. Note thatC is left aslinked.
Finally, consider a case whereA has an evaluation error; for example, its source code throws an exception. In that case, the evaluation-time analog of the above steps still occurs, including the early return from the second call toInnerModuleEvaluation onA. However, once we unwind back to the originalInnerModuleEvaluation onA, it fails by assumption. The exception thrown propagates up toA.Evaluate(), which records the error in all modules that are currently on itsstack (i.e., the modules that are stillevaluating). Hence bothA andB becomeevaluated and the exception is recorded in bothA andB's [[EvaluationError]] fields, whileC is left asevaluated with no [[EvaluationError]].
16.2.1.6 Source Text Module Records
ASource Text Module Record is used to represent information about a module that was defined from ECMAScript source text (11) that was parsed using thegoal symbolModule. Its fields contain digested information about the names that are imported by the module and its concrete methods use this digest to link, link, and evaluate the module.
In addition to the fields defined inTable 42, Source Text Module Records have the additional fields listed inTable 44. Each of these fields is initially set inParseModule.
Table 44: Additional Fields of Source Text Module Records
AList of ExportEntry records derived from the code of this module that correspond to reexported imports that occur within the module or exports fromexport * as namespace declarations.
AList of ExportEntry records derived from the code of this module that correspond toexport * declarations that occur within the module, not includingexport * as namespace declarations.
AnImportEntry Record is aRecord that digests information about a single declarative import. EachImportEntry Record has the fields defined inTable 45:
The name under which the desired binding is exported by the module identified by [[ModuleRequest]]. The value"*" indicates that the import request is for the target module's namespace object.
[[LocalName]]
String
The name that is used to locally access the imported value from within the importing module.
Note 1
Table 46 gives examples of ImportEntry records fields used to represent the syntactic import forms:
Table 46 (Informative): Import Forms Mappings to ImportEntry Records
The name under which the desired binding is exported by the module identified by [[ModuleRequest]].null if theExportDeclaration does not have aModuleSpecifier."*" indicates that the export request is for all exported bindings.
[[LocalName]]
String | null
The name that is used to locally access the exported value from within the importing module.null if the exported value is not locally accessible from within the module.
Note 2
Table 48 gives examples of the ExportEntry record fields used to represent the syntactic export forms:
Table 48 (Informative): Export Forms Mappings to ExportEntry Records
Export Statement Form
[[ExportName]]
[[ModuleRequest]]
[[ImportName]]
[[LocalName]]
export var v;
"v"
null
null
"v"
export default function f() {}
"default"
null
null
"f"
export default function () {}
"default"
null
null
"*default*"
export default 42;
"default"
null
null
"*default*"
export {x};
"x"
null
null
"x"
export {v as x};
"x"
null
null
"v"
export {x} from "mod";
"x"
"mod"
"x"
null
export {v as x} from "mod";
"x"
"mod"
"v"
null
export * from "mod";
null
"mod"
"*"
null
export * as ns from "mod";
"ns"
"mod"
"*"
null
The following definitions specify the required concrete methods and otherabstract operations for Source Text Module Records
The abstract operation ParseModule takes argumentssourceText (ECMAScript source text),realm, andhostDefined. It creates aSource Text Module Record based upon the result of parsingsourceText as aModule. It performs the following steps when called:
1.Assert:sourceText is an ECMAScript source text (see clause11).
An implementation may parse module source text and analyse it for Early Error conditions prior to the evaluation of ParseModule for that module source text. However, the reporting of any errors must be deferred until the point where this specification actually performs ParseModule upon that source text.
The GetExportedNames concrete method of aSource Text Module Recordmodule takes optional argumentexportStarSet. It performs the following steps when called:
1.IfexportStarSet is not present, setexportStarSet to a new emptyList.
2.Assert:exportStarSet is aList of Source Text Module Records.
3.IfexportStarSet containsmodule, then
a.Assert: We've reached the starting point of anexport * circularity.
The ResolveExport concrete method of aSource Text Module Recordmodule takes argumentexportName (a String) and optional argumentresolveSet.
ResolveExport attempts to resolve an imported binding to the actual defining module and local binding name. The defining module may be the module represented by theModule Record this method was invoked on or some other module that is imported by that module. The parameterresolveSet is used to detect unresolved circular import/export paths. If a pair consisting of specificModule Record andexportName is reached that is already inresolveSet, an import circularity has been encountered. Before recursively calling ResolveExport, a pair consisting ofmodule andexportName is added toresolveSet.
If a defining module is found, aResolvedBinding Record { [[Module]], [[BindingName]] } is returned. This record identifies the resolved binding of the originally requested export, unless this is the export of a namespace with no local binding. In this case, [[BindingName]] will be set to"*namespace*". If no definition was found or the request is found to be circular,null is returned. If the request is found to be ambiguous, the string"ambiguous" is returned.
This concrete method performs the following steps when called:
1.IfresolveSet is not present, setresolveSet to a new emptyList.
2.Assert:resolveSet is aList ofRecord { [[Module]], [[ExportName]] }.
3.For eachRecord { [[Module]], [[ExportName]] }r ofresolveSet, do
a.Ifmodule andr.[[Module]] are the sameModule Record andSameValue(exportName,r.[[ExportName]]) istrue, then
1.Assert: There is more than one* import that includes the requested name.
2.Ifresolution.[[Module]] andstarResolution.[[Module]] are not the sameModule Record orSameValue(resolution.[[BindingName]],starResolution.[[BindingName]]) isfalse, return"ambiguous".
b.NOTE: The above call cannot fail because imported module requests are a subset ofmodule.[[RequestedModules]], and these have been resolved earlier in this algorithm.
Thehost-defined abstract operation HostResolveImportedModule takes argumentsreferencingScriptOrModule (aScript Record orModule Record ornull) andspecifier (aModuleSpecifier String). It provides the concreteModule Record subclass instance that corresponds tospecifier occurring within the context of the script or module represented byreferencingScriptOrModule.referencingScriptOrModule may benull if the resolution is being performed in the context of animport() expression and there is noactive script or module at that time.
Note
An example of whenreferencingScriptOrModule can benull is in a web browserhost. There, if a user clicks on a control given by
there will be noactive script or module at the time theimport() expression runs. More generally, this can happen in any situation where thehost pushes execution contexts withnull ScriptOrModule components onto theexecution context stack.
The implementation of HostResolveImportedModule must conform to the following requirements:
The normal return value must be an instance of a concrete subclass ofModule Record.
If aModule Record corresponding to the pairreferencingScriptOrModule,specifier does not exist or cannot be created, an exception must be thrown.
Each time this operation is called with a specificreferencingScriptOrModule,specifier pair as arguments it must return the sameModule Record instance if it completes normally.
Multiple differentreferencingScriptOrModule,specifier pairs may map to the sameModule Record instance. The actual mapping semantic ishost-defined but typically a normalization process is applied tospecifier as part of the mapping process. A typical normalization process would include actions such as alphabetic case folding and expansion of relative and abbreviated path specifiers.
Thehost-defined abstract operation HostImportModuleDynamically takes argumentsreferencingScriptOrModule (aScript Record orModule Record ornull),specifier (aModuleSpecifier String), andpromiseCapability (aPromiseCapability Record). It performs any necessary setup work in order to make available the module corresponding tospecifier occurring within the context of the script or module represented byreferencingScriptOrModule.referencingScriptOrModule may benull if there is noactive script or module when theimport() expression occurs. It then performsFinishDynamicImport to finish the dynamic import process.
The implementation of HostImportModuleDynamically must conform to the following requirements:
The abstract operation must always complete normally withundefined. Success or failure must instead be signaled as discussed below.
Thehost environment must conform to one of the two following sets of requirements:
The completion value of any subsequent call toHostResolveImportedModule afterFinishDynamicImport has completed, given the argumentsreferencingScriptOrModule andspecifier, must be a module which has already been evaluated, i.e. whose Evaluate concrete method has already been called and returned a normal completion.
If thehost environment takes the success path once for a givenreferencingScriptOrModule,specifier pair, it must always do so for subsequent calls.
The operation must not callpromiseCapability.[[Resolve]] orpromiseCapability.[[Reject]], but instead must treatpromiseCapability as an opaque identifying value to be passed through toFinishDynamicImport.
The actual process performed ishost-defined, but typically consists of performing whatever I/O operations are necessary to allowHostResolveImportedModule to synchronously retrieve the appropriateModule Record, and then calling its Evaluate concrete method. This might require performing similar normalization asHostResolveImportedModule does.
The abstract operation FinishDynamicImport takes argumentsreferencingScriptOrModule,specifier,promiseCapability (aPromiseCapability Record), andcompletion. FinishDynamicImport completes the process of a dynamic import originally started by animport() call, resolving or rejecting the promise returned by that call as appropriate according tocompletion. It is performed byhost environments as part ofHostImportModuleDynamically. It performs the following steps when called:
1.Ifcompletion is anabrupt completion, perform ! Call(promiseCapability.[[Reject]],undefined, «completion.[[Value]] »).
2.Else,
a.Assert:completion is a normal completion andcompletion.[[Value]] isundefined.
The abstract operation GetModuleNamespace takes argumentmodule. It retrieves the Module Namespace Object representingmodule's exports, lazily creating it the first time it was requested, and storing it inmodule.[[Namespace]] for future retrieval. It performs the following steps when called:
The only way GetModuleNamespace can throw is via one of the triggeredHostResolveImportedModule calls. Unresolvable names are simply excluded from the namespace at this point. They will lead to a real linking error later unless they are all ambiguous star exports that are not explicitly requested anywhere.
3.Return aList whose sole element is theExportEntry Record { [[ModuleRequest]]:null, [[ImportName]]:null, [[LocalName]]:localName, [[ExportName]]:"default" }.
3.Return aList whose sole element is theExportEntry Record { [[ModuleRequest]]:null, [[ImportName]]:null, [[LocalName]]:localName, [[ExportName]]:"default" }.
4.Return aList whose sole element is theExportEntry Record { [[ModuleRequest]]:module, [[ImportName]]:importName, [[LocalName]]:localName, [[ExportName]]:sourceName }.
5.Return aList whose sole element is theExportEntry Record { [[ModuleRequest]]:module, [[ImportName]]:importName, [[LocalName]]:localName, [[ExportName]]:exportName }.
An implementation must report most errors at the time the relevant ECMAScript language construct is evaluated. Anearly error is an error that can be detected and reported prior to the evaluation of any construct in theScript containing the error. The presence of anearly error prevents the evaluation of the construct. An implementation must report early errors in aScript as part of parsing thatScript inParseScript. Early errors in aModule are reported at the point when theModule would be evaluated and theModule is never initialized. Early errors ineval code are reported at the timeeval is called and prevent evaluation of theeval code. All errors that are not early errors are runtime errors.
An implementation must report as anearly error any occurrence of a condition that is listed in a “Static Semantics: Early Errors” subclause of this specification.
An implementation shall not treat other kinds of errors as early errors even if the compiler can prove that a construct cannot execute without error under any circumstances. An implementation may issue an early warning in such a case, but it should not report the error until the relevant construct is actually executed.
An implementation shall report all errors as specified, except for the following:
Except as restricted in17.1, ahost or implementation may extendScript syntax,Module syntax, and regular expression pattern or flag syntax. To permit this, all operations (such as callingeval, using a regular expression literal, or using the Function or RegExpconstructor) that are allowed to throwSyntaxError are permitted to exhibithost-defined behaviour instead of throwingSyntaxError when they encounter ahost-defined extension to the script syntax or regular expression pattern or flag syntax.
Except as restricted in17.1, ahost or implementation may provide additional types, values, objects, properties, and functions beyond those described in this specification. This may cause constructs (such as looking up a variable in the global scope) to havehost-defined behaviour instead of throwing an error (such asReferenceError).
17.1 Forbidden Extensions
An implementation must not extend this specification in the following ways:
If an implementation extends anyfunction object with an own property named"caller" the value of that property, as observed using [[Get]] or [[GetOwnProperty]], must not be astrict function object. If it is anaccessor property, the function that is the value of the property's [[Get]] attribute must never return astrict function when called.
Neither mapped nor unmapped arguments objects may be created with an own property named"caller".
The behaviour of built-in methods which are specified in ECMA-402, such as those namedtoLocaleString, must not be extended except as specified in ECMA-402.
The RegExp pattern grammars in22.2.1 andB.1.4 must not be extended to recognize any of the source characters A-Z or a-z asIdentityEscape[+U] when the[U] grammar parameter is present.
The Syntactic Grammar must not be extended in any manner that allows the token: to immediately follow source text that matches theBindingIdentifier nonterminal symbol.
There are certain built-in objects available whenever an ECMAScriptScript orModule begins execution. One, theglobal object, is part of theglobal environment of the executing program. Others are accessible as initial properties of theglobal object or indirectly as properties of accessible built-in objects.
Unless specified otherwise, a built-in object that is callable as a function is a built-infunction object with the characteristics described in10.3. Unless specified otherwise, the [[Extensible]] internal slot of a built-in object initially has the valuetrue. Every built-infunction object has a [[Realm]] internal slot whose value is theRealm Record of therealm for which the object was initially created.
Many built-in objects are functions: they can be invoked with arguments. Some of them furthermore are constructors: they are functions intended for use with thenew operator. For each built-in function, this specification describes the arguments required by that function and the properties of thatfunction object. For each built-inconstructor, this specification furthermore describes properties of the prototype object of thatconstructor and properties of specific object instances returned by anew expression that invokes thatconstructor.
Unless otherwise specified in the description of a particular function, if a built-in function orconstructor is given fewer arguments than the function is specified to require, the function orconstructor shall behave exactly as if it had been given sufficient additional arguments, each such argument being theundefined value. Such missing arguments are considered to be “not present” and may be identified in that manner by specification algorithms. In the description of a particular function, the terms “this value” and “NewTarget” have the meanings given in10.3.
Unless otherwise specified in the description of a particular function, if a built-in function orconstructor described is given more arguments than the function is specified to allow, the extra arguments are evaluated by the call and then ignored by the function. However, an implementation may define implementation specific behaviour relating to such arguments as long as the behaviour is not the throwing of aTypeError exception that is predicated simply on the presence of an extra argument.
Note 1
Implementations that add additional capabilities to the set of built-in functions are encouraged to do so by adding new functions rather than adding new parameters to existing functions.
Unless otherwise specified every built-in function and every built-inconstructor has theFunction prototype object, which is the initial value of the expressionFunction.prototype (20.2.3), as the value of its [[Prototype]] internal slot.
Unless otherwise specified every built-in prototype object has theObject prototype object, which is the initial value of the expressionObject.prototype (20.1.3), as the value of its [[Prototype]] internal slot, except theObject prototype object itself.
Built-in function objects that are not identified as constructors do not implement the [[Construct]] internal method unless otherwise specified in the description of a particular function.
Each built-in function defined in this specification is created by calling theCreateBuiltinFunction abstract operation (10.3.3). The values of thelength andname parameters are the initial values of the"length" and"name" properties as discussed below. The values of theprefix parameter are similarly discussed below.
Every built-infunction object, including constructors, has a"length" property whose value is a non-negativeintegral Number. Unless otherwise specified, this value is equal to the number of required parameters shown in the subclause headings for the function description. Optional parameters and rest parameters are not included in the parameter count.
Note 2
For example, thefunction object that is the initial value of the"map" property of theArray prototype object is described under the subclause heading «Array.prototype.map (callbackFn [ , thisArg])» which shows the two named arguments callbackFn and thisArg, the latter being optional; therefore the value of the"length" property of thatfunction object is1𝔽.
Unless otherwise specified, the"length" property of a built-infunction object has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
Every built-infunction object, including constructors, has a"name" property whose value is a String. Unless otherwise specified, this value is the name that is given to the function in this specification. Functions that are identified as anonymous functions use the empty String as the value of the"name" property. For functions that are specified as properties of objects, the name value is theproperty name string used to access the function. Functions that are specified as get or set accessor functions of built-in properties have"get" or"set" (respectively) passed to theprefix parameter when callingCreateBuiltinFunction.
The value of the"name" property is explicitly specified for each built-in functions whose property key is a Symbol value. If such an explicitly specified value starts with the prefix"get " or"set " and the function for which it is specified is a get or set accessor function of a built-in property, the value without the prefix is passed to thename parameter, and the value"get" or"set" (respectively) is passed to theprefix parameter when callingCreateBuiltinFunction.
Unless otherwise specified, the"name" property of a built-infunction object has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
Every otherdata property described in clauses19 through28 and in AnnexB.2 has the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:true } unless otherwise specified.
Everyaccessor property described in clauses19 through28 and in AnnexB.2 has the attributes { [[Enumerable]]:false, [[Configurable]]:true } unless otherwise specified. If only a get accessor function is described, the set accessor function is the default value,undefined. If only a set accessor is described the get accessor is the default value,undefined.
does not have a [[Construct]] internal method; it cannot be used as aconstructor with thenew operator.
does not have a [[Call]] internal method; it cannot be invoked as a function.
has a [[Prototype]] internal slot whose value ishost-defined.
may havehost defined properties in addition to the properties defined in this specification. This may include a property whose value is the global object itself.
19.1 Value Properties of the Global Object
19.1.1 globalThis
The initial value of the"globalThis" property of theglobal object in aRealm Recordrealm isrealm.[[GlobalEnv]].[[GlobalThisValue]].
This property has the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:true }.
19.1.2 Infinity
The value ofInfinity is+∞𝔽 (see6.1.6.1). This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
19.1.3 NaN
The value ofNaN isNaN (see6.1.6.1). This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
19.1.4 undefined
The value ofundefined isundefined (see6.1.1). This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
19.2 Function Properties of the Global Object
19.2.1 eval (x )
Theeval function is the%eval% intrinsic object. When theeval function is called with one argumentx, the following steps are taken:
13.NOTE: Ifdirect istrue,runningContext will be theexecution context that performed thedirect eval. Ifdirect isfalse,runningContext will be theexecution context for the invocation of theeval function.
The eval code cannot instantiate variable or function bindings in the variable environment of the calling context that invoked the eval if the calling context is evaluating formal parameter initializers or if either the code of the calling context or the eval code isstrict mode code. Instead such bindings are instantiated in a new VariableEnvironment that is only accessible to the eval code. Bindings introduced bylet,const, orclass declarations are always instantiated in a new LexicalEnvironment.
Thehost-defined abstract operation HostEnsureCanCompileStrings takes argumentscallerRealm (aRealm Record) andcalleeRealm (aRealm Record). It allowshost environments to block certain ECMAScript functions which allow developers to compile strings into ECMAScript code.
An implementation of HostEnsureCanCompileStrings may complete normally or abruptly. Any abrupt completions will be propagated to its callers. The default implementation of HostEnsureCanCompileStrings is to unconditionally return an empty normal completion.
A reliable way for ECMAScript code to test if a valueX is aNaN is an expression of the formX !== X. The result will betrue if and only ifX is aNaN.
19.2.4 parseFloat (string )
TheparseFloat function produces aNumber value dictated by interpretation of the contents of thestring argument as a decimal literal.
TheparseFloat function is the%parseFloat% intrinsic object. When theparseFloat function is called with one argumentstring, the following steps are taken:
parseFloat may interpret only a leading portion ofstring as aNumber value; it ignores any code units that cannot be interpreted as part of the notation of a decimal literal, and no indication is given that any such code units were ignored.
19.2.5 parseInt (string,radix )
TheparseInt function produces anintegral Number dictated by interpretation of the contents of thestring argument according to the specifiedradix. Leading white space instring is ignored. Ifradix isundefined or 0, it is assumed to be 10 except when the number begins with the code unit pairs0x or0X, in which case a radix of 16 is assumed. Ifradix is 16, the number may also optionally begin with the code unit pairs0x or0X.
TheparseInt function is the%parseInt% intrinsic object. When theparseInt function is called, the following steps are taken:
4.IfS is not empty and the first code unit ofS is the code unit 0x002D (HYPHEN-MINUS), setsign to -1.
5.IfS is not empty and the first code unit ofS is the code unit 0x002B (PLUS SIGN) or the code unit 0x002D (HYPHEN-MINUS), remove the first code unit fromS.
14.LetmathInt be theinteger value that is represented byZ in radix-R notation, using the lettersA-Z anda-z for digits with values 10 through 35. (However, ifR is 10 andZ contains more than 20 significant digits, every significant digit after the 20th may be replaced by a 0 digit, at the option of the implementation; and ifR is not 2, 4, 8, 10, 16, or 32, thenmathInt may be animplementation-approximated value representing theinteger value that is represented byZ in radix-R notation.)
parseInt may interpret only a leading portion ofstring as aninteger value; it ignores any code units that cannot be interpreted as part of the notation of aninteger, and no indication is given that any such code units were ignored.
19.2.6 URI Handling Functions
Uniform Resource Identifiers, or URIs, are Strings that identify resources (e.g. web pages or files) and transport protocols by which to access them (e.g. HTTP or FTP) on the Internet. The ECMAScript language itself does not provide any support for using URIs except for functions that encode and decode URIs as described in19.2.6.2,19.2.6.3,19.2.6.4 and19.2.6.5
Note
Many implementations of ECMAScript provide additional functions and methods that manipulate web pages; these functions are beyond the scope of this standard.
19.2.6.1 URI Syntax and Semantics
A URI is composed of a sequence of components separated by component separators. The general form is:
Scheme:First/Second;Third?Fourth
where the italicized names represent components and “:”, “/”, “;” and “?” are reserved for use as separators. TheencodeURI anddecodeURI functions are intended to work with complete URIs; they assume that any reserved code units in the URI are intended to have special meaning and so are not encoded. TheencodeURIComponent anddecodeURIComponent functions are intended to work with the individual component parts of a URI; they assume that any reserved code units represent text and so must be encoded so that they are not interpreted as reserved code units when the component is part of a complete URI.
The following lexical grammar specifies the form of encoded URIs.
The above syntax is based upon RFC 2396 and does not reflect changes introduced by the more recent RFC 3986.
Runtime Semantics
When a code unit to be included in a URI is not listed above or is not intended to have the special meaning sometimes given to the reserved code units, that code unit must be encoded. The code unit is transformed into its UTF-8 encoding, withsurrogate pairs first converted from UTF-16 to the corresponding code point value. (Note that for code units in the range [0, 127] this results in a single octet with the same value.) The resulting sequence of octets is then transformed into a String with each octet represented by an escape sequence of the form"%xx".
19.2.6.1.1 Encode (string,unescapedSet )
The abstract operation Encode takes argumentsstring (a String) andunescapedSet (a String). It performs URI encoding and escaping. It performs the following steps when called:
the String representation ofoctet, formatted as a two-digit uppercase hexadecimal number, padded to the left with a zero if necessary
19.2.6.1.2 Decode (string,reservedSet )
The abstract operation Decode takes argumentsstring (a String) andreservedSet (a String). It performs URI unescaping and decoding. It performs the following steps when called:
1.LetstrLen be the length ofstring.
2.LetR be the empty String.
3.Letk be 0.
4.Repeat,
a.Ifk =strLen, returnR.
b.LetC be the code unit at indexk withinstring.
c.IfC is not the code unit 0x0025 (PERCENT SIGN), then
i.LetS be the String value containing only the code unitC.
d.Else,
i.Letstart bek.
ii.Ifk + 2 ≥strLen, throw aURIError exception.
iii.If the code units at index (k + 1) and (k + 2) withinstring do not represent hexadecimal digits, throw aURIError exception.
iv.LetB be the 8-bit value represented by the two hexadecimal digits at index (k + 1) and (k + 2).
v.Setk tok + 2.
vi.Letn be the number of leading 1 bits inB.
vii.Ifn = 0, then
1.LetC be the code unit whose value isB.
2.IfC is not inreservedSet, then
a.LetS be the String value containing only the code unitC.
3.Else,
a.LetS be thesubstring ofstring fromstart tok + 1.
This syntax of Uniform Resource Identifiers is based upon RFC 2396 and does not reflect the more recent RFC 3986 which replaces RFC 2396. A formal description and implementation of UTF-8 is given in RFC 3629.
In UTF-8, characters are encoded using sequences of 1 to 6 octets. The only octet of a sequence of one has the higher-order bit set to 0, the remaining 7 bits being used to encode the character value. In a sequence of n octets, n > 1, the initial octet has the n higher-order bits set to 1, followed by a bit set to 0. The remaining bits of that octet contain bits from the value of the character to be encoded. The following octets all have the higher-order bit set to 1 and the following bit set to 0, leaving 6 bits in each to contain bits from the character to be encoded. The possible UTF-8 encodings of ECMAScript characters are specified inTable 49.
Table 49 (Informative): UTF-8 Encodings
Code Unit Value
Representation
1st Octet
2nd Octet
3rd Octet
4th Octet
0x0000 - 0x007F
00000000 0zzzzzzz
0zzzzzzz
0x0080 - 0x07FF
00000yyy yyzzzzzz
110yyyyy
10zzzzzz
0x0800 - 0xD7FF
xxxxyyyy yyzzzzzz
1110xxxx
10yyyyyy
10zzzzzz
0xD800 - 0xDBFF followed by 0xDC00 - 0xDFFF
110110vv vvwwwwxx followed by 110111yy yyzzzzzz
11110uuu
10uuwwww
10xxyyyy
10zzzzzz
0xD800 - 0xDBFF not followed by 0xDC00 - 0xDFFF
causesURIError
0xDC00 - 0xDFFF
causesURIError
0xE000 - 0xFFFF
xxxxyyyy yyzzzzzz
1110xxxx
10yyyyyy
10zzzzzz
Where uuuuu =vvvv + 1 to account for the addition of 0x10000 as in section 3.8 of the Unicode Standard (Surrogates).
The above transformation combines eachsurrogate pair (for which code unit values in the inclusive range 0xD800 to 0xDFFF are reserved) into a UTF-32 representation and encodes the resulting 21-bit value into UTF-8. Decoding reconstructs thesurrogate pair.
RFC 3629 prohibits the decoding of invalid UTF-8 octet sequences. For example, the invalid sequence C0 80 must not decode into the code unit 0x0000. Implementations of the Decode algorithm are required to throw aURIError when encountering such invalid sequences.
19.2.6.2 decodeURI (encodedURI )
ThedecodeURI function computes a new version of a URI in which each escape sequence and UTF-8 encoding of the sort that might be introduced by theencodeURI function is replaced with the UTF-16 encoding of the code points that it represents. Escape sequences that could not have been introduced byencodeURI are not replaced.
ThedecodeURI function is the%decodeURI% intrinsic object. When thedecodeURI function is called with one argumentencodedURI, the following steps are taken:
ThedecodeURIComponent function computes a new version of a URI in which each escape sequence and UTF-8 encoding of the sort that might be introduced by theencodeURIComponent function is replaced with the UTF-16 encoding of the code points that it represents.
ThedecodeURIComponent function is the%decodeURIComponent% intrinsic object. When thedecodeURIComponent function is called with one argumentencodedURIComponent, the following steps are taken:
1.LetcomponentString be ? ToString(encodedURIComponent).
TheencodeURI function computes a new version of a UTF-16 encoded (6.1.4) URI in which each instance of certain code points is replaced by one, two, three, or four escape sequences representing the UTF-8 encoding of the code points.
TheencodeURI function is the%encodeURI% intrinsic object. When theencodeURI function is called with one argumenturi, the following steps are taken:
The code point# is not encoded to an escape sequence even though it is not a reserved or unescaped URI code point.
19.2.6.5 encodeURIComponent (uriComponent )
TheencodeURIComponent function computes a new version of a UTF-16 encoded (6.1.4) URI in which each instance of certain code points is replaced by one, two, three, or four escape sequences representing the UTF-8 encoding of the code point.
TheencodeURIComponent function is the%encodeURIComponent% intrinsic object. When theencodeURIComponent function is called with one argumenturiComponent, the following steps are taken:
Theassign function is used to copy the values of all of the enumerable own properties from one or more source objects to atarget object. When theassign function is called, the following steps are taken:
ThedefineProperties function is used to add own properties and/or update the attributes of existing own properties of an object. When thedefineProperties function is called, the following steps are taken:
1.IfType(O) is not Object, throw aTypeError exception.
ThedefineProperty function is used to add an own property and/or update the attributes of an existing own property of an object. When thedefineProperty function is called, the following steps are taken:
1.IfType(O) is not Object, throw aTypeError exception.
The function created foradder is never directly accessible to ECMAScript code.
20.1.2.7.1 CreateDataPropertyOnObject Functions
A CreateDataPropertyOnObject function is an anonymous built-in function. When a CreateDataPropertyOnObject function is called with argumentskey andvalue, the following steps are taken:
has an [[Extensible]] internal slot whose value istrue.
has the internal methods defined for ordinary objects, except for the [[SetPrototypeOf]] method, which is as defined in10.4.7.1. (Thus, it is animmutable prototype exotic object.)
has a [[Prototype]] internal slot whose value isnull.
20.1.3.1 Object.prototype.constructor
The initial value ofObject.prototype.constructor is%Object%.
20.1.3.2 Object.prototype.hasOwnProperty (V )
When thehasOwnProperty method is called with argumentV, the following steps are taken:
The ordering of steps1 and2 is chosen to ensure that any exception that would have been thrown by step1 in previous editions of this specification will continue to be thrown even if thethis value isundefined ornull.
20.1.3.3 Object.prototype.isPrototypeOf (V )
When theisPrototypeOf method is called with argumentV, the following steps are taken:
The ordering of steps1 and2 preserves the behaviour specified by previous editions of this specification for the case whereV is not an object and thethis value isundefined ornull.
20.1.3.4 Object.prototype.propertyIsEnumerable (V )
When thepropertyIsEnumerable method is called with argumentV, the following steps are taken:
This method does not consider objects in the prototype chain.
Note 2
The ordering of steps1 and2 is chosen to ensure that any exception that would have been thrown by step1 in previous editions of this specification will continue to be thrown even if thethis value isundefined ornull.
The optional parameters to this function are not used but are intended to correspond to the parameter pattern used by ECMA-402toLocaleString functions. Implementations that do not include ECMA-402 support must not use those parameter positions for other purposes.
Note 1
This function provides a generictoLocaleString implementation for objects that have no locale-specifictoString behaviour.Array,Number,Date, and%TypedArray% provide their own locale-sensitivetoLocaleString methods.
Note 2
ECMA-402 intentionally does not provide an alternative to this default implementation.
20.1.3.6 Object.prototype.toString ( )
When thetoString method is called, the following steps are taken:
1.If thethis value isundefined, return"[object Undefined]".
Historically, this function was occasionally used to access the String value of the [[Class]] internal slot that was used in previous editions of this specification as a nominal type tag for various built-in objects. The above definition oftoString preserves compatibility for legacy code that usestoString as a test for those specific kinds of built-in objects. It does not provide a reliable type testing mechanism for other kinds of built-in or program defined objects. In addition, programs can use@@toStringTag in ways that will invalidate the reliability of such legacy type tests.
20.1.3.7 Object.prototype.valueOf ( )
When thevalueOf method is called, the following steps are taken:
is the initial value of the"Function" property of theglobal object.
creates and initializes a newfunction object when called as a function rather than as aconstructor. Thus the function callFunction(…) is equivalent to the object creation expressionnew Function(…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified Function behaviour must include asuper call to the Functionconstructor to create and initialize a subclass instance with the internal slots necessary for built-in function behaviour. All ECMAScript syntactic forms for defining function objects create instances of Function. There is no syntactic means to create instances of Function subclasses except for the built-in GeneratorFunction, AsyncFunction, and AsyncGeneratorFunction subclasses.
20.2.1.1 Function (p1,p2, … ,pn,body )
The last argument specifies the body (executable code) of a function; any preceding arguments specify formal parameters.
When theFunction function is called with some argumentsp1,p2, … ,pn,body (wheren might be 0, that is, there are no “p ” arguments, and wherebody might also not be provided), the following steps are taken:
It is permissible but not necessary to have one argument for each formal parameter to be specified. For example, all three of the following expressions produce the same result:
The abstract operation CreateDynamicFunction takes argumentsconstructor (aconstructor),newTarget (aconstructor),kind (eithernormal,generator,async, orasyncGenerator), andargs (aList of ECMAScript language values).constructor is theconstructor function that is performing this action.newTarget is theconstructor thatnew was initially applied to.args is the argument values that were passed toconstructor. It performs the following steps when called:
29.NOTE: Functions whosekind isasync are not constructible and do not have a [[Construct]] internal method or a"prototype" property.
30.ReturnF.
Note
CreateDynamicFunction defines a"prototype" property on any function it creates whosekind is notasync to provide for the possibility that the function will be used as aconstructor.
has a"name" property whose value is the empty String.
Note
The Function prototype object is specified to be afunction object to ensure compatibility with ECMAScript code that was created prior to the ECMAScript 2015 specification.
ThethisArg value is passed without modification as thethis value. This is a change from Edition 3, where anundefined ornullthisArg is replaced with theglobal object andToObject is applied to all other values and that result is passed as thethis value. Even though thethisArg is passed without modification, non-strict functions still perform these transformations upon entry to the function.
Note 2
Iffunc is an arrow function or abound function exotic object then thethisArg will be ignored by the function [[Call]] in step6.
ThethisArg value is passed without modification as thethis value. This is a change from Edition 3, where anundefined ornullthisArg is replaced with theglobal object andToObject is applied to all other values and that result is passed as thethis value. Even though thethisArg is passed without modification, non-strict functions still perform these transformations upon entry to the function.
Note 2
Iffunc is an arrow function or abound function exotic object then thethisArg will be ignored by the function [[Call]] in step4.
20.2.3.4 Function.prototype.constructor
The initial value ofFunction.prototype.constructor is%Function%.
20.2.3.5 Function.prototype.toString ( )
When thetoString method is called, the following steps are taken:
1.Letfunc be thethis value.
2.IfType(func) is Object andfunc has a [[SourceText]] internal slot andfunc.[[SourceText]] is a sequence of Unicode code points and ! HostHasSourceTextAvailable(func) istrue, then
3.Iffunc is abuilt-in function object, return animplementation-defined String source code representation offunc. The representation must have the syntax of aNativeFunction. Additionally, iffunc has an [[InitialName]] internal slot andfunc.[[InitialName]] is a String, the portion of the returned String that would be matched byNativeFunctionAccessoroptPropertyName must be the value offunc.[[InitialName]].
The value of the"name" property of this function is"[Symbol.hasInstance]".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
Note
This is the default implementation of@@hasInstance that most functions inherit.@@hasInstance is called by theinstanceof operator to determine whether a value is an instance of a specificconstructor. An expression such as
vinstanceof F
evaluates as
F[@@hasInstance](v)
Aconstructor function can control which objects are recognized as its instances byinstanceof by exposing a different@@hasInstance method on the function.
This property is non-writable and non-configurable to prevent tampering that could be used to globally expose the target function of abound function.
20.2.4 Function Instances
Every Function instance is an ECMAScriptfunction object and has the internal slots listed inTable 29. Function objects created using theFunction.prototype.bind method (20.2.3.2) have the internal slots listed inTable 30.
Function instances have the following properties:
20.2.4.1 length
The value of the"length" property is anintegral Number that indicates the typical number of arguments expected by the function. However, the language permits the function to be invoked with some other number of arguments. The behaviour of a function when invoked on a number of arguments other than the number specified by its"length" property depends on the function. This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
20.2.4.2 name
The value of the"name" property is a String that is descriptive of the function. The name has no semantic significance but is typically a variable orproperty name that is used to refer to the function at its point of definition in ECMAScript code. This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
Anonymous functions objects that do not have a contextual name associated with them by this specification use the empty String as the value of the"name" property.
20.2.4.3 prototype
Function instances that can be used as aconstructor have a"prototype" property. Whenever such a Function instance is created anotherordinary object is also created and is the initial value of the function's"prototype" property. Unless otherwise specified, the value of the"prototype" property is used to initialize the [[Prototype]] internal slot of the object created when that function is invoked as aconstructor.
This property has the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:false }.
Thehost-defined abstract operation HostHasSourceTextAvailable takes argumentfunc (afunction object). It allowshost environments to prevent the source text from being provided forfunc.
An implementation of HostHasSourceTextAvailable must complete normally in all cases. This operation must be deterministic with respect to its parameters. Each time it is called with a specificfunc as its argument, it must return the same completion record. The default implementation of HostHasSourceTextAvailable is to unconditionally return a normal completion with a value oftrue.
is the initial value of the"Boolean" property of theglobal object.
creates and initializes a new Boolean object when called as aconstructor.
performs a type conversion when called as a function rather than as aconstructor.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified Boolean behaviour must include asuper call to the Booleanconstructor to create and initialize the subclass instance with a [[BooleanData]] internal slot.
20.3.1.1 Boolean (value )
WhenBoolean is called with argumentvalue, the following steps are taken:
Boolean instances are ordinary objects that inherit properties from theBoolean prototype object. Boolean instances have a [[BooleanData]] internal slot. The [[BooleanData]] internal slot is the Boolean value represented by this Boolean object.
3.Assert: GlobalSymbolRegistry does not currently contain an entry forstringKey.
4.LetnewSymbol be a new unique Symbol value whose [[Description]] value isstringKey.
5.Append theRecord { [[Key]]:stringKey, [[Symbol]]:newSymbol } to the GlobalSymbolRegistryList.
6.ReturnnewSymbol.
The GlobalSymbolRegistry is aList that is globally available. It is shared by all realms. Prior to the evaluation of any ECMAScript code it is initialized as a new emptyList. Elements of the GlobalSymbolRegistry are Records with the structure defined inTable 51.
The value of the"name" property of this function is"[Symbol.toPrimitive]".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
Note
The argument is ignored.
20.4.3.6 Symbol.prototype [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"Symbol".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
20.4.4 Properties of Symbol Instances
Symbol instances are ordinary objects that inherit properties from theSymbol prototype object. Symbol instances have a [[SymbolData]] internal slot. The [[SymbolData]] internal slot is the Symbol value represented by this Symbol object.
20.5 Error Objects
Instances of Error objects are thrown as exceptions when runtime errors occur. The Error objects may also serve as base objects for user-defined exception classes.
When an ECMAScript implementation detects a runtime error, it throws a new instance of one of theNativeError objects defined in20.5.5 or a new instance of AggregateError object defined in20.5.7. Each of these objects has the structure described below, differing only in the name used as theconstructor name instead ofNativeError, in thename property of the prototype object, in theimplementation-definedmessage property of the prototype object, and in the presence of the%AggregateError%-specificerrors property.
is the initial value of the"Error" property of theglobal object.
creates and initializes a new Error object when called as a function rather than as aconstructor. Thus the function callError(…) is equivalent to the object creation expressionnew Error(…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified Error behaviour must include asuper call to the Errorconstructor to create and initialize subclass instances with an [[ErrorData]] internal slot.
20.5.1.1 Error (message )
When theError function is called with argumentmessage, the following steps are taken:
1.If NewTarget isundefined, letnewTarget be theactive function object; else letnewTarget be NewTarget.
6.Ifmsg isundefined, setmsg to the empty String; otherwise setmsg to ? ToString(msg).
7.Ifname is the empty String, returnmsg.
8.Ifmsg is the empty String, returnname.
9.Return thestring-concatenation ofname, the code unit 0x003A (COLON), the code unit 0x0020 (SPACE), andmsg.
20.5.4 Properties of Error Instances
Error instances are ordinary objects that inherit properties from theError prototype object and have an [[ErrorData]] internal slot whose value isundefined. The only specified uses of [[ErrorData]] is to identify Error, AggregateError, andNativeError instances as Error objects withinObject.prototype.toString.
20.5.5 Native Error Types Used in This Standard
A new instance of one of theNativeError objects below or of the AggregateError object is thrown when a runtime error is detected. AllNativeError objects share the same structure, as described in20.5.6.
Indicates that one of the global URI handling functions was used in a way that is incompatible with its definition.
20.5.6NativeError Object Structure
When an ECMAScript implementation detects a runtime error, it throws a new instance of one of theNativeError objects defined in20.5.5. Each of these objects has the structure described below, differing only in the name used as theconstructor name instead ofNativeError, in the"name" property of the prototype object, and in theimplementation-defined"message" property of the prototype object.
For each error object, references toNativeError in the definition should be replaced with the appropriate error object name from20.5.5.
creates and initializes a newNativeError object when called as a function rather than as aconstructor. A call of the object as a function is equivalent to calling it as aconstructor with the same arguments. Thus the function callNativeError(…) is equivalent to the object creation expressionnewNativeError(…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specifiedNativeError behaviour must include asuper call to theNativeErrorconstructor to create and initialize subclass instances with an [[ErrorData]] internal slot.
20.5.6.1.1NativeError (message )
When aNativeError function is called with argumentmessage, the following steps are taken:
1.If NewTarget isundefined, letnewTarget be theactive function object; else letnewTarget be NewTarget.
The actual value of the string passed in step2 is either"%EvalError.prototype%","%RangeError.prototype%","%ReferenceError.prototype%","%SyntaxError.prototype%","%TypeError.prototype%", or"%URIError.prototype%" corresponding to whichNativeErrorconstructor is being defined.
20.5.6.2 Properties of theNativeError Constructors
The initial value of the"constructor" property of the prototype for a givenNativeErrorconstructor is the corresponding intrinsic object %NativeError% (20.5.6.1).
20.5.6.3.2NativeError.prototype.message
The initial value of the"message" property of the prototype for a givenNativeErrorconstructor is the empty String.
20.5.6.3.3NativeError.prototype.name
The initial value of the"name" property of the prototype for a givenNativeErrorconstructor is the String value consisting of the name of theconstructor (the name used instead ofNativeError).
20.5.6.4 Properties ofNativeError Instances
NativeError instances are ordinary objects that inherit properties from theirNativeError prototype object and have an [[ErrorData]] internal slot whose value isundefined. The only specified use of [[ErrorData]] is byObject.prototype.toString (20.1.3.6) to identify Error, AggregateError, orNativeError instances.
is the initial value of the"AggregateError" property of theglobal object.
creates and initializes a new AggregateError object when called as a function rather than as aconstructor. Thus the function callAggregateError(…) is equivalent to the object creation expressionnew AggregateError(…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified AggregateError behaviour must include asuper call to the AggregateErrorconstructor to create and initialize subclass instances with an [[ErrorData]] internal slot.
20.5.7.1.1 AggregateError (errors,message )
When theAggregateError function is called with argumentserrors andmessage, the following steps are taken:
1.If NewTarget isundefined, letnewTarget be theactive function object; else letnewTarget be NewTarget.
The initial value ofAggregateError.prototype.constructor is%AggregateError%.
20.5.7.3.2 AggregateError.prototype.message
The initial value ofAggregateError.prototype.message is the empty String.
20.5.7.3.3 AggregateError.prototype.name
The initial value ofAggregateError.prototype.name is"AggregateError".
20.5.7.4 Properties of AggregateError Instances
AggregateError instances are ordinary objects that inherit properties from theirAggregateError prototype object and have an [[ErrorData]] internal slot whose value isundefined. The only specified use of [[ErrorData]] is byObject.prototype.toString (20.1.3.6) to identify Error, AggregateError, orNativeError instances.
is the initial value of the"Number" property of theglobal object.
creates and initializes a new Number object when called as aconstructor.
performs a type conversion when called as a function rather than as aconstructor.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified Number behaviour must include asuper call to the Numberconstructor to create and initialize the subclass instance with a [[NumberData]] internal slot.
21.1.1.1 Number (value )
WhenNumber is called with argumentvalue, the following steps are taken:
The value ofNumber.EPSILON is theNumber value for the magnitude of the difference between 1 and the smallest value greater than 1 that is representable as aNumber value, which is approximately 2.2204460492503130808472633361816 × 10-16.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.1.2.2 Number.isFinite (number )
WhenNumber.isFinite is called with one argumentnumber, the following steps are taken:
This function differs from the global isNaN function (19.2.3) in that it does not convert its argument to a Number before determining whether it isNaN.
21.1.2.5 Number.isSafeInteger (number )
WhenNumber.isSafeInteger is called with one argumentnumber, the following steps are taken:
The value ofNumber.MAX_SAFE_INTEGER is the largestintegral Number n such thatℝ(n) andℝ(n) + 1 are both exactly representable as aNumber value.
The value ofNumber.MAX_SAFE_INTEGER is9007199254740991𝔽 (𝔽(253 - 1)).
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.1.2.7 Number.MAX_VALUE
The value ofNumber.MAX_VALUE is the largest positive finite value of the Number type, which is approximately1.7976931348623157 × 10308.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.1.2.8 Number.MIN_SAFE_INTEGER
Note
The value ofNumber.MIN_SAFE_INTEGER is the smallestintegral Number n such thatℝ(n) andℝ(n) - 1 are both exactly representable as aNumber value.
The value ofNumber.MIN_SAFE_INTEGER is-9007199254740991𝔽 (𝔽(-(253 - 1))).
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.1.2.9 Number.MIN_VALUE
The value ofNumber.MIN_VALUE is the smallest positive value of the Number type, which is approximately5 × 10-324.
In theIEEE 754-2019 double precision binary representation, the smallest possible value is a denormalized number. If an implementation does not support denormalized values, the value ofNumber.MIN_VALUE must be the smallest non-zero positive value that can actually be represented by the implementation.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.1.2.10 Number.NaN
The value ofNumber.NaN isNaN.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.1.2.11 Number.NEGATIVE_INFINITY
The value ofNumber.NEGATIVE_INFINITY is-∞𝔽.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
Unless explicitly stated otherwise, the methods of the Number prototype object defined below are not generic and thethis value passed to them must be either aNumber value or an object that has a [[NumberData]] internal slot that has been initialized to aNumber value.
The abstract operationthisNumberValue takes argumentvalue. It performs the following steps when called:
The phrase “thisNumber value” within the specification of a method refers to the result returned by calling the abstract operationthisNumberValue with thethis value of the method invocation passed as the argument.
21.1.3.1 Number.prototype.constructor
The initial value ofNumber.prototype.constructor is%Number%.
Return a String containing thisNumber value represented in decimal exponential notation with one digit before the significand's decimal point andfractionDigits digits after the significand's decimal point. IffractionDigits isundefined, include as many significand digits as necessary to uniquely specify the Number (just like inToString except that in this case the Number is always output in exponential notation). Specifically, perform the following steps:
a.Letm be the String value consisting off + 1 occurrences of the code unit 0x0030 (DIGIT ZERO).
b.Lete be 0.
10.Else,
a.IffractionDigits is notundefined, then
i.Lete andn be integers such that 10f ≤n < 10f + 1 and for whichn × 10e -n -x is as close to zero as possible. If there are two such sets ofe andn, pick thee andn for whichn × 10e -f is larger.
b.Else,
i.Lete,n, andf be integers such thatf ≥ 0, 10f ≤n < 10f + 1,n × 10e -f isx, andf is as small as possible. Note that the decimal representation ofn hasf + 1 digits,n is not divisible by 10, and the least significant digit ofn is not necessarily uniquely determined by these criteria.
c.Letm be the String value consisting of the digits of the decimal representation ofn (in order, with no leading zeroes).
For implementations that provide more accurate conversions than required by the rules above, it is recommended that the following alternative version of step10.b.i be used as a guideline:
1.Lete,n, andf be integers such thatf ≥ 0, 10f ≤n < 10f + 1,n × 10e -f isx, andf is as small as possible. If there are multiple possibilities forn, choose the value ofn for whichn × 10e -f is closest in value tox. If there are two such possible values ofn, choose the one that is even.
toFixed returns a String containing thisNumber value represented in decimal fixed-point notation withfractionDigits digits after the decimal point. IffractionDigits isundefined, 0 is assumed.
a.Letn be aninteger for whichn / 10f -x is as close to zero as possible. If there are two suchn, pick the largern.
b.Ifn = 0, letm be the String"0". Otherwise, letm be the String value consisting of the digits of the decimal representation ofn (in order, with no leading zeroes).
c.Iff ≠ 0, then
i.Letk be the length ofm.
ii.Ifk ≤f, then
1.Letz be the String value consisting off + 1 -k occurrences of the code unit 0x0030 (DIGIT ZERO).
The output oftoFixed may be more precise thantoString for some values because toString only prints enough significant digits to distinguish the number from adjacent Number values. For example,
(1000000000000000128).toString() returns"1000000000000000100", while (1000000000000000128).toFixed(0) returns"1000000000000000128".
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement theNumber.prototype.toLocaleString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleString method is used.
Produces a String value that represents thisNumber value formatted according to the conventions of thehost environment's current locale. This function isimplementation-defined, and it is permissible, but not encouraged, for it to return the same thing astoString.
The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
Return a String containing thisNumber value represented either in decimal exponential notation with one digit before the significand's decimal point andprecision - 1 digits after the significand's decimal point or in decimal fixed notation withprecision significant digits. Ifprecision isundefined, callToString instead. Specifically, perform the following steps:
a.Letm be the String value consisting ofp occurrences of the code unit 0x0030 (DIGIT ZERO).
b.Lete be 0.
10.Else,
a.Lete andn be integers such that 10p - 1 ≤n < 10p and for whichn × 10e -p + 1 -x is as close to zero as possible. If there are two such sets ofe andn, pick thee andn for whichn × 10e -p + 1 is larger.
b.Letm be the String value consisting of the digits of the decimal representation ofn (in order, with no leading zeroes).
a.Setm to thestring-concatenation of the firste + 1 code units ofm, the code unit 0x002E (FULL STOP), and the remainingp - (e + 1) code units ofm.
13.Else,
a.Setm to thestring-concatenation of the code unit 0x0030 (DIGIT ZERO), the code unit 0x002E (FULL STOP), -(e + 1) occurrences of the code unit 0x0030 (DIGIT ZERO), and the Stringm.
6.Return the String representation of thisNumber value using the radix specified byradixMV. Lettersa-z are used for digits with values 10 through 35. The precise algorithm isimplementation-defined, however the algorithm should be a generalization of that specified in6.1.6.1.20.
ThetoString function is not generic; it throws aTypeError exception if itsthis value is not a Number or a Number object. Therefore, it cannot be transferred to other kinds of objects for use as a method.
Number instances are ordinary objects that inherit properties from theNumber prototype object. Number instances also have a [[NumberData]] internal slot. The [[NumberData]] internal slot is theNumber value represented by this Number object.
is the initial value of the"BigInt" property of theglobal object.
performs a type conversion when called as a function rather than as aconstructor.
is not intended to be used with thenew operator or to be subclassed. It may be used as the value of anextends clause of a class definition but asuper call to the BigIntconstructor will cause an exception.
21.2.1.1 BigInt (value )
WhenBigInt is called with argumentvalue, the following steps are taken:
1.If NewTarget is notundefined, throw aTypeError exception.
The phrase “this BigInt value” within the specification of a method refers to the result returned by calling the abstract operationthisBigIntValue with thethis value of the method invocation passed as the argument.
21.2.3.1 BigInt.prototype.constructor
The initial value ofBigInt.prototype.constructor is%BigInt%.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement theBigInt.prototype.toLocaleString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleString method is used.
Produces a String value that represents this BigInt value formatted according to the conventions of thehost environment's current locale. This function isimplementation-defined, and it is permissible, but not encouraged, for it to return the same thing astoString.
The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
21.2.3.3 BigInt.prototype.toString ( [radix ] )
Note
The optionalradix should be anintegral Number value in the inclusive range2𝔽 to36𝔽. Ifradix isundefined then10𝔽 is used as the value ofradix.
6.Return the String representation of thisNumber value using the radix specified byradixMV. Lettersa-z are used for digits with values 10 through 35. The precise algorithm isimplementation-defined, however the algorithm should be a generalization of that specified in6.1.6.2.23.
ThetoString function is not generic; it throws aTypeError exception if itsthis value is not a BigInt or a BigInt object. Therefore, it cannot be transferred to other kinds of objects for use as a method.
does not have a [[Construct]] internal method; it cannot be used as aconstructor with thenew operator.
does not have a [[Call]] internal method; it cannot be invoked as a function.
Note
In this specification, the phrase “theNumber value forx” has a technical meaning defined in6.1.6.1.
21.3.1 Value Properties of the Math Object
21.3.1.1 Math.E
TheNumber value fore, the base of the natural logarithms, which is approximately 2.7182818284590452354.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.3.1.2 Math.LN10
TheNumber value for the natural logarithm of 10, which is approximately 2.302585092994046.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.3.1.3 Math.LN2
TheNumber value for the natural logarithm of 2, which is approximately 0.6931471805599453.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.3.1.4 Math.LOG10E
TheNumber value for the base-10 logarithm ofe, the base of the natural logarithms; this value is approximately 0.4342944819032518.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
Note
The value ofMath.LOG10E is approximately the reciprocal of the value ofMath.LN10.
21.3.1.5 Math.LOG2E
TheNumber value for the base-2 logarithm ofe, the base of the natural logarithms; this value is approximately 1.4426950408889634.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
Note
The value ofMath.LOG2E is approximately the reciprocal of the value ofMath.LN2.
21.3.1.6 Math.PI
TheNumber value for π, the ratio of the circumference of a circle to its diameter, which is approximately 3.1415926535897932.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.3.1.7 Math.SQRT1_2
TheNumber value for the square root of ½, which is approximately 0.7071067811865476.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
Note
The value ofMath.SQRT1_2 is approximately the reciprocal of the value ofMath.SQRT2.
21.3.1.8 Math.SQRT2
TheNumber value for the square root of 2, which is approximately 1.4142135623730951.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
21.3.1.9 Math [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"Math".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
21.3.2 Function Properties of the Math Object
Note
The behaviour of the functionsacos,acosh,asin,asinh,atan,atanh,atan2,cbrt,cos,cosh,exp,expm1,hypot,log,log1p,log2,log10,pow,random,sin,sinh,sqrt,tan, andtanh is not precisely specified here except to require specific results for certain argument values that represent boundary cases of interest. For other argument values, these functions are intended to compute approximations to the results of familiar mathematical functions, but some latitude is allowed in the choice of approximation algorithms. The general intent is that an implementer should be able to use the same mathematical library for ECMAScript on a given hardware platform that is available to C programmers on that platform.
Although the choice of algorithms is left to the implementation, it is recommended (but not specified by this standard) that implementations use the approximation algorithms forIEEE 754-2019 arithmetic contained infdlibm, the freely distributable mathematical library from Sun Microsystems (http://www.netlib.org/fdlibm).
21.3.2.1 Math.abs (x )
Returns the absolute value ofx; the result has the same magnitude asx but has positive sign.
When theMath.abs method is called with argumentx, the following steps are taken:
Returns the inverse tangent of the quotienty /x of the argumentsy andx, where the signs ofy andx are used to determine the quadrant of the result. Note that it is intentional and traditional for the two-argument inverse tangent function that the argument namedy be first and the argument namedx be second. The result is expressed in radians and ranges from -π to +π, inclusive.
When theMath.atan2 method is called with argumentsy andx, the following steps are taken:
Returns the result of subtracting 1 from the exponential function ofx (e raised to the power ofx, wheree is the base of the natural logarithms). The result is computed in a way that is accurate even when the value ofx is close to 0.
When theMath.expm1 method is called with argumentx, the following steps are taken:
c.Ifnumber is neither+0𝔽 nor-0𝔽, setonlyZero tofalse.
5.IfonlyZero istrue, return+0𝔽.
6.Return animplementation-approximated value representing the square root of the sum of squares of the mathematical values of the elements ofcoerced.
The"length" property of thehypot method is2𝔽.
Note
Implementations should take care to avoid the loss of precision from overflows and underflows that are prone to occur in naive implementations when this function is called with two or more arguments.
21.3.2.19 Math.imul (x,y )
WhenMath.imul is called with argumentsx andy, the following steps are taken:
The comparison of values to determine the largest value is done using theAbstract Relational Comparison algorithm except that+0𝔽 is considered to be larger than-0𝔽.
The"length" property of themax method is2𝔽.
21.3.2.25 Math.min ( ...args )
Given zero or more arguments, callsToNumber on each of the arguments and returns the smallest of the resulting values.
When theMath.min method is called with zero or more arguments which form the rest parameter ...args, the following steps are taken:
The comparison of values to determine the largest value is done using theAbstract Relational Comparison algorithm except that+0𝔽 is considered to be larger than-0𝔽.
The"length" property of themin method is2𝔽.
21.3.2.26 Math.pow (base,exponent )
When theMath.pow method is called with argumentsbase andexponent, the following steps are taken:
Returns aNumber value with positive sign, greater than or equal to+0𝔽 but strictly less than1𝔽, chosen randomly or pseudo randomly with approximately uniform distribution over that range, using animplementation-defined algorithm or strategy. This function takes no arguments.
EachMath.random function created for distinct realms must produce a distinct sequence of values from successive calls.
21.3.2.28 Math.round (x )
Returns theNumber value that is closest tox and is integral. If two integral Numbers are equally close tox, then the result is theNumber value that is closer to +∞. Ifx is already integral, the result isx.
When theMath.round method is called with argumentx, the following steps are taken:
The value ofMath.round(x) is not always the same as the value ofMath.floor(x + 0.5). Whenx is-0𝔽 or is less than+0𝔽 but greater than or equal to-0.5𝔽,Math.round(x) returns-0𝔽, butMath.floor(x + 0.5) returns+0𝔽.Math.round(x) may also differ from the value ofMath.floor(x + 0.5)because of internal rounding when computingx + 0.5.
21.3.2.29 Math.sign (x )
Returns the sign ofx, indicating whetherx is positive, negative, or zero.
When theMath.sign method is called with argumentx, the following steps are taken:
5.Return theintegral Number nearestn in the direction of+0𝔽.
21.4 Date Objects
21.4.1 Overview of Date Objects and Definitions of Abstract Operations
The following functions areabstract operations that operate on time values (defined in21.4.1.1). Note that, in every case, if any argument to one of these functions isNaN, the result will beNaN.
21.4.1.1 Time Values and Time Range
Time measurement in ECMAScript is analogous to time measurement in POSIX, in particular sharing definition in terms of the proleptic Gregorian calendar, an epoch of midnight at the beginning of 1 January 1970 UTC, and an accounting of every day as comprising exactly 86,400 seconds (each of which is 1000 milliseconds long).
An ECMAScripttime value is a Number, either a finiteintegral Number representing an instant in time to millisecond precision orNaN representing no specific instant. A time value that is a multiple of24 × 60 × 60 × 1000 = 86,400,000 (i.e., is equal to 86,400,000 ×d for someintegerd) represents the instant at the start of the UTC day that follows the epoch byd whole UTC days (preceding the epoch for negatived). Every other finite time valuet is defined relative to the greatest preceding time values that is such a multiple, and represents the instant that occurs within the same UTC day ass but follows it byt −s milliseconds.
Time values do not account for UTC leap seconds—there are no time values representing instants within positive leap seconds, and there are time values representing instants removed from the UTC timeline by negative leap seconds. However, the definition of time values nonetheless yields piecewise alignment with UTC, with discontinuities only at leap second boundaries and zero difference outside of leap seconds.
A Number can exactly represent all integers from -9,007,199,254,740,992 to 9,007,199,254,740,992 (21.1.2.8 and21.1.2.6). A time value supports a slightly smaller range of -8,640,000,000,000,000 to 8,640,000,000,000,000 milliseconds. This yields a supported time value range of exactly -100,000,000 days to 100,000,000 days relative to midnight at the beginning of 1 January 1970 UTC.
The exact moment of midnight at the beginning of 1 January 1970 UTC is represented by the time value+0𝔽.
Note
The 400 year cycle of the proleptic Gregorian calendar contains 97 leap years. This yields an average of 365.2425 days per year, which is 31,556,952,000 milliseconds. Therefore, the maximum range a Number could represent exactly with millisecond precision is approximately -285,426 to 285,426 years relative to 1970. The smaller range supported by a time value as specified in this section is approximately -273,790 to 273,790 years relative to 1970.
ECMAScript uses a proleptic Gregorian calendar to map a day number to a year number and to determine the month and date within that year. In this calendar, leap years are precisely those which are (divisible by 4) and ((not divisible by 100) or (divisible by 400)). The number of days in year numbery is therefore defined by
All non-leap years have 365 days with the usual number of days per month and leap years have an extra day in February. The day number of the first day of yeary is given by:
Months are identified by anintegral Number in the range+0𝔽 to11𝔽, inclusive. The mappingMonthFromTime(t) from atime valuet to a month number is defined by:
A month value of+0𝔽 specifies January;1𝔽 specifies February;2𝔽 specifies March;3𝔽 specifies April;4𝔽 specifies May;5𝔽 specifies June;6𝔽 specifies July;7𝔽 specifies August;8𝔽 specifies September;9𝔽 specifies October;10𝔽 specifies November; and11𝔽 specifies December. Note thatMonthFromTime(+0𝔽) =+0𝔽, corresponding to Thursday, 1 January 1970.
21.4.1.5 Date Number
A date number is identified by anintegral Number in the range1𝔽 through31𝔽, inclusive. The mapping DateFromTime(t) from atime valuet to a date number is defined by:
A weekday value of+0𝔽 specifies Sunday;1𝔽 specifies Monday;2𝔽 specifies Tuesday;3𝔽 specifies Wednesday;4𝔽 specifies Thursday;5𝔽 specifies Friday; and6𝔽 specifies Saturday. Note thatWeekDay(+0𝔽) =4𝔽, corresponding to Thursday, 1 January 1970.
21.4.1.7 LocalTZA (t,isUTC )
LocalTZA(t,isUTC ) is animplementation-defined algorithm that returns anintegral Number representing the local time zone adjustment, or offset, in milliseconds. The local political rules for standard time and daylight saving time in effect att should be used to determine the result in the way specified in this section.
WhenisUTC is true,LocalTZA(tUTC, true ) should return the offset of the local time zone from UTC measured in milliseconds at time represented bytime valuetUTC. When the result is added totUTC, it should yield the corresponding Numbertlocal.
WhenisUTC is false,LocalTZA(tlocal, false ) should return the offset of the local time zone from UTC measured in milliseconds at local time represented by Numbertlocal. When the result is subtracted fromtlocal, it should yield the correspondingtime valuetUTC.
Inputt is nominally atime value but may be anyNumber value. This can occur whenisUTC is false andtlocal represents atime value that is already offset outside of thetime value range at the range boundaries. The algorithm must not limittlocal to thetime value range, so that such inputs are supported.
Whentlocal represents local time repeating multiple times at a negative time zone transition (e.g. when the daylight saving time ends or the time zone offset is decreased due to a time zone rule change) or skipped local time at a positive time zone transitions (e.g. when the daylight saving time starts or the time zone offset is increased due to a time zone rule change),tlocal must be interpreted using the time zone offset before the transition.
If an implementation does not support a conversion described above or if political rules for timet are not available within the implementation, the result must be+0𝔽.
Note
It is recommended that implementations use the time zone information of the IANA Time Zone Databasehttps://www.iana.org/time-zones/.
1:30 AM on 5 November 2017 in America/New_York is repeated twice (fall backward), but it must be interpreted as 1:30 AM UTC-04 instead of 1:30 AM UTC-05. LocalTZA(TimeClip(MakeDate(MakeDay(2017, 10, 5),MakeTime(1, 30, 0, 0))), false) is-4 ×msPerHour.
2:30 AM on 12 March 2017 in America/New_York does not exist, but it must be interpreted as 2:30 AM UTC-05 (equivalent to 3:30 AM UTC-04). LocalTZA(TimeClip(MakeDate(MakeDay(2017, 2, 12),MakeTime(2, 30, 0, 0))), false) is-5 ×msPerHour.
Local time zone offset values may be positiveor negative.
21.4.1.8 LocalTime (t )
The abstract operation LocalTime takes argumentt. It convertst from UTC to local time. It performs the following steps when called:
Two different input time valuestUTC are converted to the same local timetlocal at a negative time zone transition when there are repeated times (e.g. the daylight saving time ends or the time zone adjustment is decreased.).
LocalTime(UTC(tlocal)) is not necessarily always equal totlocal. Correspondingly,UTC(LocalTime(tUTC)) is not necessarily always equal totUTC.
21.4.1.9 UTC (t )
The abstract operation UTC takes argumentt. It convertst from local time to UTC. It performs the following steps when called:
The abstract operation MakeTime takes argumentshour (a Number),min (a Number),sec (a Number), andms (a Number). It calculates a number of milliseconds. It performs the following steps when called:
1.Ifhour is not finite ormin is not finite orsec is not finite orms is not finite, returnNaN.
The abstract operation MakeDay takes argumentsyear (a Number),month (a Number), anddate (a Number). It calculates a number of days. It performs the following steps when called:
1.Ifyear is not finite ormonth is not finite ordate is not finite, returnNaN.
The abstract operation MakeDate takes argumentsday (a Number) andtime (a Number). It calculates a number of milliseconds. It performs the following steps when called:
1.Ifday is not finite ortime is not finite, returnNaN.
ECMAScript defines a string interchange format for date-times based upon a simplification of the ISO 8601 calendar date extended format. The format is as follows:YYYY-MM-DDTHH:mm:ss.sssZ
Where the elements are as follows:
YYYY
is the year in the proleptic Gregorian calendar as four decimal digits from 0000 to 9999, or as anexpanded year of"+" or"-" followed by six decimal digits.
-
"-" (hyphen) appears literally twice in the string.
MM
is the month of the year as two decimal digits from 01 (January) to 12 (December).
DD
is the day of the month as two decimal digits from 01 to 31.
T
"T" appears literally in the string, to indicate the beginning of the time element.
HH
is the number of complete hours that have passed since midnight as two decimal digits from 00 to 24.
:
":" (colon) appears literally twice in the string.
mm
is the number of complete minutes since the start of the hour as two decimal digits from 00 to 59.
ss
is the number of complete seconds since the start of the minute as two decimal digits from 00 to 59.
.
"." (dot) appears literally in the string.
sss
is the number of complete milliseconds since the start of the second as three decimal digits.
Z
is the UTC offset representation specified as"Z" (for UTC with no offset) or an offset of either"+" or"-" followed by a time expressionHH:mm (indicating local time ahead of or behind UTC, respectively)
This format includes date-only forms:
YYYYYYYY-MMYYYY-MM-DD
It also includes “date-time” forms that consist of one of the above date-only forms immediately followed by one of the following time forms with an optional UTC offset representation appended:
THH:mmTHH:mm:ssTHH:mm:ss.sss
A string containing out-of-bounds or nonconforming elements is not a valid instance of this format.
Note 1
As every day both starts and ends with midnight, the two notations00:00 and24:00 are available to distinguish the two midnights that can be associated with one date. This means that the following two notations refer to exactly the same point in time:1995-02-04T24:00 and1995-02-05T00:00. This interpretation of the latter form as "end of a calendar day" is consistent with ISO 8601, even though that specification reserves it for describing time intervals and does not permit it within representations of single points in time.
Note 2
There exists no international standard that specifies abbreviations for civil time zones like CET, EST, etc. and sometimes the same abbreviation is even used for two very different time zones. For this reason, both ISO 8601 and this format specify numeric representations of time zone offsets.
21.4.1.15.1 Expanded Years
Covering the fulltime value range of approximately 273,790 years forward or backward from 1 January 1970 (21.4.1.1) requires representing years before 0 or after 9999. ISO 8601 permits expansion of the year representation, but only by mutual agreement of the partners in information interchange. In the simplified ECMAScript format, such an expanded year representation shall have 6 digits and is always prefixed with a + or - sign. The year 0 is considered positive and hence prefixed with a + sign. Strings matching theDate Time String Format with expanded years representing instants in time outside the range of atime value are treated as unrecognizable byDate.parse and cause that function to returnNaN without falling back to implementation-specific behaviour or heuristics.
is the initial value of the"Date" property of theglobal object.
creates and initializes a new Date object when called as aconstructor.
returns a String representing the current time (UTC) when called as a function rather than as aconstructor.
is a function whose behaviour differs based upon the number and types of its arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified Date behaviour must include asuper call to the Dateconstructor to create and initialize the subclass instance with a [[DateValue]] internal slot.
has a"length" property whose value is7𝔽.
21.4.2.1 Date ( ...values )
When theDate function is called, the following steps are taken:
1.If NewTarget isundefined, then
a.Letnow be thetime value (UTC) identifying the current time.
Thenow function returns thetime value designating the UTC date and time of the occurrence of the call tonow.
21.4.3.2 Date.parse (string )
Theparse function applies theToString operator to its argument. IfToString results in anabrupt completion theCompletion Record is immediately returned. Otherwise,parse interprets the resulting String as a date and time; it returns a Number, the UTCtime value corresponding to the date and time. The String may be interpreted as a local time, a UTC time, or a time in some other time zone, depending on the contents of the String. The function first attempts to parse the String according to the format described in Date Time String Format (21.4.1.15), including expanded years. If the String does not conform to that format the function may fall back to any implementation-specific heuristics or implementation-specific date formats. Strings that are unrecognizable or contain out-of-bounds format element values shall causeDate.parse to returnNaN.
If the String conforms to theDate Time String Format, substitute values take the place of absent format elements. When theMM orDD elements are absent,"01" is used. When theHH,mm, orss elements are absent,"00" is used. When thesss element is absent,"000" is used. When the UTC offset representation is absent, date-only forms are interpreted as a UTC time and date-time forms are interpreted as a local time.
Ifx is any Date object whose milliseconds amount is zero within a particular implementation of ECMAScript, then all of the following expressions should produce the same numeric value in that implementation, if all the properties referenced have their initial values:
is not required to produce the sameNumber value as the preceding three expressions and, in general, the value produced byDate.parse isimplementation-defined when given any String value that does not conform to the Date Time String Format (21.4.1.15) and that could not be produced in that implementation by thetoString ortoUTCString method.
TheUTC function differs from the Dateconstructor in two ways: it returns atime value as a Number, rather than creating a Date object, and it interprets the arguments in UTC rather than as local time.
Unless explicitly defined otherwise, the methods of the Date prototype object defined below are not generic and thethis value passed to them must be an object that has a [[DateValue]] internal slot that has been initialized to atime value.
The abstract operationthisTimeValue takes argumentvalue. It performs the following steps when called:
1.IfType(value) is Object andvalue has a [[DateValue]] internal slot, then
a.Returnvalue.[[DateValue]].
2.Throw aTypeError exception.
In following descriptions of functions that are properties of the Date prototype object, the phrase “this Date object” refers to the object that is thethis value for the invocation of the function. If the Type of thethis value is not Object, aTypeError exception is thrown. The phrase “this time value” within the specification of a method refers to the result returned by calling the abstract operationthisTimeValue with thethis value of the method invocation passed as the argument.
21.4.4.1 Date.prototype.constructor
The initial value ofDate.prototype.constructor is%Date%.
The"length" property of thesetFullYear method is3𝔽.
Note
Ifmonth is not present, this method behaves as ifmonth was present with the valuegetMonth(). Ifdate is not present, it behaves as ifdate was present with the valuegetDate().
Ifmin is not present, this method behaves as ifmin was present with the valuegetMinutes(). Ifsec is not present, it behaves as ifsec was present with the valuegetSeconds(). Ifms is not present, it behaves as ifms was present with the valuegetMilliseconds().
The"length" property of thesetMinutes method is3𝔽.
Note
Ifsec is not present, this method behaves as ifsec was present with the valuegetSeconds(). Ifms is not present, this behaves as ifms was present with the valuegetMilliseconds().
The"length" property of thesetUTCFullYear method is3𝔽.
Note
Ifmonth is not present, this method behaves as ifmonth was present with the valuegetUTCMonth(). Ifdate is not present, it behaves as ifdate was present with the valuegetUTCDate().
The"length" property of thesetUTCHours method is4𝔽.
Note
Ifmin is not present, this method behaves as ifmin was present with the valuegetUTCMinutes(). Ifsec is not present, it behaves as ifsec was present with the valuegetUTCSeconds(). Ifms is not present, it behaves as ifms was present with the valuegetUTCMilliseconds().
The"length" property of thesetUTCMinutes method is3𝔽.
Note
Ifsec is not present, this method behaves as ifsec was present with the valuegetUTCSeconds(). Ifms is not present, it function behaves as ifms was present with the value return bygetUTCMilliseconds().
Ifthis time value is not a finite Number or if it corresponds with a year that cannot be represented in theDate Time String Format, this function throws aRangeError exception. Otherwise, it returns a String representation ofthis time value in that format on the UTC time scale, including all format elements and the UTC offset representation"Z".
21.4.4.37 Date.prototype.toJSON (key )
This function provides a String representation of a Date object for use byJSON.stringify (25.5.2).
When thetoJSON method is called with argumentkey, the following steps are taken:
ThetoJSON function is intentionally generic; it does not require that itsthis value be a Date object. Therefore, it can be transferred to other kinds of objects for use as a method. However, it does require that any such object have atoISOString method.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement theDate.prototype.toLocaleDateString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleDateString method is used.
This function returns a String value. The contents of the String areimplementation-defined, but are intended to represent the “date” portion of the Date in the current time zone in a convenient, human-readable form that corresponds to the conventions of thehost environment's current locale.
The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement theDate.prototype.toLocaleString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleString method is used.
This function returns a String value. The contents of the String areimplementation-defined, but are intended to represent the Date in the current time zone in a convenient, human-readable form that corresponds to the conventions of thehost environment's current locale.
The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement theDate.prototype.toLocaleTimeString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleTimeString method is used.
This function returns a String value. The contents of the String areimplementation-defined, but are intended to represent the “time” portion of the Date in the current time zone in a convenient, human-readable form that corresponds to the conventions of thehost environment's current locale.
The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
For any Date objectd such thatd.[[DateValue]] is evenly divisible by 1000, the result ofDate.parse(d.toString()) =d.valueOf(). See21.4.3.2.
Note 2
ThetoString function is not generic; it throws aTypeError exception if itsthis value is not a Date object. Therefore, it cannot be transferred to other kinds of objects for use as a method.
21.4.4.41.1 TimeString (tv )
The abstract operation TimeString takes argumenttv. It performs the following steps when called:
3.Lethour be the String representation ofHourFromTime(tv), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
4.Letminute be the String representation ofMinFromTime(tv), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
5.Letsecond be the String representation ofSecFromTime(tv), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
6.Return thestring-concatenation ofhour,":",minute,":",second, the code unit 0x0020 (SPACE), and"GMT".
21.4.4.41.2 DateString (tv )
The abstract operation DateString takes argumenttv. It performs the following steps when called:
5.Letday be the String representation ofDateFromTime(tv), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
7.Ifyv ≥+0𝔽, letyearSign be the empty String; otherwise, letyearSign be"-".
8.Letyear be the String representation ofabs(ℝ(yv)), formatted as a decimal number.
9.LetpaddedYear be ! StringPad(year,4𝔽,"0",start).
10.Return thestring-concatenation ofweekday, the code unit 0x0020 (SPACE),month, the code unit 0x0020 (SPACE),day, the code unit 0x0020 (SPACE),yearSign, andpaddedYear.
Table 52: Names of days of the week
Number
Name
+0𝔽
"Sun"
1𝔽
"Mon"
2𝔽
"Tue"
3𝔽
"Wed"
4𝔽
"Thu"
5𝔽
"Fri"
6𝔽
"Sat"
Table 53: Names of months of the year
Number
Name
+0𝔽
"Jan"
1𝔽
"Feb"
2𝔽
"Mar"
3𝔽
"Apr"
4𝔽
"May"
5𝔽
"Jun"
6𝔽
"Jul"
7𝔽
"Aug"
8𝔽
"Sep"
9𝔽
"Oct"
10𝔽
"Nov"
11𝔽
"Dec"
21.4.4.41.3 TimeZoneString (tv )
The abstract operation TimeZoneString takes argumenttv. It performs the following steps when called:
6.LetoffsetMin be the String representation ofMinFromTime(absOffset), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
7.LetoffsetHour be the String representation ofHourFromTime(absOffset), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
8.LettzName be animplementation-defined string that is either the empty String or thestring-concatenation of the code unit 0x0020 (SPACE), the code unit 0x0028 (LEFT PARENTHESIS), animplementation-defined timezone name, and the code unit 0x0029 (RIGHT PARENTHESIS).
ThetoUTCString method returns a String value representing the instance in time corresponding tothis time value. The format of the String is based upon "HTTP-date" from RFC 7231, generalized to support the full range of times supported by ECMAScript Date objects. It performs the following steps when called:
6.Letday be the String representation ofDateFromTime(tv), formatted as a two-digit decimal number, padded to the left with the code unit 0x0030 (DIGIT ZERO) if necessary.
8.Ifyv ≥+0𝔽, letyearSign be the empty String; otherwise, letyearSign be"-".
9.Letyear be the String representation ofabs(ℝ(yv)), formatted as a decimal number.
10.LetpaddedYear be ! StringPad(year,4𝔽,"0",start).
11.Return thestring-concatenation ofweekday,",", the code unit 0x0020 (SPACE),day, the code unit 0x0020 (SPACE),month, the code unit 0x0020 (SPACE),yearSign,paddedYear, the code unit 0x0020 (SPACE), andTimeString(tv).
This function is called by ECMAScript language operators to convert a Date object to a primitive value. The allowed values forhint are"default","number", and"string". Date objects, are unique among built-in ECMAScript object in that they treat"default" as being equivalent to"string", All other built-in ECMAScript objects treat"default" as being equivalent to"number".
When the@@toPrimitive method is called with argumenthint, the following steps are taken:
1.LetO be thethis value.
2.IfType(O) is not Object, throw aTypeError exception.
The value of the"name" property of this function is"[Symbol.toPrimitive]".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
21.4.5 Properties of Date Instances
Date instances are ordinary objects that inherit properties from theDate prototype object. Date instances also have a [[DateValue]] internal slot. The [[DateValue]] internal slot is thetime value represented bythis Date object.
is the initial value of the"String" property of theglobal object.
creates and initializes a new String object when called as aconstructor.
performs a type conversion when called as a function rather than as aconstructor.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified String behaviour must include asuper call to the Stringconstructor to create and initialize the subclass instance with a [[StringData]] internal slot.
22.1.1.1 String (value )
WhenString is called with argumentvalue, the following steps are taken:
1.Ifvalue is not present, lets be the empty String.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
22.1.2.4 String.raw (template, ...substitutions )
TheString.raw function may be called with a variable number of arguments. The first argument istemplate and the remainder of the arguments form theListsubstitutions. The following steps are taken:
1.LetnumberOfSubstitutions be the number of elements insubstitutions.
h.Append the code unit elements ofnextSub to the end ofstringElements.
i.SetnextIndex tonextIndex + 1.
Note
Theraw function is intended for use as a tag function of a Tagged Template (13.3.11). When called as such, the first argument will be a well formed template object and the rest parameter will contain the substitution values.
22.1.3 Properties of the String Prototype Object
TheString prototype object:
is%String.prototype%.
is aString exotic object and has the internal methods specified for such objects.
has a [[StringData]] internal slot whose value is the empty String.
has a"length" property whose initial value is+0𝔽 and whose attributes are { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
Unless explicitly stated otherwise, the methods of the String prototype object defined below are not generic and thethis value passed to them must be either a String value or an object that has a [[StringData]] internal slot that has been initialized to a String value.
The abstract operationthisStringValue takes argumentvalue. It performs the following steps when called:
Returns a single element String containing the code unit at indexpos within the String value resulting from converting this object to a String. If there is no element at that index, the result is the empty String. The result is a String value, not a String object.
Ifpos is anintegral Number, then the result ofx.charAt(pos) is equivalent to the result ofx.substring(pos, pos + 1).
When thecharAt method is called with one argumentpos, the following steps are taken:
5.Ifposition < 0 orposition ≥size, return the empty String.
6.Return the String value of length 1, containing one code unit fromS, namely the code unit at indexposition.
Note 2
ThecharAt function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.2 String.prototype.charCodeAt (pos )
Note 1
Returns a Number (a non-negativeintegral Number less than 216) that is the numeric value of the code unit at indexpos within the String resulting from converting this object to a String. If there is no element at that index, the result isNaN.
When thecharCodeAt method is called with one argumentpos, the following steps are taken:
6.Return theNumber value for the numeric value of the code unit at indexposition within the StringS.
Note 2
ThecharCodeAt function is intentionally generic; it does not require that itsthis value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.
22.1.3.3 String.prototype.codePointAt (pos )
Note 1
Returns a non-negativeintegral Number less than or equal to0x10FFFF𝔽 that is the code point value of the UTF-16 encoded code point (6.1.4) starting at the string element at indexpos within the String resulting from converting this object to a String. If there is no element at that index, the result isundefined. If a valid UTF-16surrogate pair does not begin atpos, the result is the code unit atpos.
When thecodePointAt method is called with one argumentpos, the following steps are taken:
ThecodePointAt function is intentionally generic; it does not require that itsthis value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.
22.1.3.4 String.prototype.concat ( ...args )
Note 1
When theconcat method is called it returns the String value consisting of the code units of thethis value (converted to a String) followed by the code units of each of the arguments converted to a String. The result is a String value, not a String object.
When theconcat method is called with zero or more arguments, the following steps are taken:
Theconcat function is intentionally generic; it does not require that itsthis value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.
22.1.3.5 String.prototype.constructor
The initial value ofString.prototype.constructor is%String%.
Returnstrue if the sequence of code units ofsearchString converted to a String is the same as the corresponding code units of this object (converted to a String) starting atendPosition - length(this). Otherwise returnsfalse.
Note 2
Throwing an exception if the first argument is a RegExp is specified in order to allow future editions to define extensions that allow such argument values.
Note 3
TheendsWith function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
IfsearchString appears as asubstring of the result of converting this object to a String, at one or more indices that are greater than or equal toposition, returntrue; otherwise, returnsfalse. Ifposition isundefined, 0 is assumed, so as to search all of the String.
Note 2
Throwing an exception if the first argument is a RegExp is specified in order to allow future editions to define extensions that allow such argument values.
Note 3
Theincludes function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
IfsearchString appears as asubstring of the result of converting this object to a String, at one or more indices that are greater than or equal toposition, then the smallest such index is returned; otherwise,-1𝔽 is returned. Ifposition isundefined,+0𝔽 is assumed, so as to search all of the String.
TheindexOf method takes two arguments,searchString andposition, and performs the following steps:
TheindexOf function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
IfsearchString appears as asubstring of the result of converting this object to a String at one or more indices that are smaller than or equal toposition, then the greatest such index is returned; otherwise,-1𝔽 is returned. Ifposition isundefined, the length of the String value is assumed, so as to search all of the String.
ThelastIndexOf method takes two arguments,searchString andposition, and performs the following steps:
6.IfnumPos isNaN, letpos be +∞; otherwise, letpos be ! ToIntegerOrInfinity(numPos).
7.Letlen be the length ofS.
8.Letstart be the result ofclampingpos between 0 andlen.
9.LetsearchLen be the length ofsearchStr.
10.Letk be the largest possible non-negativeinteger not larger thanstart such thatk +searchLen ≤len, and for all non-negative integersj such thatj <searchLen, the code unit at indexk +j withinS is the same as the code unit at indexj withinsearchStr; but if there is no suchinteger, letk be -1.
ThelastIndexOf function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement thelocaleCompare method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thelocaleCompare method is used.
When thelocaleCompare method is called with argumentthat, it returns a Number other thanNaN that represents the result of a locale-sensitive String comparison of thethis value (converted to a String) withthat (converted to a String). The two Strings areS andThat. The two Strings are compared in animplementation-defined fashion. The result is intended to order String values in the sort order specified by ahost default locale, and will be negative, zero, or positive, depending on whetherS comes beforeThat in the sort order, the Strings are equal, orS comes afterThat in the sort order, respectively.
Before performing the comparisons, the following steps are performed to prepare the Strings:
The meaning of the optional second and third parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not assign any other interpretation to those parameter positions.
ThelocaleCompare method, if considered as a function of two argumentsthis andthat, is a consistent comparison function (as defined in23.1.3.27) on the set of all Strings.
The actual return values areimplementation-defined to permit implementers to encode additional information in the value, but the function is required to define a total ordering on all Strings. This function must treat Strings that are canonically equivalent according to the Unicode standard as identical and must return0 when comparing Strings that are considered canonically equivalent.
Note 1
ThelocaleCompare method itself is not directly suitable as an argument toArray.prototype.sort because the latter requires a function of two arguments.
Note 2
This function is intended to rely on whatever language-sensitive comparison functionality is available to the ECMAScript environment from thehost environment, and to compare according to the rules of thehost environment's current locale. However, regardless of thehost provided comparison capabilities, this function must treat Strings that are canonically equivalent according to the Unicode standard as identical. It is recommended that this function should not honour Unicode compatibility equivalences or decompositions. For a definition and discussion of canonical equivalence see the Unicode Standard, chapters 2 and 3, as well as Unicode Standard Annex #15, Unicode Normalization Forms (https://unicode.org/reports/tr15/) and Unicode Technical Note #5, Canonical Equivalence in Applications (https://www.unicode.org/notes/tn5/). Also see Unicode Technical Standard #10, Unicode Collation Algorithm (https://unicode.org/reports/tr10/).
Note 3
ThelocaleCompare function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.11 String.prototype.match (regexp )
When thematch method is called with argumentregexp, the following steps are taken:
Thematch function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.12 String.prototype.matchAll (regexp )
Performs a regular expression match of the String representing thethis value againstregexp and returns an iterator. Each iteration result's value is an Array object containing the results of the match, ornull if the String did not match.
When thematchAll method is called, the following steps are taken:
ThematchAll function is intentionally generic, it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
Note 2
Similarly toString.prototype.split,String.prototype.matchAll is designed to typically act without mutating its inputs.
22.1.3.13 String.prototype.normalize ( [form ] )
When thenormalize method is called with one argumentform, the following steps are taken:
5.Iff is not one of"NFC","NFD","NFKC", or"NFKD", throw aRangeError exception.
6.Letns be the String value that is the result of normalizingS into the normalization form named byf as specified inhttps://unicode.org/reports/tr15/.
7.Returnns.
Note
Thenormalize function is intentionally generic; it does not require that itsthis value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.
6.Return the String value that is made fromn copies ofS appended together.
Note 1
This method creates the String value consisting of the code units of thethis value (converted to String) repeatedcount times.
Note 2
Therepeat function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
Thereplace function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
The abstract operation GetSubstitution takes argumentsmatched,str,position (a non-negativeinteger),captures,namedCaptures, andreplacement. It performs the following steps when called:
10.Letresult be the String value derived fromreplacement by copying code unit elements fromreplacement toresult while performing replacements as specified inTable 54. These$ replacements are done left-to-right, and, once such a replacement is performed, the new replacement text is not subject to further replacements.
11.Returnresult.
Table 54: Replacement Text Symbol Substitutions
Code units
Unicode Characters
Replacement text
0x0024, 0x0024
$$
$
0x0024, 0x0026
$&
matched
0x0024, 0x0060
$`
The replacement is thesubstring ofstr from 0 toposition.
0x0024, 0x0027
$'
IftailPos ≥stringLength, the replacement is the empty String. Otherwise the replacement is thesubstring ofstr fromtailPos.
0x0024, N Where 0x0031 ≤ N ≤ 0x0039
$n where n is one of1 2 3 4 5 6 7 8 9 and$n is not followed by a decimal digit
Thenth element ofcaptures, wheren is a single digit in the range 1 to 9. Ifn ≤m and thenth element ofcaptures isundefined, use the empty String instead. Ifn >m, no replacement is done.
0x0024, N, N Where 0x0030 ≤ N ≤ 0x0039
$nn where n is one of0 1 2 3 4 5 6 7 8 9
Thennth element ofcaptures, wherenn is a two-digit decimal number in the range 01 to 99. Ifnn ≤m and thennth element ofcaptures isundefined, use the empty String instead. Ifnn is 00 ornn >m, no replacement is done.
0x0024, 0x003C
$<
1.IfnamedCaptures isundefined, the replacement text is the String"$<".
Thesearch function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.20 String.prototype.slice (start,end )
Theslice method takes two arguments,start andend, and returns asubstring of the result of converting this object to a String, starting from indexstart and running to, but not including, indexend (or through the end of the String ifend isundefined). Ifstart is negative, it is treated assourceLength +start wheresourceLength is the length of the String. Ifend is negative, it is treated assourceLength +end wheresourceLength is the length of the String. The result is a String value, not a String object. The following steps are taken:
Theslice function is intentionally generic; it does not require that itsthis value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.
Returns an Array object into which substrings of the result of converting this object to a String have been stored. The substrings are determined by searching from left to right for occurrences ofseparator; these occurrences are not part of any String in the returned array, but serve to divide up the String value. The value ofseparator may be a String of any length or it may be an object, such as a RegExp, that has a@@split method.
When thesplit method is called, the following steps are taken:
The value ofseparator may be an empty String. In this case,separator does not match the emptysubstring at the beginning or end of the input String, nor does it match the emptysubstring at the end of the previous separator match. Ifseparator is the empty String, the String is split up into individual code unit elements; the length of the result array equals the length of the String, and eachsubstring contains one code unit.
If thethis value is (or converts to) the empty String, the result depends on whetherseparator can match the empty String. If it can, the result array contains no elements. Otherwise, the result array contains one element, which is the empty String.
Ifseparator isundefined, then the result array contains just one String, which is thethis value (converted to a String). Iflimit is notundefined, then the output array is truncated so that it contains no more thanlimit elements.
Note 2
Thesplit function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.21.1 SplitMatch (S,q,R )
The abstract operation SplitMatch takes argumentsS (a String),q (a non-negativeinteger), andR (a String). It returns eithernot-matched or the end index of a match. It performs the following steps when called:
1.Letr be the number of code units inR.
2.Lets be the number of code units inS.
3.Ifq +r >s, returnnot-matched.
4.If there exists anintegeri between 0 (inclusive) andr (exclusive) such that the code unit at indexq +i withinS is different from the code unit at indexi withinR, returnnot-matched.
This method returnstrue if the sequence of code units ofsearchString converted to a String is the same as the corresponding code units of this object (converted to a String) starting at indexposition. Otherwise returnsfalse.
Note 2
Throwing an exception if the first argument is a RegExp is specified in order to allow future editions to define extensions that allow such argument values.
Note 3
ThestartsWith function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.23 String.prototype.substring (start,end )
Thesubstring method takes two arguments,start andend, and returns asubstring of the result of converting this object to a String, starting from indexstart and running to, but not including, indexend of the String (or through the end of the String ifend isundefined). The result is a String value, not a String object.
If either argument isNaN or negative, it is replaced with zero; if either argument is larger than the length of the String, it is replaced with the length of the String.
Thesubstring function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement thetoLocaleLowerCase method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleLowerCase method is used.
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4.
This function works exactly the same astoLowerCase except that its result is intended to yield the correct result for thehost environment's current locale, rather than a locale-independent result. There will only be a difference in the few cases (such as Turkish) where the rules for that language conflict with the regular Unicode case mappings.
The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
Note
ThetoLocaleLowerCase function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement thetoLocaleUpperCase method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleUpperCase method is used.
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4.
This function works exactly the same astoUpperCase except that its result is intended to yield the correct result for thehost environment's current locale, rather than a locale-independent result. There will only be a difference in the few cases (such as Turkish) where the rules for that language conflict with the regular Unicode case mappings.
The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
Note
ThetoLocaleUpperCase function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.26 String.prototype.toLowerCase ( )
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4. The following steps are taken:
The result must be derived according to the locale-insensitive case mappings in the Unicode Character Database (this explicitly includes not only the UnicodeData.txt file, but also all locale-insensitive mappings in the SpecialCasings.txt file that accompanies it).
Note 1
The case mapping of some code points may produce multiple code points. In this case the result String may not be the same length as the source String. Because bothtoUpperCase andtoLowerCase have context-sensitive behaviour, the functions are not symmetrical. In other words,s.toUpperCase().toLowerCase() is not necessarily equal tos.toLowerCase().
Note 2
ThetoLowerCase function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.27 String.prototype.toString ( )
When thetoString method is called, the following steps are taken:
For a String object, thetoString method happens to return the same thing as thevalueOf method.
22.1.3.28 String.prototype.toUpperCase ( )
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4.
This function behaves in exactly the same way asString.prototype.toLowerCase, except that the String is mapped using the toUppercase algorithm of the Unicode Default Case Conversion.
Note
ThetoUpperCase function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.29 String.prototype.trim ( )
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4.
Thetrim function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.29.1 TrimString (string,where )
The abstract operation TrimString takes argumentsstring andwhere. It interpretsstring as a sequence of UTF-16 encoded code points, as described in6.1.4. It performs the following steps when called:
b.LetT be the String value that is a copy ofS with both leading and trailing white space removed.
6.ReturnT.
The definition of white space is the union ofWhiteSpace andLineTerminator. When determining whether a Unicode code point is in Unicode general category “Space_Separator” (“Zs”), code unit sequences are interpreted as UTF-16 encoded code point sequences as specified in6.1.4.
22.1.3.30 String.prototype.trimEnd ( )
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4.
ThetrimEnd function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.31 String.prototype.trimStart ( )
This function interprets a String value as a sequence of UTF-16 encoded code points, as described in6.1.4.
ThetrimStart function is intentionally generic; it does not require that itsthis value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
22.1.3.32 String.prototype.valueOf ( )
When thevalueOf method is called, the following steps are taken:
When the@@iterator method is called it returns an Iterator object (27.1.1.2) that iterates over the code points of a String value, returning each code point as a String value. The following steps are taken:
The value of the"name" property of this function is"[Symbol.iterator]".
22.1.4 Properties of String Instances
String instances are String exotic objects and have the internal methods specified for such objects. String instances inherit properties from theString prototype object. String instances also have a [[StringData]] internal slot.
String instances have a"length" property, and a set of enumerable properties withinteger-indexed names.
22.1.4.1 length
The number of elements in the String value represented by this String object.
Once a String object is initialized, this property is unchanging. It has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
22.1.5 String Iterator Objects
A String Iterator is an object, that represents a specific iteration over some specific String instance object. There is not a namedconstructor for String Iterator objects. Instead, String iterator objects are created by calling certain methods of String instance objects.
22.1.5.1 The %StringIteratorPrototype% Object
The%StringIteratorPrototype% object:
has properties that are inherited by all String Iterator Objects.
The initial value of the@@toStringTag property is the String value"String Iterator".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
22.2 RegExp (Regular Expression) Objects
A RegExp object contains a regular expression and the associated flags.
Note
The form and functionality of regular expressions is modelled after the regular expression facility in the Perl 5 programming language.
22.2.1 Patterns
The RegExpconstructor applies the following grammar to the input pattern String. An error occurs if the grammar cannot interpret the String as an expansion ofPattern.
It is a Syntax Error if theList of Unicode code points that isSourceText ofUnicodePropertyValue is not identical to aList of Unicode code points that is a value or value alias for the Unicode property or property alias given bySourceText ofUnicodePropertyName listed in the “Property value and aliases” column of the corresponding tablesTable 58 orTable 59.
It is a Syntax Error if theList of Unicode code points that isSourceText ofLoneUnicodePropertyNameOrValue is not identical to aList of Unicode code points that is a Unicode general category or general category alias listed in the “Property value and aliases” column ofTable 58, nor a binary property or binary property alias listed in the “Property name and aliases” column ofTable 57.
A regular expression pattern is converted into anAbstract Closure using the process described below. An implementation is encouraged to use more efficient algorithms than the ones listed below, as long as the results are the same. TheAbstract Closure is used as the value of a RegExp object's [[RegExpMatcher]] internal slot.
APattern is either a BMP pattern or a Unicode pattern depending upon whether or not its associated flags contain au. A BMP pattern matches against a String interpreted as consisting of a sequence of 16-bit values that are Unicode code points in the range of the Basic Multilingual Plane. A Unicode pattern matches against a String interpreted as consisting of Unicode code points encoded using UTF-16. In the context of describing the behaviour of a BMP pattern “character” means a single 16-bit Unicode BMP code point. In the context of describing the behaviour of a Unicode pattern “character” means a UTF-16 encoded code point (6.1.4). In either context, “character value” means the numeric value of the corresponding non-encoded code point.
The syntax and semantics ofPattern is defined as if the source code for thePattern was aList ofSourceCharacter values where eachSourceCharacter corresponds to a Unicode code point. If a BMP pattern contains a non-BMPSourceCharacter the entire pattern is encoded using UTF-16 and the individual code units of that encoding are used as the elements of theList.
Note 2
For example, consider a pattern expressed in source text as the single non-BMP character U+1D11E (MUSICAL SYMBOL G CLEF). Interpreted as a Unicode pattern, it would be a single element (character)List consisting of the single code point 0x1D11E. However, interpreted as a BMP pattern, it is first UTF-16 encoded to produce a two elementList consisting of the code units 0xD834 and 0xDD1E.
Patterns are passed to the RegExpconstructor as ECMAScript String values in which non-BMP characters are UTF-16 encoded. For example, the single character MUSICAL SYMBOL G CLEF pattern, expressed as a String value, is a String of length 2 whose elements were the code units 0xD834 and 0xDD1E. So no further translation of the string would be necessary to process it as a BMP pattern consisting of two pattern characters. However, to process it as a Unicode patternUTF16SurrogatePairToCodePoint must be used in producing aList whose sole element is a single pattern character, the code point U+1D11E.
An implementation may not actually perform such translations to or from UTF-16, but the semantics of this specification requires that the result of pattern matching be as if such translations were performed.
22.2.2.1 Notation
The descriptions below use the following aliases:
Input is aList whose elements are the characters of the String being matched by the regular expression pattern. Each character is either a code unit or a code point, depending upon the kind of pattern involved. The notationInput[n] means thenth character ofInput, wheren can range between 0 (inclusive) andInputLength (exclusive).
InputLength is the number of characters inInput.
NcapturingParens is the total number of left-capturing parentheses (i.e. the total number ofAtom::(GroupSpecifierDisjunction) Parse Nodes) in the pattern. A left-capturing parenthesis is any( pattern character that is matched by the( terminal of theAtom::(GroupSpecifierDisjunction) production.
DotAll istrue if the RegExp object's [[OriginalFlags]] internal slot contains"s" and otherwise isfalse.
IgnoreCase istrue if the RegExp object's [[OriginalFlags]] internal slot contains"i" and otherwise isfalse.
Multiline istrue if the RegExp object's [[OriginalFlags]] internal slot contains"m" and otherwise isfalse.
Unicode istrue if the RegExp object's [[OriginalFlags]] internal slot contains"u" and otherwise isfalse.
WordCharacters is the mathematical set that is the union of all sixty-three characters in"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_" (letters, numbers, and U+005F (LOW LINE) in the Unicode Basic Latin block) and all charactersc for whichc is not in that set butCanonicalize(c) is.WordCharacters cannot contain more than sixty-three characters unlessUnicode andIgnoreCase are bothtrue.
Furthermore, the descriptions below use the following internal data structures:
ACharSet is a mathematical set of characters. When theUnicode flag istrue, “all characters” means the CharSet containing all code point values; otherwise “all characters” means the CharSet containing all code unit values.
AState is an ordered pair (endIndex,captures) whereendIndex is aninteger andcaptures is aList ofNcapturingParens values. States are used to represent partial match states in the regular expression matching algorithms. TheendIndex is one plus the index of the last input character matched so far by the pattern, whilecaptures holds the results of capturing parentheses. Thenth element ofcaptures is either aList of characters that represents the value obtained by thenth set of capturing parentheses orundefined if thenth set of capturing parentheses hasn't been reached yet. Due to backtracking, many States may be in use at any time during the matching process.
AMatchResult is either a State or the special tokenfailure that indicates that the match failed.
AContinuation is anAbstract Closure that takes one State argument and returns a MatchResult result. The Continuation attempts to match the remaining portion (specified by the closure's captured values) of the pattern againstInput, starting at the intermediate state given by its State argument. If the match succeeds, the Continuation returns the final State that it reached; if the match fails, the Continuation returnsfailure.
AMatcher is anAbstract Closure that takes two arguments—a State and a Continuation—and returns a MatchResult result. A Matcher attempts to match a middle subpattern (specified by the closure's captured values) of the pattern againstInput, starting at the intermediate state given by its State argument. The Continuation argument should be a closure that matches the rest of the pattern. After matching the subpattern of a pattern to obtain a new State, the Matcher then calls Continuation on that new State to test if the rest of the pattern can match as well. If it can, the Matcher returns the State returned by Continuation; if not, the Matcher may try different choices at its choice points, repeatedly calling Continuation until it either succeeds or all possibilities have been exhausted.
b.Assert:index is a non-negativeinteger which is ≤ the length ofstr.
c.IfUnicode istrue, letInput be ! StringToCodePoints(str). Otherwise, letInput be aList whose elements are the code units that are the elements ofstr.Input will be used throughout the algorithms in22.2.2. Each element ofInput is considered to be a character.
d.LetInputLength be the number of characters contained inInput. This alias will be used throughout the algorithms in22.2.2.
e.LetlistIndex be the index intoInput of the character that was obtained from elementindex ofstr.
f.Letc be a new Continuation with parameters (y) that captures nothing and performs the following steps when called:
g.Letcap be aList ofNcapturingParensundefined values, indexed 1 throughNcapturingParens.
h.Letx be the State (listIndex,cap).
i.Returnm(x,c).
Note
A Pattern evaluates (“compiles”) to anAbstract Closure value.RegExpBuiltinExec can then apply this procedure to a String and an offset within the String to determine whether the pattern would match starting at exactly that offset within the String, and, if it does match, what the values of the capturing parentheses would be. The algorithms in22.2.2 are designed so that compiling a pattern may throw aSyntaxError exception; on the other hand, once the pattern is successfully compiled, applying the resultingAbstract Closure to find a match in a String cannot throw an exception (except for anyimplementation-defined exceptions that can occur anywhere such as out-of-memory).
The| regular expression operator separates two alternatives. The pattern first tries to match the leftAlternative (followed by the sequel of the regular expression); if it fails, it tries to match the rightDisjunction (followed by the sequel of the regular expression). If the leftAlternative, the rightDisjunction, and the sequel all have choice points, all choices in the sequel are tried before moving on to the next choice in the leftAlternative. If choices in the leftAlternative are exhausted, the rightDisjunction is tried instead of the leftAlternative. Any capturing parentheses inside a portion of the pattern skipped by| produceundefined values instead of Strings. Thus, for example,
/a|ab/.exec("abc")
returns the result"a" and not"ab". Moreover,
/((a)|(ab))((c)|(bc))/.exec("abc")
returns the array
["abc","a","a",undefined,"bc",undefined,"bc"]
and not
["abc","ab",undefined,"ab","c","c",undefined]
The order in which the two alternatives are tried is independent of the value ofdirection.
22.2.2.4 Alternative
With parameterdirection.
The productionAlternative::[empty] evaluates as follows:
1.Return a new Matcher with parameters (x,c) that captures nothing and performs the following steps when called:
ConsecutiveTerms try to simultaneously match consecutive portions ofInput. Whendirection = 1, if the leftAlternative, the rightTerm, and the sequel of the regular expression all have choice points, all choices in the sequel are tried before moving on to the next choice in the rightTerm, and all choices in the rightTerm are tried before moving on to the next choice in the leftAlternative. Whendirection = -1, the evaluation order ofAlternative andTerm are reversed.
4.LetparenIndex be the number of left-capturing parentheses in the entire regular expression that occur to the left of thisTerm. This is the total number ofAtom::(GroupSpecifierDisjunction) Parse Nodes prior to or enclosing thisTerm.
5.LetparenCount be the number of left-capturing parentheses inAtom. This is the total number ofAtom::(GroupSpecifierDisjunction) Parse Nodes enclosed byAtom.
6.Return a new Matcher with parameters (x,c) that capturesm,min,max,greedy,parenIndex, andparenCount and performs the following steps when called:
The abstract operation RepeatMatcher takes argumentsm (a Matcher),min (a non-negativeinteger),max (a non-negativeinteger or +∞),greedy (a Boolean),x (a State),c (a Continuation),parenIndex (a non-negativeinteger), andparenCount (a non-negativeinteger). It performs the following steps when called:
1.Ifmax = 0, returnc(x).
2.Letd be a new Continuation with parameters (y) that capturesm,min,max,greedy,x,c,parenIndex, andparenCount and performs the following steps when called:
4.For eachintegerk such thatparenIndex <k andk ≤parenIndex +parenCount, setcap[k] toundefined.
5.Lete bex'sendIndex.
6.Letxr be the State (e,cap).
7.Ifmin ≠ 0, returnm(xr,d).
8.Ifgreedy isfalse, then
a.Letz bec(x).
b.Ifz is notfailure, returnz.
c.Returnm(xr,d).
9.Letz bem(xr,d).
10.Ifz is notfailure, returnz.
11.Returnc(x).
Note 1
AnAtom followed by aQuantifier is repeated the number of times specified by theQuantifier. AQuantifier can be non-greedy, in which case theAtom pattern is repeated as few times as possible while still matching the sequel, or it can be greedy, in which case theAtom pattern is repeated as many times as possible while still matching the sequel. TheAtom pattern is repeated rather than the input character sequence that it matches, so different repetitions of theAtom can match different input substrings.
Note 2
If theAtom and the sequel of the regular expression all have choice points, theAtom is first matched as many (or as few, if non-greedy) times as possible. All choices in the sequel are tried before moving on to the next choice in the last repetition ofAtom. All choices in the last (nth) repetition ofAtom are tried before moving on to the next choice in the next-to-last (n - 1)st repetition ofAtom; at which point it may turn out that more or fewer repetitions ofAtom are now possible; these are exhausted (again, starting with either as few or as many as possible) before moving on to the next choice in the (n - 1)st repetition ofAtom and so on.
Compare
/a[a-z]{2,4}/.exec("abcdefghi")
which returns"abcde" with
/a[a-z]{2,4}?/.exec("abcdefghi")
which returns"abc".
Consider also
/(aa|aabaac|ba|b|c)*/.exec("aabaac")
which, by the choice point ordering above, returns the array
["aaba","ba"]
and not any of:
["aabaac","aabaac"]["aabaac","c"]
The above ordering of choice points can be used to write a regular expression that calculates the greatest common divisor of two numbers (represented in unary notation). The following example calculates the gcd of 10 and 15:
Step4 of the RepeatMatcher clearsAtom's captures each timeAtom is repeated. We can see its behaviour in the regular expression
/(z)((a+)?(b+)?(c))*/.exec("zaacbbbcac")
which returns the array
["zaacbbbcac","z","ac","a",undefined,"c"]
and not
["zaacbbbcac","z","ac","a","bbb","c"]
because each iteration of the outermost* clears all captured Strings contained in the quantifiedAtom, which in this case includes capture Strings numbered 2, 3, 4, and 5.
Note 4
Step2.b of the RepeatMatcher states that once the minimum number of repetitions has been satisfied, any more expansions ofAtom that match the empty character sequence are not considered for further repetitions. This prevents the regular expression engine from falling into an infinite loop on patterns such as:
1.EvaluateDisjunction with argumentdirection to obtain a Matcherm.
2.LetparenIndex be the number of left-capturing parentheses in the entire regular expression that occur to the left of thisAtom. This is the total number ofAtom::(GroupSpecifierDisjunction) Parse Nodes prior to or enclosing thisAtom.
3.Return a new Matcher with parameters (x,c) that capturesdirection,m, andparenIndex and performs the following steps when called:
The abstract operation CharacterSetMatcher takes argumentsA (a CharSet),invert (a Boolean), anddirection (1 or -1). It performs the following steps when called:
1.Return a new Matcher with parameters (x,c) that capturesA,invert, anddirection and performs the following steps when called:
The abstract operation Canonicalize takes argumentch (a character). It performs the following steps when called:
1.IfUnicode istrue andIgnoreCase istrue, then
a.If the file CaseFolding.txt of the Unicode Character Database provides a simple or common case folding mapping forch, return the result of applying that mapping toch.
7.IfuStr does not consist of a single code unit, returnch.
8.Letcu beuStr's single code unit element.
9.If the numeric value ofch ≥ 128 and the numeric value ofcu < 128, returnch.
10.Returncu.
Note 1
Parentheses of the form(Disjunction) serve both to group the components of theDisjunction pattern together and to save the result of the match. The result can be used either in a backreference (\ followed by a non-zero decimal number), referenced in a replace String, or returned as part of an array from the regular expression matchingAbstract Closure. To inhibit the capturing behaviour of parentheses, use the form(?:Disjunction) instead.
Note 2
The form(?=Disjunction) specifies a zero-width positive lookahead. In order for it to succeed, the pattern insideDisjunction must match at the current position, but the current position is not advanced before matching the sequel. IfDisjunction can match at the current position in several ways, only the first one is tried. Unlike other regular expression operators, there is no backtracking into a(?= form (this unusual behaviour is inherited from Perl). This only matters when theDisjunction contains capturing parentheses and the sequel of the pattern contains backreferences to those captures.
For example,
/(?=(a+))/.exec("baaabac")
matches the empty String immediately after the firstb and therefore returns the array:
["","aaa"]
To illustrate the lack of backtracking into the lookahead, consider:
/(?=(a+))a*b\1/.exec("baaabac")
This expression returns
["aba","a"]
and not:
["aaaba","a"]
Note 3
The form(?!Disjunction) specifies a zero-width negative lookahead. In order for it to succeed, the pattern insideDisjunction must fail to match at the current position. The current position is not advanced before matching the sequel.Disjunction can contain capturing parentheses, but backreferences to them only make sense from withinDisjunction itself. Backreferences to these capturing parentheses from elsewhere in the pattern always returnundefined because the negative lookahead must fail for the pattern to succeed. For example,
/(.*?)a(?!(a+)b\2c)\2(.*)/.exec("baaabaac")
looks for ana not immediately followed by some positive number n ofa's, ab, another na's (specified by the first\2) and ac. The second\2 is outside the negative lookahead, so it matches againstundefined and therefore always succeeds. The whole expression returns the array:
["baaabaac","ba",undefined,"abaac"]
Note 4
In case-insignificant matches whenUnicode istrue, all characters are implicitly case-folded using the simple mapping provided by the Unicode standard immediately before they are compared. The simple mapping always maps to a single code point, so it does not map, for example,ß (U+00DF) toSS. It may however map a code point outside the Basic Latin range to a character within, for example,ſ (U+017F) tos. Such characters are not mapped ifUnicode isfalse. This prevents Unicode code points such as U+017F and U+212A from matching regular expressions such as/[a-z]/i, but they will match/[a-z]/ui.
22.2.2.8.3 UnicodeMatchProperty (p )
The abstract operation UnicodeMatchProperty takes argumentp (aList of Unicode code points). It performs the following steps when called:
1.Assert:p is aList of Unicode code points that is identical to aList of Unicode code points that is a Unicodeproperty name or property alias listed in the “Property name and aliases” column ofTable 56 orTable 57.
2.Letc be the canonicalproperty name ofp as given in the “Canonicalproperty name” column of the corresponding row.
Implementations must support the Unicode property names and aliases listed inTable 56 andTable 57. To ensure interoperability, implementations must not support any other property names or aliases.
Note 1
For example,Script_Extensions (property name) andscx (property alias) are valid, butscript_extensions orScx aren't.
Note 2
The listed properties form a superset of whatUTS18 RL1.2 requires.
Table 56: Non-binary Unicode property aliases and their canonical property names
The abstract operation UnicodeMatchPropertyValue takes argumentsp (aList of Unicode code points) andv (aList of Unicode code points). It performs the following steps when called:
1.Assert:p is aList of Unicode code points that is identical to aList of Unicode code points that is a canonical, unaliased Unicodeproperty name listed in the “Canonicalproperty name” column ofTable 56.
2.Assert:v is aList of Unicode code points that is identical to aList of Unicode code points that is a property value or property value alias for Unicode propertyp listed in the “Property value and aliases” column ofTable 58 orTable 59.
3.Letvalue be the canonical property value ofv as given in the “Canonical property value” column of the corresponding row.
Implementations must support the Unicode property value names and aliases listed inTable 58 andTable 59. To ensure interoperability, implementations must not support any other property value names or aliases.
Note 1
For example,Xpeo andOld_Persian are validScript_Extensions values, butxpeo andOld Persian aren't.
An escape sequence of the form\ followed by a non-zero decimal numbern matches the result of thenth set of capturing parentheses (22.2.2.1). It is an error if the regular expression has fewer thann capturing parentheses. If the regular expression hasn or more capturing parentheses but thenth one isundefined because it has not captured anything, then the backreference always succeeds.
3.LetparenIndex be the number of left-capturing parentheses in the entire regular expression that occur to the left of the locatedGroupSpecifier. This is the total number ofAtom::(GroupSpecifierDisjunction) Parse Nodes prior to or enclosing the locatedGroupSpecifier, including its immediately enclosingAtom.
k.If there exists anintegeri between 0 (inclusive) andlen (exclusive) such thatCanonicalize(s[i]) is not the same character value asCanonicalize(Input[g +i]), returnfailure.
If\ is followed by a decimal numbern whose first digit is not0, then the escape sequence is considered to be a backreference. It is an error ifn is greater than the total number of left-capturing parentheses in the entire regular expression.
2.If ! UnicodeMatchPropertyValue(General_Category,s) is identical to aList of Unicode code points that is the name of a Unicode general category or general category alias listed in the “Property value and aliases” column ofTable 58, then
a.Return the CharSet containing all Unicode code points whose character database definition includes the property “General_Category” with values.
ClassRanges can expand into a singleClassAtom and/or ranges of twoClassAtom separated by dashes. In the latter case theClassRanges includes all characters between the firstClassAtom and the secondClassAtom, inclusive; an error occurs if eitherClassAtom does not represent a single character (for example, if one is \w) or if the firstClassAtom's character value is greater than the secondClassAtom's character value.
Note 2
Even if the pattern ignores case, the case of the two ends of a range is significant in determining which characters belong to the range. Thus, for example, the pattern/[E-F]/i matches only the lettersE,F,e, andf, while the pattern/[E-f]/i matches all upper and lower-case letters in the Unicode Basic Latin block as well as the symbols[,\,],^,_, and`.
Note 3
A- character can be treated literally or it can denote a range. It is treated literally if it is the first or last character ofClassRanges, the beginning or end limit of a range specification, or immediately follows a range specification.
AClassAtom can use any of the escape sequences that are allowed in the rest of the regular expression except for\b,\B, and backreferences. Inside aCharacterClass,\b means the backspace character, while\B and backreferences raise errors. Using a backreference inside aClassAtom causes an error.
is the initial value of the"RegExp" property of theglobal object.
creates and initializes a new RegExp object when called as a function rather than as aconstructor. Thus the function callRegExp(…) is equivalent to the object creation expressionnew RegExp(…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified RegExp behaviour must include asuper call to the RegExpconstructor to create and initialize subclass instances with the necessary internal slots.
If pattern is supplied using aStringLiteral, the usual escape sequence substitutions are performed before the String is processed by RegExp. If pattern must contain an escape sequence to be recognized by RegExp, any U+005C (REVERSE SOLIDUS) code points must be escaped within theStringLiteral to prevent them being removed when the contents of theStringLiteral are formed.
22.2.3.2 Abstract Operations for the RegExp Constructor
22.2.3.2.1 RegExpAlloc (newTarget )
The abstract operation RegExpAlloc takes argumentnewTarget. It performs the following steps when called:
1.Letobj be ? OrdinaryCreateFromConstructor(newTarget,"%RegExp.prototype%", « [[RegExpMatcher]], [[OriginalSource]], [[OriginalFlags]] »).
14.Setobj.[[RegExpMatcher]] to theAbstract Closure that evaluatesparseResult by applying the semantics provided in22.2.2 usingpatternCharacters as the pattern'sList ofSourceCharacter values andF as the flag parameters.
The abstract operation ParsePattern takes argumentspatternText (a sequence of Unicode code points) andu (a Boolean). It performs the following steps when called:
The abstract operation EscapeRegExpPattern takes argumentsP andF. It performs the following steps when called:
1.LetS be a String in the form of aPattern[~U] (Pattern[+U] ifF contains"u") equivalent toP interpreted as UTF-16 encoded Unicode code points (6.1.4), in which certain code points are escaped as described below.S may or may not be identical toP; however, theAbstract Closure that would result from evaluatingS as aPattern[~U] (Pattern[+U] ifF contains"u") must behave identically to theAbstract Closure given by the constructed object's [[RegExpMatcher]] internal slot. Multiple calls to this abstract operation using the same values forP andF must produce identical results.
2.The code points/ or anyLineTerminator occurring in the pattern shall be escaped inS as necessary to ensure that thestring-concatenation of"/",S,"/", andF can be parsed (in an appropriate lexical context) as aRegularExpressionLiteral that behaves identically to the constructed regular expression. For example, ifP is"/", thenS could be"\/" or"\u002F", among other possibilities, but not"/", because/// followed byF would be parsed as aSingleLineComment rather than aRegularExpressionLiteral. IfP is the empty String, this specification can be met by lettingS be"(?:)".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
22.2.4.2 get RegExp [ @@species ]
RegExp[@@species] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
1.Return thethis value.
The value of the"name" property of this function is"get [Symbol.species]".
Note
RegExp prototype methods normally use theirthis value'sconstructor to create a derived object. However, a subclassconstructor may over-ride that default behaviour by redefining its@@species property.
The RegExp prototype object does not have a"valueOf" property of its own; however, it inherits the"valueOf" property from theObject prototype object.
22.2.5.1 RegExp.prototype.constructor
The initial value ofRegExp.prototype.constructor is%RegExp%.
22.2.5.2 RegExp.prototype.exec (string )
Performs a regular expression match ofstring against the regular expression and returns an Array object containing the results of the match, ornull ifstring did not match.
The StringToString(string) is searched for an occurrence of the regular expression pattern as follows:
If a callable"exec" property is not found this algorithm falls back to attempting to use the built-in RegExp matching algorithm. This provides compatible behaviour for code written for prior editions where most built-in algorithms that use regular expressions did not perform a dynamic property lookup of"exec".
22.2.5.2.2 RegExpBuiltinExec (R,S )
The abstract operation RegExpBuiltinExec takes argumentsR andS. It performs the following steps when called:
a.e is an index into theInput character list, derived fromS, matched bymatcher. LeteUTF be the smallest index intoS that corresponds to the character at elemente ofInput. Ife is greater than or equal to the number of elements inInput, theneUTF is the number of code units inS.
The abstract operation AdvanceStringIndex takes argumentsS (a String),index (a non-negativeinteger), andunicode (a Boolean). It performs the following steps when called:
The value of the"name" property of this function is"[Symbol.match]".
Note
The@@match property is used by theIsRegExp abstract operation to identify objects that have the basic behaviour of regular expressions. The absence of a@@match property or the existence of such a property whose value does not Boolean coerce totrue indicates that the object is not intended to be used as a regular expression object.
ii.Letreplacement be ? GetSubstitution(matched,S,position,captures,namedCaptures,replaceValue).
m.Ifposition ≥nextSourcePosition, then
i.NOTE:position should not normally move backwards. If it does, it is an indication of an ill-behaving RegExp subclass or use of an access triggered side-effect to change the global flag or other characteristics ofrx. In such cases, the corresponding substitution is ignored.
ii.SetaccumulatedResult to thestring-concatenation ofaccumulatedResult, thesubstring ofS fromnextSourcePosition toposition, andreplacement.
Returns an Array object into which substrings of the result of convertingstring to a String have been stored. The substrings are determined by searching from left to right for matches of thethis value regular expression; these occurrences are not part of any String in the returned array, but serve to divide up the String value.
Thethis value may be an empty regular expression or a regular expression that can match an empty String. In this case, the regular expression does not match the emptysubstring at the beginning or end of the input String, nor does it match the emptysubstring at the end of the previous separator match. (For example, if the regular expression matches the empty String, the String is split up into individual code unit elements; the length of the result array equals the length of the String, and eachsubstring contains one code unit.) Only the first match at a given index of the String is considered, even if backtracking could yield a non-emptysubstring match at that index. (For example,/a*?/[Symbol.split]("ab") evaluates to the array["a", "b"], while/a*/[Symbol.split]("ab") evaluates to the array["","b"].)
Ifstring is (or converts to) the empty String, the result depends on whether the regular expression can match the empty String. If it can, the result array contains no elements. Otherwise, the result array contains one element, which is the empty String.
If the regular expression contains capturing parentheses, then each timeseparator is matched the results (including anyundefined results) of the capturing parentheses are spliced into the output array. For example,
5.Ifflags contains the code unit 0x0075 (LATIN SMALL LETTER U), returntrue.
6.Returnfalse.
22.2.6 Properties of RegExp Instances
RegExp instances are ordinary objects that inherit properties from theRegExp prototype object. RegExp instances have internal slots [[RegExpMatcher]], [[OriginalSource]], and [[OriginalFlags]]. The value of the [[RegExpMatcher]] internal slot is anAbstract Closure representation of thePattern of the RegExp object.
Note
Prior to ECMAScript 2015, RegExp instances were specified as having the own data properties"source","global","ignoreCase", and"multiline". Those properties are now specified as accessor properties ofRegExp.prototype.
RegExp instances also have the following property:
22.2.6.1 lastIndex
The value of the"lastIndex" property specifies the String index at which to start the next match. It is coerced to anintegral Number when used (see22.2.5.2.2). This property shall have the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:false }.
22.2.7 RegExp String Iterator Objects
A RegExp String Iterator is an object, that represents a specific iteration over some specific String instance object, matching against some specific RegExp instance object. There is not a namedconstructor for RegExp String Iterator objects. Instead, RegExp String Iterator objects are created by calling certain methods of RegExp instance objects.
The initial value of the@@toStringTag property is the String value"RegExp String Iterator".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
23 Indexed Collections
23.1 Array Objects
Array objects are exotic objects that give special treatment to a certain class of property names. See10.4.2 for a definition of this special treatment.
also creates and initializes a new Array object when called as a function rather than as aconstructor. Thus the function callArray(…) is equivalent to the object creation expressionnew Array(…) with the same arguments.
is a function whose behaviour differs based upon the number and types of its arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the exotic Array behaviour must include asuper call to the Arrayconstructor to initialize subclass instances that are Array exotic objects. However, most of theArray.prototype methods are generic methods that are not dependent upon theirthis value being anArray exotic object.
has a"length" property whose value is1𝔽.
23.1.1.1 Array ( ...values )
When theArray function is called, the following steps are taken:
1.If NewTarget isundefined, letnewTarget be theactive function object; else letnewTarget be NewTarget.
Thefrom function is an intentionally generic factory method; it does not require that itsthis value be the Arrayconstructor. Therefore it can be transferred to or inherited by any other constructors that may be called with a single numeric argument.
23.1.2.2 Array.isArray (arg )
TheisArray function takes one argumentarg, and performs the following steps:
Theof function is an intentionally generic factory method; it does not require that itsthis value be the Arrayconstructor. Therefore it can be transferred to or inherited by other constructors that may be called with a single numeric argument.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
23.1.2.5 get Array [ @@species ]
Array[@@species] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
1.Return thethis value.
The value of the"name" property of this function is"get [Symbol.species]".
Note
Array prototype methods normally use theirthis value'sconstructor to create a derived object. However, a subclassconstructor may over-ride that default behaviour by redefining its@@species property.
23.1.3 Properties of the Array Prototype Object
TheArray prototype object:
is%Array.prototype%.
is anArray exotic object and has the internal methods specified for such objects.
has a"length" property whose initial value is+0𝔽 and whose attributes are { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:false }.
The Array prototype object is specified to be anArray exotic object to ensure compatibility with ECMAScript code that was created prior to the ECMAScript 2015 specification.
23.1.3.1 Array.prototype.concat ( ...items )
When theconcat method is called with zero or more arguments, it returns an array containing the array elements of the object followed by the array elements of each argument.
The explicit setting of the"length" property in step6 is necessary to ensure that its value is correct in situations where the trailing elements of the result Array are not present.
Note 2
Theconcat function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.1.1 IsConcatSpreadable (O )
The abstract operation IsConcatSpreadable takes argumentO. It performs the following steps when called:
ThecopyWithin method takes up to three argumentstarget,start andend.
Note 1
Theend argument is optional with the length of thethis value as its default value. Iftarget is negative, it is treated aslength +target wherelength is the length of the array. Ifstart is negative, it is treated aslength +start. Ifend is negative, it is treated aslength +end.
ThecopyWithin function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
callbackfn should be a function that accepts three arguments and returns a value that is coercible to a Boolean value.every callscallbackfn once for each element present in the array, in ascending order, until it finds one wherecallbackfn returnsfalse. If such an element is found,every immediately returnsfalse. Otherwise, ifcallbackfn returnedtrue for all elements,every will returntrue.callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
every does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed byevery is set before the first call tocallbackfn. Elements which are appended to the array after the call toevery begins will not be visited bycallbackfn. If existing elements of the array are changed, their value as passed tocallbackfn will be the value at the timeevery visits them; elements that are deleted after the call toevery begins and before being visited are not visited.every acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returnstrue.
When theevery method is called with one or two arguments, the following steps are taken:
ii.LettestResult be ! ToBoolean(?Call(callbackfn,thisArg, «kValue,𝔽(k),O »)).
iii.IftestResult isfalse, returnfalse.
d.Setk tok + 1.
6.Returntrue.
Note 2
Theevery function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
Thefill method takes up to three argumentsvalue,start andend.
Note 1
Thestart andend arguments are optional with default values of 0 and the length of thethis value. Ifstart is negative, it is treated aslength +start wherelength is the length of the array. Ifend is negative, it is treated aslength +end.
Thefill function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
callbackfn should be a function that accepts three arguments and returns a value that is coercible to a Boolean value.filter callscallbackfn once for each element in the array, in ascending order, and constructs a new array of all the values for whichcallbackfn returnstrue.callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
filter does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed byfilter is set before the first call tocallbackfn. Elements which are appended to the array after the call tofilter begins will not be visited bycallbackfn. If existing elements of the array are changed their value as passed tocallbackfn will be the value at the timefilter visits them; elements that are deleted after the call tofilter begins and before being visited are not visited.
When thefilter method is called with one or two arguments, the following steps are taken:
Thefilter function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
Thefind method is called with one or two arguments,predicate andthisArg.
Note 1
predicate should be a function that accepts three arguments and returns a value that is coercible to a Boolean value.find callspredicate once for each element of the array, in ascending order, until it finds one wherepredicate returnstrue. If such an element is found,find immediately returns that element value. Otherwise,find returnsundefined.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofpredicate. If it is not provided,undefined is used instead.
predicate is called with three arguments: the value of the element, the index of the element, and the object being traversed.
find does not directly mutate the object on which it is called but the object may be mutated by the calls topredicate.
The range of elements processed byfind is set before the first call topredicate. Elements that are appended to the array after the call tofind begins will not be visited bypredicate. If existing elements of the array are changed, their value as passed topredicate will be the value at the time thatfind visits them; elements that are deleted after the call tofind begins and before being visited are not visited.
When thefind method is called, the following steps are taken:
c.LettestResult be ! ToBoolean(?Call(predicate,thisArg, «kValue,𝔽(k),O »)).
d.IftestResult istrue, returnkValue.
e.Setk tok + 1.
6.Returnundefined.
Note 2
Thefind function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
predicate should be a function that accepts three arguments and returns a value that is coercible to a Boolean value.findIndex callspredicate once for each element of the array, in ascending order, until it finds one wherepredicate returnstrue. If such an element is found,findIndex immediately returns the index of that element value. Otherwise,findIndex returns -1.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofpredicate. If it is not provided,undefined is used instead.
predicate is called with three arguments: the value of the element, the index of the element, and the object being traversed.
findIndex does not directly mutate the object on which it is called but the object may be mutated by the calls topredicate.
The range of elements processed byfindIndex is set before the first call topredicate. Elements that are appended to the array after the call tofindIndex begins will not be visited bypredicate. If existing elements of the array are changed, their value as passed topredicate will be the value at the time thatfindIndex visits them; elements that are deleted after the call tofindIndex begins and before being visited are not visited.
When thefindIndex method is called with one or two arguments, the following steps are taken:
ThefindIndex function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.10 Array.prototype.flat ( [depth ] )
When theflat method is called with zero or one arguments, the following steps are taken:
The abstract operation FlattenIntoArray takes argumentstarget,source,sourceLen (a non-negativeinteger),start (a non-negativeinteger), anddepth (a non-negativeinteger or +∞) and optional argumentsmapperFunction andthisArg. It performs the following steps when called:
callbackfn should be a function that accepts three arguments.forEach callscallbackfn once for each element present in the array, in ascending order.callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
forEach does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed byforEach is set before the first call tocallbackfn. Elements which are appended to the array after the call toforEach begins will not be visited bycallbackfn. If existing elements of the array are changed, their value as passed tocallbackfn will be the value at the timeforEach visits them; elements that are deleted after the call toforEach begins and before being visited are not visited.
When theforEach method is called with one or two arguments, the following steps are taken:
TheforEach function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
includes comparessearchElement to the elements of the array, in ascending order, using theSameValueZero algorithm, and if found at any position, returnstrue; otherwise,false is returned.
The optional second argumentfromIndex defaults to+0𝔽 (i.e. the whole array is searched). If it is greater than or equal to the length of the array,false is returned, i.e. the array will not be searched. If it is less than+0𝔽, it is used as the offset from the end of the array to computefromIndex. If the computed index is less than+0𝔽, the whole array will be searched.
When theincludes method is called, the following steps are taken:
Theincludes function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
Note 3
Theincludes method intentionally differs from the similarindexOf method in two ways. First, it uses theSameValueZero algorithm, instead ofStrict Equality Comparison, allowing it to detectNaN array elements. Second, it does not skip missing array elements, instead treating them asundefined.
indexOf comparessearchElement to the elements of the array, in ascending order, using theStrict Equality Comparison algorithm, and if found at one or more indices, returns the smallest such index; otherwise,-1𝔽 is returned.
The optional second argumentfromIndex defaults to+0𝔽 (i.e. the whole array is searched). If it is greater than or equal to the length of the array,-1𝔽 is returned, i.e. the array will not be searched. If it is less than+0𝔽, it is used as the offset from the end of the array to computefromIndex. If the computed index is less than+0𝔽, the whole array will be searched.
When theindexOf method is called with one or two arguments, the following steps are taken:
TheindexOf function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.15 Array.prototype.join (separator )
Note 1
The elements of the array are converted to Strings, and these Strings are then concatenated, separated by occurrences of theseparator. If no separator is provided, a single comma is used as the separator.
Thejoin method takes one argument,separator, and performs the following steps:
Thejoin function is intentionally generic; it does not require that itsthis value be an Array object. Therefore, it can be transferred to other kinds of objects for use as a method.
lastIndexOf comparessearchElement to the elements of the array in descending order using theStrict Equality Comparison algorithm, and if found at one or more indices, returns the largest such index; otherwise,-1𝔽 is returned.
The optional second argumentfromIndex defaults to the array's length minus one (i.e. the whole array is searched). If it is greater than or equal to the length of the array, the whole array will be searched. If it is less than+0𝔽, it is used as the offset from the end of the array to computefromIndex. If the computed index is less than+0𝔽,-1𝔽 is returned.
When thelastIndexOf method is called with one or two arguments, the following steps are taken:
ThelastIndexOf function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
callbackfn should be a function that accepts three arguments.map callscallbackfn once for each element in the array, in ascending order, and constructs a new Array from the results.callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
map does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed bymap is set before the first call tocallbackfn. Elements which are appended to the array after the call tomap begins will not be visited bycallbackfn. If existing elements of the array are changed, their value as passed tocallbackfn will be the value at the timemap visits them; elements that are deleted after the call tomap begins and before being visited are not visited.
When themap method is called with one or two arguments, the following steps are taken:
Themap function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.19 Array.prototype.pop ( )
Note 1
The last element of the array is removed from the array and returned.
When thepop method is called, the following steps are taken:
Thepop function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.20 Array.prototype.push ( ...items )
Note 1
The arguments are appended to the end of the array, in the order in which they appear. The new length of the array is returned as the result of the call.
When thepush method is called with zero or more arguments, the following steps are taken:
Thepush function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
callbackfn should be a function that takes four arguments.reduce calls the callback, as a function, once for each element after the first element present in the array, in ascending order.
callbackfn is called with four arguments: thepreviousValue (value from the previous call tocallbackfn), thecurrentValue (value of the current element), thecurrentIndex, and the object being traversed. The first time that callback is called, thepreviousValue andcurrentValue can be one of two values. If aninitialValue was supplied in the call toreduce, thenpreviousValue will be equal toinitialValue andcurrentValue will be equal to the first value in the array. If noinitialValue was supplied, thenpreviousValue will be equal to the first value in the array andcurrentValue will be equal to the second. It is aTypeError if the array contains no elements andinitialValue is not provided.
reduce does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed byreduce is set before the first call tocallbackfn. Elements that are appended to the array after the call toreduce begins will not be visited bycallbackfn. If existing elements of the array are changed, their value as passed tocallbackfn will be the value at the timereduce visits them; elements that are deleted after the call toreduce begins and before being visited are not visited.
When thereduce method is called with one or two arguments, the following steps are taken:
ii.Setaccumulator to ? Call(callbackfn,undefined, «accumulator,kValue,𝔽(k),O »).
d.Setk tok + 1.
10.Returnaccumulator.
Note 2
Thereduce function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
callbackfn should be a function that takes four arguments.reduceRight calls the callback, as a function, once for each element after the first element present in the array, in descending order.
callbackfn is called with four arguments: thepreviousValue (value from the previous call tocallbackfn), thecurrentValue (value of the current element), thecurrentIndex, and the object being traversed. The first time the function is called, thepreviousValue andcurrentValue can be one of two values. If aninitialValue was supplied in the call toreduceRight, thenpreviousValue will be equal toinitialValue andcurrentValue will be equal to the last value in the array. If noinitialValue was supplied, thenpreviousValue will be equal to the last value in the array andcurrentValue will be equal to the second-to-last value. It is aTypeError if the array contains no elements andinitialValue is not provided.
reduceRight does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed byreduceRight is set before the first call tocallbackfn. Elements that are appended to the array after the call toreduceRight begins will not be visited bycallbackfn. If existing elements of the array are changed bycallbackfn, their value as passed tocallbackfn will be the value at the timereduceRight visits them; elements that are deleted after the call toreduceRight begins and before being visited are not visited.
When thereduceRight method is called with one or two arguments, the following steps are taken:
ii.Setaccumulator to ? Call(callbackfn,undefined, «accumulator,kValue,𝔽(k),O »).
d.Setk tok - 1.
10.Returnaccumulator.
Note 2
ThereduceRight function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.23 Array.prototype.reverse ( )
Note 1
The elements of the array are rearranged so as to reverse their order. The object is returned as the result of the call.
When thereverse method is called, the following steps are taken:
i.Assert:lowerExists andupperExists are bothfalse.
ii.No action is required.
l.Setlower tolower + 1.
6.ReturnO.
Note 2
Thereverse function is intentionally generic; it does not require that itsthis value be an Array object. Therefore, it can be transferred to other kinds of objects for use as a method.
23.1.3.24 Array.prototype.shift ( )
Note 1
The first element of the array is removed from the array and returned.
When theshift method is called, the following steps are taken:
Theshift function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.25 Array.prototype.slice (start,end )
Note 1
Theslice method takes two arguments,start andend, and returns an array containing the elements of the array from elementstart up to, but not including, elementend (or through the end of the array ifend isundefined). Ifstart is negative, it is treated aslength +start wherelength is the length of the array. Ifend is negative, it is treated aslength +end wherelength is the length of the array.
The explicit setting of the"length" property of the result Array in step15 was necessary in previous editions of ECMAScript to ensure that its length was correct in situations where the trailing elements of the result Array were not present. Setting"length" became unnecessary starting in ES2015 when the result Array was initialized to its proper length rather than an empty Array but is carried forward to preserve backward compatibility.
Note 3
Theslice function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
callbackfn should be a function that accepts three arguments and returns a value that is coercible to a Boolean value.some callscallbackfn once for each element present in the array, in ascending order, until it finds one wherecallbackfn returnstrue. If such an element is found,some immediately returnstrue. Otherwise,some returnsfalse.callbackfn is called only for elements of the array which actually exist; it is not called for missing elements of the array.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the value of the element, the index of the element, and the object being traversed.
some does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
The range of elements processed bysome is set before the first call tocallbackfn. Elements that are appended to the array after the call tosome begins will not be visited bycallbackfn. If existing elements of the array are changed, their value as passed tocallbackfn will be the value at the time thatsome visits them; elements that are deleted after the call tosome begins and before being visited are not visited.some acts like the "exists" quantifier in mathematics. In particular, for an empty array, it returnsfalse.
When thesome method is called with one or two arguments, the following steps are taken:
ii.LettestResult be ! ToBoolean(?Call(callbackfn,thisArg, «kValue,𝔽(k),O »)).
iii.IftestResult istrue, returntrue.
d.Setk tok + 1.
6.Returnfalse.
Note 2
Thesome function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.27 Array.prototype.sort (comparefn )
The elements of this array are sorted. The sort must be stable (that is, elements that compare equal must remain in their original order). Ifcomparefn is notundefined, it should be a function that accepts two argumentsx andy and returns a negative value ifx <y, zero ifx =y, or a positive value ifx >y.
The following steps are taken:
1.Ifcomparefn is notundefined andIsCallable(comparefn) isfalse, throw aTypeError exception.
Thesort order is the ordering, after completion of this function, of theinteger-indexed property values ofobj whoseinteger indexes are less thanlen. The result of thesort function is then determined as follows:
Ifcomparefn is notundefined and is not a consistent comparison function for the elements ofitems (see below).
Ifcomparefn isundefined andSortCompare does not act as a consistent comparison function.
Ifcomparefn isundefined and all applications ofToString, to any specific value passed as an argument toSortCompare, do not produce the same result.
Unless the sort order is specified above to beimplementation-defined,items must satisfy all of the following conditions after executing step8 of the algorithm above:
There must be some mathematical permutation π of the non-negative integers less thanitemCount, such that for every non-negativeintegerj less thanitemCount, the elementold[j] is exactly the same asnew[π(j)].
Then for all non-negative integersj andk, each less thanitemCount, ifSortCompare(old[j], old[k]) < 0 (seeSortCompare below), thenπ(j) < π(k).
Here the notationold[j] is used to refer toitems[j] before step8 is executed, and the notationnew[j] to refer toitems[j] after step8 has been executed.
A functioncomparefn is a consistent comparison function for a set of valuesS if all of the requirements below are met for all valuesa,b, andc (possibly the same value) in the setS: The notationa <CFb meanscomparefn(a,b) < 0;a =CFb meanscomparefn(a,b) = 0 (of either sign); anda >CFb meanscomparefn(a,b) > 0.
Callingcomparefn(a,b) always returns the same valuev when given a specific pair of valuesa andb as its two arguments. Furthermore,Type(v) is Number, andv is notNaN. Note that this implies that exactly one ofa <CFb,a =CFb, anda >CFb will be true for a given pair ofa andb.
Callingcomparefn(a,b) does not modifyobj or any object onobj's prototype chain.
a =CFa (reflexivity)
Ifa =CFb, thenb =CFa (symmetry)
Ifa =CFb andb =CFc, thena =CFc (transitivity of =CF)
Ifa <CFb andb <CFc, thena <CFc (transitivity of <CF)
Ifa >CFb andb >CFc, thena >CFc (transitivity of >CF)
Note 1
The above conditions are necessary and sufficient to ensure thatcomparefn divides the setS into equivalence classes and that these equivalence classes are totally ordered.
Note 2
Thesort function is intentionally generic; it does not require that itsthis value be an Array object. Therefore, it can be transferred to other kinds of objects for use as a method.
23.1.3.27.1 SortCompare (x,y )
The abstract operation SortCompare takes argumentsx andy. It also has access to thecomparefn argument passed to the current invocation of thesort method. It performs the following steps when called:
1.Ifx andy are bothundefined, return+0𝔽.
2.Ifx isundefined, return1𝔽.
3.Ify isundefined, return-1𝔽.
4.Ifcomparefn is notundefined, then
a.Letv be ? ToNumber(?Call(comparefn,undefined, «x,y »)).
Because non-existent property values always compare greater thanundefined property values, andundefined always compares greater than any other value,undefined property values always sort to the end of the result, followed by non-existent property values.
Note 2
Method calls performed by theToStringabstract operations in steps5 and6 have the potential to cause SortCompare to not behave as a consistent comparison function.
When thesplice method is called with two or more argumentsstart,deleteCount and zero or moreitems, thedeleteCount elements of the array starting atinteger indexstart are replaced by the elements ofitems. An Array object containing the deleted elements (if any) is returned.
The explicit setting of the"length" property of the result Array in step20 was necessary in previous editions of ECMAScript to ensure that its length was correct in situations where the trailing elements of the result Array were not present. Setting"length" became unnecessary starting in ES2015 when the result Array was initialized to its proper length rather than an empty Array but is carried forward to preserve backward compatibility.
Note 3
Thesplice function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement theArray.prototype.toLocaleString method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of thetoLocaleString method is used.
Note 1
The first edition of ECMA-402 did not include a replacement specification for theArray.prototype.toLocaleString method.
The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.
3.Letseparator be the String value for the list-separator String appropriate for thehost environment's current locale (this is derived in animplementation-defined way).
The elements of the array are converted to Strings using theirtoLocaleString methods, and these Strings are then concatenated, separated by occurrences of a separator String that has been derived in animplementation-defined locale-specific way. The result of calling this function is intended to be analogous to the result oftoString, except that the result of this function is intended to be locale-specific.
Note 3
ThetoLocaleString function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.30 Array.prototype.toString ( )
When thetoString method is called, the following steps are taken:
ThetoString function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
23.1.3.31 Array.prototype.unshift ( ...items )
Note 1
The arguments are prepended to the start of the array, such that their order within the array is the same as the order in which they appear in the argument list.
When theunshift method is called with zero or more argumentsitem1,item2, etc., the following steps are taken:
Theunshift function is intentionally generic; it does not require that itsthis value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
Note
The own property names of this object are property names that were not included as standard properties ofArray.prototype prior to the ECMAScript 2015 specification. These names are ignored forwith statement binding purposes in order to preserve the behaviour of existing code that might use one of these names as a binding in an outer scope that is shadowed by awith statement whose binding object is an Array object.
23.1.4 Properties of Array Instances
Array instances are Array exotic objects and have the internal methods specified for such objects. Array instances inherit properties from theArray prototype object.
Array instances have a"length" property, and a set of enumerable properties witharray index names.
23.1.4.1 length
The"length" property of an Array instance is adata property whose value is always numerically greater than the name of every configurable own property whose name is anarray index.
The"length" property initially has the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:false }.
Note
Reducing the value of the"length" property has the side-effect of deleting own array elements whosearray index is between the old and new length values. However, non-configurable properties can not be deleted. Attempting to set the"length" property of an Array object to a value that is numerically less than or equal to the largest numeric ownproperty name of an existing non-configurablearray-indexed property of the array will result in the length being set to a numeric value that is one greater than that non-configurable numeric ownproperty name. See10.4.2.1.
23.1.5 Array Iterator Objects
An Array Iterator is an object, that represents a specific iteration over some specific Array instance object. There is not a namedconstructor for Array Iterator objects. Instead, Array iterator objects are created by calling certain methods of Array instance objects.
23.1.5.1 CreateArrayIterator (array,kind )
The abstract operation CreateArrayIterator takes argumentsarray andkind. This operation is used to create iterator objects for Array methods that return such iterators. It performs the following steps when called:
The initial value of the@@toStringTag property is the String value"Array Iterator".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
23.2 TypedArray Objects
TypedArray objects present an array-like view of an underlying binary data buffer (25.1). ATypedArray element type is the underlying binary scalar data type that all elements of aTypedArray instance have. There is a distinctTypedArrayconstructor, listed inTable 60, for each of the supported element types. Eachconstructor inTable 60 has a corresponding distinct prototype object.
3.Assert:O has a [[ViewedArrayBuffer]] internal slot.
4.Letbuffer beO.[[ViewedArrayBuffer]].
5.Returnbuffer.
23.2.3.2 get %TypedArray%.prototype.byteLength
%TypedArray%.prototype.byteLength is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
%TypedArray%.prototype.byteOffset is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
The interpretation and use of the arguments of%TypedArray%.prototype.lastIndexOf are the same as forArray.prototype.lastIndexOf as defined in23.1.3.17.
When thelastIndexOf method is called with one or two arguments, the following steps are taken:
The interpretation and use of the arguments of%TypedArray%.prototype.reduceRight are the same as forArray.prototype.reduceRight as defined in23.1.3.22.
When thereduceRight method is called with one or two arguments, the following steps are taken:
%TypedArray%.prototype.set is a function whose behaviour differs based upon the type of its first argument.
This function is not generic. Thethis value must be an object with a [[TypedArrayName]] internal slot.
Sets multiple values in thisTypedArray, reading the values fromsource. The optionaloffset value indicates the first element index in thisTypedArray where values are written. If omitted, it is assumed to be 0.
The abstract operation SetTypedArrayFromTypedArray takes argumentstarget (a TypedArray object),targetOffset (a non-negativeinteger or +∞), andsource (a TypedArray object). It sets multiple values intarget, starting at indextargetOffset, reading the values fromsource. It performs the following steps when called:
1.Assert:source is an Object that has a [[TypedArrayName]] internal slot.
The abstract operation SetTypedArrayFromArrayLike takes argumentstarget (a TypedArray object),targetOffset (a non-negativeinteger or +∞), andsource (an ECMAScript value other than a TypedArray object). It sets multiple values intarget, starting at indextargetOffset, reading the values fromsource. It performs the following steps when called:
The interpretation and use of the arguments of%TypedArray%.prototype.slice are the same as forArray.prototype.slice as defined in23.1.3.25. The following steps are taken:
%TypedArray%.prototype.sort is a distinct function that, except as described below, implements the same requirements as those ofArray.prototype.sort as defined in23.1.3.27. The implementation of the%TypedArray%.prototype.sort specification may be optimized with the knowledge that thethis value is an object that has a fixed length and whoseinteger-indexed properties are not sparse.
This function is not generic. Thethis value must be an object with a [[TypedArrayName]] internal slot.
Upon entry, the following steps are performed to initialize evaluation of thesort function. These steps are used instead of steps1–3 in23.1.3.27:
1.Ifcomparefn is notundefined andIsCallable(comparefn) isfalse, throw aTypeError exception.
The following version ofSortCompare is used by%TypedArray%.prototype.sort. It performs a numeric comparison rather than the string comparison used in23.1.3.27.
The abstract operation TypedArraySortCompare takes argumentsx andy. It also has access to thecomparefn andbuffer values of the current invocation of thesort method. It performs the following steps when called:
1.Assert: BothType(x) andType(y) are Number or both are BigInt.
2.Ifcomparefn is notundefined, then
a.Letv be ? ToNumber(?Call(comparefn,undefined, «x,y »)).
Returns a newTypedArray object whose element type is the same as thisTypedArray and whose ArrayBuffer is the same as the ArrayBuffer of thisTypedArray, referencing the elements atbegin, inclusive, up toend, exclusive. If eitherbegin orend is negative, it refers to an index from the end of the array, as opposed to from the beginning.
%TypedArray%.prototype.toLocaleString is a distinct function that implements the same algorithm asArray.prototype.toLocaleString as defined in23.1.3.29 except that thethis value's [[ArrayLength]] internal slot is accessed in place of performing a [[Get]] of"length". The implementation of the algorithm may be optimized with the knowledge that thethis value is an object that has a fixed length and whoseinteger-indexed properties are not sparse. However, such optimization must not introduce any observable changes in the specified behaviour of the algorithm.
This function is not generic.ValidateTypedArray is applied to thethis value prior to evaluating the algorithm. If its result is anabrupt completion that exception is thrown instead of evaluating the algorithm.
Note
If the ECMAScript implementation includes the ECMA-402 Internationalization API this function is based upon the algorithm forArray.prototype.toLocaleString that is in the ECMA-402 specification.
23.2.3.32 get %TypedArray%.prototype [ @@toStringTag ]
%TypedArray%.prototype[@@toStringTag] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
The abstract operation TypedArraySpeciesCreate takes argumentsexemplar andargumentList. It is used to specify the creation of a new TypedArray object using aconstructor function that is derived fromexemplar. It performs the following steps when called:
1.Assert:exemplar is an Object that has [[TypedArrayName]] and [[ContentType]] internal slots.
2.LetdefaultConstructor be the intrinsic object listed in column one ofTable 60 forexemplar.[[TypedArrayName]].
The abstract operation TypedArrayCreate takes argumentsconstructor andargumentList. It is used to specify the creation of a new TypedArray object using aconstructor function. It performs the following steps when called:
1.LetnewTypedArray be ? Construct(constructor,argumentList).
is an intrinsic object that has the structure described below, differing only in the name used as theconstructor name instead ofTypedArray, inTable 60.
is a function whose behaviour differs based upon the number and types of its arguments. The actual behaviour of a call ofTypedArray depends upon the number and kind of arguments that are passed to it.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specifiedTypedArray behaviour must include asuper call to theTypedArrayconstructor to create and initialize the subclass instance with the internal state necessary to support the%TypedArray%.prototype built-in methods.
has a"length" property whose value is3𝔽.
23.2.5.1TypedArray ( ...args )
EachTypedArrayconstructor performs the following steps when called:
The abstract operation AllocateTypedArray takes argumentsconstructorName (a String which is the name of a TypedArrayconstructor inTable 60),newTarget, anddefaultProto and optional argumentlength (a non-negativeinteger). It is used to validate and create an instance of a TypedArrayconstructor. If thelength argument is passed, an ArrayBuffer of that length is also allocated and associated with the new TypedArray instance. AllocateTypedArray provides common semantics that is used byTypedArray. It performs the following steps when called:
The abstract operation InitializeTypedArrayFromTypedArray takes argumentsO (a TypedArray object) andsrcArray (a TypedArray object). It performs the following steps when called:
1.Assert:O is an Object that has a [[TypedArrayName]] internal slot.
2.Assert:srcArray is an Object that has a [[TypedArrayName]] internal slot.
The abstract operation InitializeTypedArrayFromArrayBuffer takes argumentsO (a TypedArray object),buffer (an ArrayBuffer object),byteOffset (anECMAScript language value), andlength (anECMAScript language value). It performs the following steps when called:
1.Assert:O is an Object that has a [[TypedArrayName]] internal slot.
2.Assert:buffer is an Object that has an [[ArrayBufferData]] internal slot.
3.LetconstructorName be the String value ofO.[[TypedArrayName]].
4.LetelementSize be the Element Size value specified inTable 60 forconstructorName.
The abstract operation InitializeTypedArrayFromList takes argumentsO (a TypedArray object) andvalues (aList of ECMAScript language values). It performs the following steps when called:
1.Assert:O is an Object that has a [[TypedArrayName]] internal slot.
The abstract operation InitializeTypedArrayFromArrayLike takes argumentsO (a TypedArray object) andarrayLike (an Object that is neither a TypedArray object nor an ArrayBuffer object). It performs the following steps when called:
1.Assert:O is an Object that has a [[TypedArrayName]] internal slot.
The abstract operation AllocateTypedArrayBuffer takes argumentsO (a TypedArray object) andlength (a non-negativeinteger). It allocates and associates an ArrayBuffer withO. It performs the following steps when called:
1.Assert:O is an Object that has a [[ViewedArrayBuffer]] internal slot.
does not have a [[ViewedArrayBuffer]] or any other of the internal slots that are specific toTypedArray instance objects.
23.2.7.1TypedArray.prototype.BYTES_PER_ELEMENT
The value ofTypedArray.prototype.BYTES_PER_ELEMENT is the Element Size value specified inTable 60 forTypedArray.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
23.2.7.2TypedArray.prototype.constructor
The initial value of aTypedArray.prototype.constructor is the corresponding%TypedArray% intrinsic object.
23.2.8 Properties ofTypedArray Instances
TypedArray instances areInteger-Indexed exotic objects. EachTypedArray instance inherits properties from the correspondingTypedArray prototype object. EachTypedArray instance has the following internal slots: [[TypedArrayName]], [[ViewedArrayBuffer]], [[ByteLength]], [[ByteOffset]], and [[ArrayLength]].
24 Keyed Collections
24.1 Map Objects
Map objects are collections of key/value pairs where both the keys and values may be arbitrary ECMAScript language values. A distinct key value may only occur in one key/value pair within the Map's collection. Distinct key values are discriminated using theSameValueZero comparison algorithm.
Map object must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of elements in the collection. The data structures used in this Map objects specification is only intended to describe the required observable semantics of Map objects. It is not intended to be a viable implementation model.
is the initial value of the"Map" property of theglobal object.
creates and initializes a new Map object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specified Map behaviour must include asuper call to the Mapconstructor to create and initialize the subclass instance with the internal state necessary to support theMap.prototype built-in methods.
24.1.1.1 Map ( [iterable ] )
When theMap function is called with optional argumentiterable, the following steps are taken:
If the parameteriterable is present, it is expected to be an object that implements an@@iterator method that returns an iterator object that produces a two elementarray-like object whose first element is a value that will be used as a Map key and whose second element is the value to associate with that key.
The abstract operation AddEntriesFromIterable takes argumentstarget,iterable, andadder (afunction object).adder will be invoked, withtarget as the receiver. It performs the following steps when called:
The parameteriterable is expected to be an object that implements an@@iterator method that returns an iterator object that produces a two elementarray-like object whose first element is a value that will be used as a Map key and whose second element is the value to associate with that key.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
24.1.2.2 get Map [ @@species ]
Map[@@species] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
1.Return thethis value.
The value of the"name" property of this function is"get [Symbol.species]".
Note
Methods that create derived collection objects should call@@species to determine theconstructor to use to create the derived objects. Subclassconstructor may over-ride@@species to change the defaultconstructor assignment.
4.For eachRecord { [[Key]], [[Value]] }p ofentries, do
a.Setp.[[Key]] toempty.
b.Setp.[[Value]] toempty.
5.Returnundefined.
Note
The existing [[MapData]]List is preserved because there may be existing Map Iterator objects that are suspended midway through iterating over thatList.
24.1.3.2 Map.prototype.constructor
The initial value ofMap.prototype.constructor is%Map%.
4.For eachRecord { [[Key]], [[Value]] }p ofentries, do
a.Ifp.[[Key]] is notempty andSameValueZero(p.[[Key]],key) istrue, then
i.Setp.[[Key]] toempty.
ii.Setp.[[Value]] toempty.
iii.Returntrue.
5.Returnfalse.
Note
The valueempty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.
callbackfn should be a function that accepts three arguments.forEach callscallbackfn once for each key/value pair present in the map object, in key insertion order.callbackfn is called only for keys of the map which actually exist; it is not called for keys that have been deleted from the map.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the value of the item, the key of the item, and the Map object being traversed.
forEach does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn. Each entry of a map's [[MapData]] is only visited once. New keys added after the call toforEach begins are visited. A key will be revisited if it is deleted after it has been visited and then re-added before theforEach call completes. Keys that are deleted after the call toforEach begins and before being visited are not visited unless the key is added again before theforEach call completes.
The initial value of the@@iterator property is the samefunction object as the initial value of the"entries" property.
24.1.3.13 Map.prototype [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"Map".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
24.1.4 Properties of Map Instances
Map instances are ordinary objects that inherit properties from the Map prototype. Map instances also have a [[MapData]] internal slot.
24.1.5 Map Iterator Objects
A Map Iterator is an object, that represents a specific iteration over some specific Map instance object. There is not a namedconstructor for Map Iterator objects. Instead, map iterator objects are created by calling certain methods of Map instance objects.
24.1.5.1 CreateMapIterator (map,kind )
The abstract operation CreateMapIterator takes argumentsmap andkind. This operation is used to create iterator objects for Map methods that return such iterators. It performs the following steps when called:
The initial value of the@@toStringTag property is the String value"Map Iterator".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
24.2 Set Objects
Set objects are collections of ECMAScript language values. A distinct value may only occur once as an element of a Set's collection. Distinct values are discriminated using theSameValueZero comparison algorithm.
Set objects must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of elements in the collection. The data structures used in this Set objects specification is only intended to describe the required observable semantics of Set objects. It is not intended to be a viable implementation model.
is the initial value of the"Set" property of theglobal object.
creates and initializes a new Set object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specified Set behaviour must include asuper call to the Setconstructor to create and initialize the subclass instance with the internal state necessary to support theSet.prototype built-in methods.
24.2.1.1 Set ( [iterable ] )
When theSet function is called with optional argumentiterable, the following steps are taken:
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
24.2.2.2 get Set [ @@species ]
Set[@@species] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
1.Return thethis value.
The value of the"name" property of this function is"get [Symbol.species]".
Note
Methods that create derived collection objects should call@@species to determine theconstructor to use to create the derived objects. Subclassconstructor may over-ride@@species to change the defaultconstructor assignment.
a.Replace the element ofentries whose value ise with an element whose value isempty.
5.Returnundefined.
Note
The existing [[SetData]]List is preserved because there may be existing Set Iterator objects that are suspended midway through iterating over thatList.
24.2.3.3 Set.prototype.constructor
The initial value ofSet.prototype.constructor is%Set%.
a.Ife is notempty andSameValueZero(e,value) istrue, then
i.Replace the element ofentries whose value ise with an element whose value isempty.
ii.Returntrue.
5.Returnfalse.
Note
The valueempty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.
callbackfn should be a function that accepts three arguments.forEach callscallbackfn once for each value present in the set object, in value insertion order.callbackfn is called only for values of the Set which actually exist; it is not called for keys that have been deleted from the set.
If athisArg parameter is provided, it will be used as thethis value for each invocation ofcallbackfn. If it is not provided,undefined is used instead.
callbackfn is called with three arguments: the first two arguments are a value contained in the Set. The same value is passed for both arguments. The Set object being traversed is passed as the third argument.
Thecallbackfn is called with three arguments to be consistent with the call back functions used byforEach methods for Map and Array. For Sets, each item value is considered to be both the key and the value.
forEach does not directly mutate the object on which it is called but the object may be mutated by the calls tocallbackfn.
Each value is normally visited only once. However, a value will be revisited if it is deleted after it has been visited and then re-added before theforEach call completes. Values that are deleted after the call toforEach begins and before being visited are not visited unless the value is added again before theforEach call completes. New values added after the call toforEach begins are visited.
The initial value of the@@iterator property is the samefunction object as the initial value of the"values" property.
24.2.3.12 Set.prototype [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"Set".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
24.2.4 Properties of Set Instances
Set instances are ordinary objects that inherit properties from the Set prototype. Set instances also have a [[SetData]] internal slot.
24.2.5 Set Iterator Objects
A Set Iterator is anordinary object, with the structure defined below, that represents a specific iteration over some specific Set instance object. There is not a namedconstructor for Set Iterator objects. Instead, set iterator objects are created by calling certain methods of Set instance objects.
24.2.5.1 CreateSetIterator (set,kind )
The abstract operation CreateSetIterator takes argumentsset andkind. This operation is used to create iterator objects for Set methods that return such iterators. It performs the following steps when called:
The initial value of the@@toStringTag property is the String value"Set Iterator".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
24.3 WeakMap Objects
WeakMap objects are collections of key/value pairs where the keys are objects and values may be arbitrary ECMAScript language values. A WeakMap may be queried to see if it contains a key/value pair with a specific key, but no mechanism is provided for enumerating the objects it holds as keys. In certain conditions, objects which are notlive are removed as WeakMap keys, as described in9.9.3.
An implementation may impose an arbitrarily determined latency between the time a key/value pair of a WeakMap becomes inaccessible and the time when the key/value pair is removed from the WeakMap. If this latency was observable to ECMAScript program, it would be a source of indeterminacy that could impact program execution. For that reason, an ECMAScript implementation must not provide any means to observe a key of a WeakMap that does not require the observer to present the observed key.
WeakMap objects must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of key/value pairs in the collection. The data structure used in this WeakMap objects specification are only intended to describe the required observable semantics of WeakMap objects. It is not intended to be a viable implementation model.
Note
WeakMap and WeakSets are intended to provide mechanisms for dynamically associating state with an object in a manner that does not “leak” memory resources if, in the absence of the WeakMap or WeakSet, the object otherwise became inaccessible and subject to resource reclamation by the implementation's garbage collection mechanisms. This characteristic can be achieved by using an inverted per-object mapping of weak map instances to keys. Alternatively each weak map may internally store its key to value mappings but this approach requires coordination between the WeakMap or WeakSet implementation and the garbage collector. The following references describe mechanism that may be useful to implementations of WeakMap and WeakSets:
Barry Hayes. 1997. Ephemerons: a new finalization mechanism. InProceedings of the 12th ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applications (OOPSLA '97), A. Michael Berman (Ed.). ACM, New York, NY, USA, 176-183,http://doi.acm.org/10.1145/263698.263733.
is the initial value of the"WeakMap" property of theglobal object.
creates and initializes a new WeakMap object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specified WeakMap behaviour must include asuper call to the WeakMapconstructor to create and initialize the subclass instance with the internal state necessary to support theWeakMap.prototype built-in methods.
24.3.1.1 WeakMap ( [iterable ] )
When theWeakMap function is called with optional argumentiterable, the following steps are taken:
If the parameteriterable is present, it is expected to be an object that implements an@@iterator method that returns an iterator object that produces a two elementarray-like object whose first element is a value that will be used as a WeakMap key and whose second element is the value to associate with that key.
5.For eachRecord { [[Key]], [[Value]] }p ofentries, do
a.Ifp.[[Key]] is notempty andSameValue(p.[[Key]],key) istrue, then
i.Setp.[[Key]] toempty.
ii.Setp.[[Value]] toempty.
iii.Returntrue.
6.Returnfalse.
Note
The valueempty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.
4.IfType(key) is not Object, throw aTypeError exception.
5.For eachRecord { [[Key]], [[Value]] }p ofentries, do
a.Ifp.[[Key]] is notempty andSameValue(p.[[Key]],key) istrue, then
i.Setp.[[Value]] tovalue.
ii.ReturnM.
6.Letp be theRecord { [[Key]]:key, [[Value]]:value }.
7.Appendp as the last element ofentries.
8.ReturnM.
24.3.3.6 WeakMap.prototype [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"WeakMap".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
24.3.4 Properties of WeakMap Instances
WeakMap instances are ordinary objects that inherit properties from the WeakMap prototype. WeakMap instances also have a [[WeakMapData]] internal slot.
24.4 WeakSet Objects
WeakSet objects are collections of objects. A distinct object may only occur once as an element of a WeakSet's collection. A WeakSet may be queried to see if it contains a specific object, but no mechanism is provided for enumerating the objects it holds. In certain conditions, objects which are notlive are removed as WeakSet elements, as described in9.9.3.
An implementation may impose an arbitrarily determined latency between the time an object contained in a WeakSet becomes inaccessible and the time when the object is removed from the WeakSet. If this latency was observable to ECMAScript program, it would be a source of indeterminacy that could impact program execution. For that reason, an ECMAScript implementation must not provide any means to determine if a WeakSet contains a particular object that does not require the observer to present the observed object.
WeakSet objects must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of elements in the collection. The data structure used in this WeakSet objects specification is only intended to describe the required observable semantics of WeakSet objects. It is not intended to be a viable implementation model.
is the initial value of the"WeakSet" property of theglobal object.
creates and initializes a new WeakSet object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specified WeakSet behaviour must include asuper call to the WeakSetconstructor to create and initialize the subclass instance with the internal state necessary to support theWeakSet.prototype built-in methods.
24.4.1.1 WeakSet ( [iterable ] )
When theWeakSet function is called with optional argumentiterable, the following steps are taken:
a.Ife is notempty andSameValue(e,value) istrue, then
i.Replace the element ofentries whose value ise with an element whose value isempty.
ii.Returntrue.
6.Returnfalse.
Note
The valueempty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.
a.Ife is notempty andSameValue(e,value) istrue, returntrue.
6.Returnfalse.
24.4.3.5 WeakSet.prototype [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"WeakSet".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
24.4.4 Properties of WeakSet Instances
WeakSet instances are ordinary objects that inherit properties from the WeakSet prototype. WeakSet instances also have a [[WeakSetData]] internal slot.
25 Structured Data
25.1 ArrayBuffer Objects
25.1.1 Notation
The descriptions below in this section,25.4, and29 use the read-modify-write modification function internal data structure.
Aread-modify-write modification function is a mathematical function that is notationally represented as an abstract closure that takes two Lists of byte values as arguments and returns aList of byte values. These abstract closures satisfy all of the following properties:
They perform all their algorithm steps atomically.
Their individual algorithm steps are not observable.
Note
To aid verifying that a read-modify-write modification function's algorithm steps constitute a pure, mathematical function, the following editorial conventions are recommended:
They do not access, directly or transitively via invokedabstract operations and abstract closures, any language or specification values except their parameters and captured values.
They do not return completion values.
25.1.2 Abstract Operations For ArrayBuffer Objects
The abstract operation AllocateArrayBuffer takes argumentsconstructor andbyteLength (a non-negativeinteger). It is used to create an ArrayBuffer object. It performs the following steps when called:
1.Letobj be ? OrdinaryCreateFromConstructor(constructor,"%ArrayBuffer.prototype%", « [[ArrayBufferData]], [[ArrayBufferByteLength]], [[ArrayBufferDetachKey]] »).
Detaching an ArrayBuffer instance disassociates theData Block used as its backing store from the instance and sets the byte length of the buffer to 0. No operations defined by this specification use the DetachArrayBuffer abstract operation. However, an ECMAScripthost or implementation may define such operations.
The abstract operation CloneArrayBuffer takes argumentssrcBuffer (an ArrayBuffer object),srcByteOffset (a non-negativeinteger),srcLength (a non-negativeinteger), andcloneConstructor (aconstructor). It creates a new ArrayBuffer whose data is a copy ofsrcBuffer's data over the range starting atsrcByteOffset and continuing forsrcLength bytes. It performs the following steps when called:
1.Assert:Type(srcBuffer) is Object and it has an [[ArrayBufferData]] internal slot.
The abstract operation IsUnsignedElementType takes argumenttype. It verifies if the argumenttype is an unsignedTypedArray element type. It performs the following steps when called:
The abstract operation IsUnclampedIntegerElementType takes argumenttype. It verifies if the argumenttype is anIntegerTypedArray element type not includingUint8C. It performs the following steps when called:
The abstract operation IsBigIntElementType takes argumenttype. It verifies if the argumenttype is a BigIntTypedArray element type. It performs the following steps when called:
1.Iftype isBigUint64 orBigInt64, returntrue.
2.Returnfalse.
25.1.2.8 IsNoTearConfiguration (type,order )
The abstract operation IsNoTearConfiguration takes argumentstype andorder. It performs the following steps when called:
The abstract operation RawBytesToNumeric takes argumentstype (aTypedArray element type),rawBytes (aList), andisLittleEndian (a Boolean). It performs the following steps when called:
1.LetelementSize be the Element Size value specified inTable 60 for Element Typetype.
2.IfisLittleEndian isfalse, reverse the order of the elements ofrawBytes.
3.Iftype isFloat32, then
a.Letvalue be the byte elements ofrawBytes concatenated and interpreted as a little-endian bit string encoding of anIEEE 754-2019 binary32 value.
a.LetintValue be the byte elements ofrawBytes concatenated and interpreted as a bit string encoding of an unsigned little-endian binary number.
6.Else,
a.LetintValue be the byte elements ofrawBytes concatenated and interpreted as a bit string encoding of a binary little-endian two's complement number of bit lengthelementSize × 8.
7.If ! IsBigIntElementType(type) istrue, return the BigInt value that corresponds tointValue.
8.Otherwise, return theNumber value that corresponds tointValue.
The abstract operation GetValueFromBuffer takes argumentsarrayBuffer (an ArrayBuffer or SharedArrayBuffer),byteIndex (a non-negativeinteger),type (aTypedArray element type),isTypedArray (a Boolean), andorder (eitherSeqCst orUnordered) and optional argumentisLittleEndian (a Boolean). It performs the following steps when called:
d.LetrawValue be aList of lengthelementSize whose elements are nondeterministically chosen byte values.
e.NOTE: In implementations,rawValue is the result of a non-atomic or atomic read instruction on the underlying hardware. The nondeterminism is a semantic prescription of thememory model to describe observable behaviour of hardware with weak consistency.
The abstract operation NumericToRawBytes takes argumentstype (aTypedArray element type),value (a BigInt or a Number), andisLittleEndian (a Boolean). It performs the following steps when called:
1.Iftype isFloat32, then
a.LetrawBytes be aList whose elements are the 4 bytes that are the result of convertingvalue toIEEE 754-2019 binary32 format using roundTiesToEven mode. IfisLittleEndian isfalse, the bytes are arranged in big endian order. Otherwise, the bytes are arranged in little endian order. Ifvalue isNaN,rawBytes may be set to any implementation chosenIEEE 754-2019 binary32 format Not-a-Number encoding. An implementation must always choose the same encoding for each implementation distinguishableNaN value.
2.Else iftype isFloat64, then
a.LetrawBytes be aList whose elements are the 8 bytes that are theIEEE 754-2019 binary64 format encoding ofvalue. IfisLittleEndian isfalse, the bytes are arranged in big endian order. Otherwise, the bytes are arranged in little endian order. Ifvalue isNaN,rawBytes may be set to any implementation chosenIEEE 754-2019 binary64 format Not-a-Number encoding. An implementation must always choose the same encoding for each implementation distinguishableNaN value.
3.Else,
a.Letn be the Element Size value specified inTable 60 for Element Typetype.
b.LetconvOp be the abstract operation named in the Conversion Operation column inTable 60 for Element Typetype.
i.LetrawBytes be aList whose elements are then-byte binary encoding ofintValue. IfisLittleEndian isfalse, the bytes are ordered in big endian order. Otherwise, the bytes are ordered in little endian order.
e.Else,
i.LetrawBytes be aList whose elements are then-byte binary two's complement encoding ofintValue. IfisLittleEndian isfalse, the bytes are ordered in big endian order. Otherwise, the bytes are ordered in little endian order.
The abstract operation SetValueInBuffer takes argumentsarrayBuffer (an ArrayBuffer or SharedArrayBuffer),byteIndex (a non-negativeinteger),type (aTypedArray element type),value (a Number or a BigInt),isTypedArray (a Boolean), andorder (one ofSeqCst,Unordered, orInit) and optional argumentisLittleEndian (a Boolean). It performs the following steps when called:
The abstract operation GetModifySetValueInBuffer takes argumentsarrayBuffer (an ArrayBuffer object or a SharedArrayBuffer object),byteIndex (a non-negativeinteger),type (aTypedArray element type),value (a Number or a BigInt), andop (aread-modify-write modification function) and optional argumentisLittleEndian (a Boolean). It performs the following steps when called:
b.LeteventList be the [[EventList]] field of the element inexecution.[[EventsRecords]] whose [[AgentSignifier]] isAgentSignifier().
c.LetrawBytesRead be aList of lengthelementSize whose elements are nondeterministically chosen byte values.
d.NOTE: In implementations,rawBytesRead is the result of a load-link, of a load-exclusive, or of an operand of a read-modify-write instruction on the underlying hardware. The nondeterminism is a semantic prescription of thememory model to describe observable behaviour of hardware with weak consistency.
is the initial value of the"ArrayBuffer" property of theglobal object.
creates and initializes a new ArrayBuffer object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified ArrayBuffer behaviour must include asuper call to the ArrayBufferconstructor to create and initialize subclass instances with the internal state necessary to support theArrayBuffer.prototype built-in methods.
25.1.3.1 ArrayBuffer (length )
When theArrayBuffer function is called with argumentlength, the following steps are taken:
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
25.1.4.3 get ArrayBuffer [ @@species ]
ArrayBuffer[@@species] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
1.Return thethis value.
The value of the"name" property of this function is"get [Symbol.species]".
Note
ArrayBuffer prototype methods normally use theirthis value'sconstructor to create a derived object. However, a subclassconstructor may over-ride that default behaviour by redefining its@@species property.
25.1.5 Properties of the ArrayBuffer Prototype Object
does not have an [[ArrayBufferData]] or [[ArrayBufferByteLength]] internal slot.
25.1.5.1 get ArrayBuffer.prototype.byteLength
ArrayBuffer.prototype.byteLength is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
The initial value of the@@toStringTag property is the String value"ArrayBuffer".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
25.1.6 Properties of ArrayBuffer Instances
ArrayBuffer instances inherit properties from theArrayBuffer prototype object. ArrayBuffer instances each have an [[ArrayBufferData]] internal slot, an [[ArrayBufferByteLength]] internal slot, and an [[ArrayBufferDetachKey]] internal slot.
ArrayBuffer instances whose [[ArrayBufferData]] isnull are considered to be detached and all operators to access or modify data contained in the ArrayBuffer instance will fail.
ArrayBuffer instances whose [[ArrayBufferDetachKey]] is set to a value other thanundefined need to have allDetachArrayBuffer calls passing that same "detach key" as an argument, otherwise a TypeError will result. This internal slot is only ever set by certain embedding environments, not by algorithms in this specification.
25.2 SharedArrayBuffer Objects
25.2.1 Abstract Operations for SharedArrayBuffer Objects
The abstract operation AllocateSharedArrayBuffer takes argumentsconstructor andbyteLength (a non-negativeinteger). It is used to create a SharedArrayBuffer object. It performs the following steps when called:
1.Letobj be ? OrdinaryCreateFromConstructor(constructor,"%SharedArrayBuffer.prototype%", « [[ArrayBufferData]], [[ArrayBufferByteLength]] »).
The abstract operation IsSharedArrayBuffer takes argumentobj. It tests whether an object is an ArrayBuffer, a SharedArrayBuffer, or a subtype of either. It performs the following steps when called:
1.Assert:Type(obj) is Object and it has an [[ArrayBufferData]] internal slot.
is the initial value of the"SharedArrayBuffer" property of theglobal object, if that property is present (see below).
creates and initializes a new SharedArrayBuffer object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified SharedArrayBuffer behaviour must include asuper call to the SharedArrayBufferconstructor to create and initialize subclass instances with the internal state necessary to support theSharedArrayBuffer.prototype built-in methods.
Whenever ahost does not provide concurrent access to SharedArrayBuffer objects it may omit the"SharedArrayBuffer" property of theglobal object.
Note
Unlike anArrayBuffer, aSharedArrayBuffer cannot become detached, and its internal [[ArrayBufferData]] slot is nevernull.
25.2.2.1 SharedArrayBuffer ( [length ] )
When theSharedArrayBuffer function is called with optional argumentlength, the following steps are taken:
does not have an [[ArrayBufferData]] or [[ArrayBufferByteLength]] internal slot.
25.2.4.1 get SharedArrayBuffer.prototype.byteLength
SharedArrayBuffer.prototype.byteLength is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
The initial value of the@@toStringTag property is the String value"SharedArrayBuffer".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
25.2.5 Properties of SharedArrayBuffer Instances
SharedArrayBuffer instances inherit properties from theSharedArrayBuffer prototype object. SharedArrayBuffer instances each have an [[ArrayBufferData]] internal slot and an [[ArrayBufferByteLength]] internal slot.
Note
SharedArrayBuffer instances, unlike ArrayBuffer instances, are never detached.
The abstract operation GetViewValue takes argumentsview,requestIndex,isLittleEndian, andtype. It is used by functions on DataView instances to retrieve values from the view's buffer. It performs the following steps when called:
The abstract operation SetViewValue takes argumentsview,requestIndex,isLittleEndian,type, andvalue. It is used by functions on DataView instances to store values into the view's buffer. It performs the following steps when called:
is the initial value of the"DataView" property of theglobal object.
creates and initializes a new DataView object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified DataView behaviour must include asuper call to the DataViewconstructor to create and initialize subclass instances with the internal state necessary to support theDataView.prototype built-in methods.
The initial value of the@@toStringTag property is the String value"DataView".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
25.3.5 Properties of DataView Instances
DataView instances are ordinary objects that inherit properties from theDataView prototype object. DataView instances each have [[DataView]], [[ViewedArrayBuffer]], [[ByteLength]], and [[ByteOffset]] internal slots.
Note
The value of the [[DataView]] internal slot is not used within this specification. The simple presence of that internal slot is used within the specification to identify objects created using the DataViewconstructor.
25.4 The Atomics Object
The Atomics object:
is%Atomics%.
is the initial value of the"Atomics" property of theglobal object.
does not have a [[Construct]] internal method; it cannot be used as aconstructor with thenew operator.
does not have a [[Call]] internal method; it cannot be invoked as a function.
The Atomics object provides functions that operate indivisibly (atomically) on shared memory array cells as well as functions that let agents wait for and dispatch primitive events. When used with discipline, the Atomics functions allow multi-agent programs that communicate through shared memory to execute in a well-understood order even on parallel CPUs. The rules that govern shared-memory communication are provided by thememory model, defined below.
Note
For informative guidelines for programming and implementing shared memory in ECMAScript, please see the notes at the end of thememory model section.
The abstract operation ValidateIntegerTypedArray takes argumenttypedArray and optional argumentwaitable (a Boolean). It performs the following steps when called:
7.LetelementSize be the Element Size value specified inTable 60 forarrayTypeName.
8.Letoffset betypedArray.[[ByteOffset]].
9.Return (accessIndex ×elementSize) +offset.
25.4.1.3 GetWaiterList (block,i )
AWaiterList is a semantic object that contains an ordered list of those agents that are waiting on a location (block,i) in shared memory;block is aShared Data Block andi a byte offset into the memory ofblock. A WaiterList object also optionally contains aSynchronize event denoting the previous leaving of its critical section.
Initially a WaiterList object has an empty list and noSynchronize event.
Theagent cluster has a store of WaiterList objects; the store is indexed by (block,i). WaiterLists areagent-independent: a lookup in the store of WaiterLists by (block,i) will result in the same WaiterList object in anyagent in theagent cluster.
Each WaiterList has acritical section that controls exclusive access to that WaiterList during evaluation. Only a singleagent may enter a WaiterList's critical section at one time. Entering and leaving a WaiterList's critical section is controlled by theabstract operationsEnterCriticalSection andLeaveCriticalSection. Operations on a WaiterList—adding and removing waiting agents, traversing the list of agents, suspending and notifying agents on the list, setting and retrieving theSynchronize event—may only be performed by agents that have entered the WaiterList's critical section.
The abstract operation GetWaiterList takes argumentsblock (aShared Data Block) andi (a non-negativeinteger). It performs the following steps when called:
EnterCriticalSection hascontention when anagent attempting to enter thecritical section must wait for anotheragent to leave it. When there is no contention, FIFO order of EnterCriticalSection calls is observable. When there is contention, an implementation may choose an arbitrary order but may not cause anagent to wait indefinitely.
25.4.1.5 LeaveCriticalSection (WL )
The abstract operation LeaveCriticalSection takes argumentWL (aWaiterList). It performs the following steps when called:
The abstract operation SuspendAgent takes argumentsWL (aWaiterList),W (anagent signifier), andtimeout (a non-negativeinteger). It performs the following steps when called:
5.PerformLeaveCriticalSection(WL) and suspendW for up totimeout milliseconds, performing the combined operation in such a way that a notification that arrives after thecritical section is exited but before the suspension takes effect is not lost.W can notify either because the timeout expired or because it was notified explicitly by anotheragent callingNotifyWaiter(WL,W), and not for any other reasons at all.
The abstract operation AtomicReadModifyWrite takes argumentstypedArray,index,value, andop (aread-modify-write modification function).op takes twoList of byte values arguments and returns aList of byte values. This operation atomically loads a value, combines it with another value, and stores the result of the combination. It returns the loaded value. It performs the following steps when called:
7.NOTE: The above check is not redundant with the check inValidateIntegerTypedArray because the call toToBigInt orToIntegerOrInfinity on the preceding lines can have arbitrary side effects, which could cause the buffer to become detached.
8.LetelementType be the Element Type value inTable 60 forarrayTypeName.
The abstract operation ByteListBitwiseOp takes argumentsop (a sequence of Unicode code points),xBytes (aList of byte values), andyBytes (aList of byte values). The operation atomically performs a bitwise operation on all byte values of the arguments and returns aList of byte values. It performs the following steps when called:
b.Ifop is&, letresultByte be the result of applying the bitwise AND operation toxByte andyByte.
c.Else ifop is^, letresultByte be the result of applying the bitwise exclusive OR (XOR) operation toxByte andyByte.
d.Else,op is|. LetresultByte be the result of applying the bitwise inclusive OR operation toxByte andyByte.
e.Seti toi + 1.
f.AppendresultByte to the end ofresult.
6.Returnresult.
25.4.1.13 ByteListEqual (xBytes,yBytes )
The abstract operation ByteListEqual takes argumentsxBytes (aList of byte values) andyBytes (aList of byte values). It performs the following steps when called:
1.IfxBytes andyBytes do not have the same number of elements, returnfalse.
2.Leti be 0.
3.For each elementxByte ofxBytes, do
a.LetyByte beyBytes[i].
b.IfxByte ≠yByte, returnfalse.
c.Seti toi + 1.
4.Returntrue.
25.4.2 Atomics.add (typedArray,index,value )
The following steps are taken:
1.Lettype be the Element Type value inTable 60 fortypedArray.[[TypedArrayName]].
3.Letadd be a newread-modify-write modification function with parameters (xBytes,yBytes) that capturestype andisLittleEndian and performs the following steps atomically when called:
1.Letand be a newread-modify-write modification function with parameters (xBytes,yBytes) that captures nothing and performs the following steps atomically when called:
8.NOTE: The above check is not redundant with the check inValidateIntegerTypedArray because the call toToBigInt orToIntegerOrInfinity on the preceding lines can have arbitrary side effects, which could cause the buffer to become detached.
9.LetelementType be the Element Type value inTable 60 forarrayTypeName.
10.LetelementSize be the Element Size value specified inTable 60 for Element TypeelementType.
b.LeteventList be the [[EventList]] field of the element inexecution.[[EventsRecords]] whose [[AgentSignifier]] isAgentSignifier().
c.LetrawBytesRead be aList of lengthelementSize whose elements are nondeterministically chosen byte values.
d.NOTE: In implementations,rawBytesRead is the result of a load-link, of a load-exclusive, or of an operand of a read-modify-write instruction on the underlying hardware. The nondeterminism is a semantic prescription of thememory model to describe observable behaviour of hardware with weak consistency.
e.NOTE: The comparison of the expected value and the read value is performed outside of theread-modify-write modification function to avoid needlessly strong synchronization when the expected value is not equal to the read value.
f.IfByteListEqual(rawBytesRead,expectedBytes) istrue, then
i.Letsecond be a newread-modify-write modification function with parameters (oldBytes,newBytes) that captures nothing and performs the following steps atomically when called:
1.Letsecond be a newread-modify-write modification function with parameters (oldBytes,newBytes) that captures nothing and performs the following steps atomically when called:
Atomics.isLockFree() is an optimization primitive. The intuition is that if the atomic step of an atomic primitive (compareExchange,load,store,add,sub,and,or,xor, orexchange) on a datum of sizen bytes will be performed without the callingagent acquiring a lock outside then bytes comprising the datum, thenAtomics.isLockFree(n) will returntrue. High-performance algorithms will useAtomics.isLockFree to determine whether to use locks or atomic operations in critical sections. If an atomic primitive is not lock-free then it is often more efficient for an algorithm to provide its own locking.
Atomics.isLockFree(4) always returnstrue as that can be supported on all known relevant hardware. Being able to assume this will generally simplify programs.
Regardless of the value ofAtomics.isLockFree, all atomic operations are guaranteed to be atomic. For example, they will never have a visible operation take place in the middle of the operation (e.g., "tearing").
4.NOTE: The above check is not redundant with the check inValidateIntegerTypedArray because the call toValidateAtomicAccess on the preceding line can have arbitrary side effects, which could cause the buffer to become detached.
1.Letor be a newread-modify-write modification function with parameters (xBytes,yBytes) that captures nothing and performs the following steps atomically when called:
7.NOTE: The above check is not redundant with the check inValidateIntegerTypedArray because the call toToBigInt orToIntegerOrInfinity on the preceding lines can have arbitrary side effects, which could cause the buffer to become detached.
8.LetelementType be the Element Type value inTable 60 forarrayTypeName.
3.Letsubtract be a newread-modify-write modification function with parameters (xBytes,yBytes) that capturestype andisLittleEndian and performs the following steps atomically when called:
1.Letxor be a newread-modify-write modification function with parameters (xBytes,yBytes) that captures nothing and performs the following steps atomically when called:
does not have a [[Construct]] internal method; it cannot be used as aconstructor with thenew operator.
does not have a [[Call]] internal method; it cannot be invoked as a function.
The JSON Data Interchange Format is defined in ECMA-404. The JSON interchange format used in this specification is exactly that described by ECMA-404. Conforming implementations ofJSON.parse andJSON.stringify must support the exact interchange format described in the ECMA-404 specification without any deletions or extensions to the format.
25.5.1 JSON.parse (text [ ,reviver ] )
Theparse function parses a JSON text (a JSON-formatted String) and produces an ECMAScript value. The JSON format represents literals, arrays, and objects with a syntax similar to the syntax for ECMAScript literals, Array Initializers, and Object Initializers. After parsing, JSON objects are realized as ECMAScript objects. JSON arrays are realized as ECMAScript Array instances. JSON strings, numbers, booleans, and null are realized as ECMAScript Strings, Numbers, Booleans, andnull.
The optionalreviver parameter is a function that takes two parameters,key andvalue. It can filter and transform the results. It is called with each of thekey/value pairs produced by the parse, and its return value is used instead of the original value. If it returns what it received, the structure is not modified. If it returnsundefined then the property is deleted from the result.
2.Parse ! StringToCodePoints(jsonString) as a JSON text as specified in ECMA-404. Throw aSyntaxError exception if it is not a valid JSON text as defined in that specification.
6.Letcompletion be the result of evaluatingscript. The extendedPropertyDefinitionEvaluation semantics defined inB.3.1 must not be used during the evaluation.
7.Letunfiltered becompletion.[[Value]].
8.Assert:unfiltered is either a String, Number, Boolean, Null, or an Object that is defined by either anArrayLiteral or anObjectLiteral.
Valid JSON text is a subset of the ECMAScriptPrimaryExpression syntax. Step2 verifies thatjsonString conforms to that subset, and step8 asserts that that parsing and evaluation returns a value of an appropriate type.
However, becauseB.3.1 applies when evaluating ECMAScript source text and does not apply duringJSON.parse, the same source text can produce different results when evaluated as aPrimaryExpression rather than as JSON. Furthermore, the Early Error for duplicate"__proto__" properties in object literals, which likewise does not apply duringJSON.parse, means that not all texts accepted byJSON.parse are valid as aPrimaryExpression, despite matching the grammar.
The abstract operation InternalizeJSONProperty takes argumentsholder (an Object),name (a String), andreviver (afunction object). It performs the following steps when called:
Note 1
This algorithm intentionally does not throw an exception if either [[Delete]] orCreateDataProperty returnfalse.
It is not permitted for a conforming implementation ofJSON.parse to extend the JSON grammars. If an implementation wishes to support a modified or extended JSON interchange format it must do so by defining a different parse function.
Note 2
In the case where there are duplicate name Strings within an object, lexically preceding values for the same key shall be overwritten.
Thestringify function returns a String in UTF-16 encoded JSON format representing an ECMAScript value, orundefined. It can take three parameters. Thevalue parameter is an ECMAScript value, which is usually an object or array, although it can also be a String, Boolean, Number ornull. The optionalreplacer parameter is either a function that alters the way objects and arrays are stringified, or an array of Strings and Numbers that acts as an inclusion list for selecting the object properties that will be stringified. The optionalspace parameter is a String or Number that allows the result to have white space injected into it to improve human readability.
The"length" property of thestringify function is3𝔽.
Note 1
JSON structures are allowed to be nested to any depth, but they must be acyclic. Ifvalue is or contains a cyclic structure, then the stringify function must throw aTypeError exception. This is an example of a value that cannot be stringified:
a = [];a[0] = a;my_text =JSON.stringify(a);// This must throw a TypeError.
Note 2
Symbolic primitive values are rendered as follows:
Thenull value is rendered in JSON text as the String"null".
Theundefined value is not rendered.
Thetrue value is rendered in JSON text as the String"true".
Thefalse value is rendered in JSON text as the String"false".
Note 3
String values are wrapped in QUOTATION MARK (") code units. The code units" and\ are escaped with\ prefixes. Control characters code units are replaced with escape sequences\uHHHH, or with the shorter forms,\b (BACKSPACE),\f (FORM FEED),\n (LINE FEED),\r (CARRIAGE RETURN),\t (CHARACTER TABULATION).
Note 4
Finite numbers are stringified as if by callingToString(number).NaN andInfinity regardless of sign are represented as the String"null".
Note 5
Values that do not have a JSON representation (such asundefined and functions) do not produce a String. Instead they produce theundefined value. In arrays these values are represented as the String"null". In objects an unrepresentable value causes the property to be excluded from stringification.
Note 6
An object is rendered as U+007B (LEFT CURLY BRACKET) followed by zero or more properties, separated with a U+002C (COMMA), closed with a U+007D (RIGHT CURLY BRACKET). A property is a quoted String representing the key orproperty name, a U+003A (COLON), and then the stringified property value. An array is rendered as an opening U+005B (LEFT SQUARE BRACKET followed by zero or more values, separated with a U+002C (COMMA), closed with a U+005D (RIGHT SQUARE BRACKET).
The abstract operation QuoteJSONString takes argumentvalue. It wrapsvalue in 0x0022 (QUOTATION MARK) code units and escapes certain other code units within it. This operation interpretsvalue as a sequence of UTF-16 encoded code points, as described in6.1.4. It performs the following steps when called:
1.Letproduct be the String value consisting solely of the code unit 0x0022 (QUOTATION MARK).
3.Setproduct to thestring-concatenation ofproduct and the code unit 0x0022 (QUOTATION MARK).
4.Returnproduct.
Table 61: JSON Single Character Escape Sequences
Code Point
Unicode Character Name
Escape Sequence
U+0008
BACKSPACE
\b
U+0009
CHARACTER TABULATION
\t
U+000A
LINE FEED (LF)
\n
U+000C
FORM FEED (FF)
\f
U+000D
CARRIAGE RETURN (CR)
\r
U+0022
QUOTATION MARK
\"
U+005C
REVERSE SOLIDUS
\\
25.5.2.3 UnicodeEscape (C )
The abstract operation UnicodeEscape takes argumentC (a code unit). It representsC as a Unicode escape sequence. It performs the following steps when called:
i.Letproperties be the String value formed by concatenating all the element Strings ofpartial with each adjacent pair of Strings separated with the code unit 0x002C (COMMA). A comma is not inserted either before the first String or after the last String.
i.Letseparator be thestring-concatenation of the code unit 0x002C (COMMA), the code unit 0x000A (LINE FEED), andstate.[[Indent]].
ii.Letproperties be the String value formed by concatenating all the element Strings ofpartial with each adjacent pair of Strings separated withseparator. Theseparator String is not inserted either before the first String or after the last String.
iii.Letfinal be thestring-concatenation of"{", the code unit 0x000A (LINE FEED),state.[[Indent]],properties, the code unit 0x000A (LINE FEED),stepback, and"}".
11.Remove the last element ofstate.[[Stack]].
12.Setstate.[[Indent]] tostepback.
13.Returnfinal.
25.5.2.5 SerializeJSONArray (state,value )
The abstract operation SerializeJSONArray takes argumentsstate andvalue. It serializes an array. It performs the following steps when called:
1.Ifstate.[[Stack]] containsvalue, throw aTypeError exception because the structure is cyclical.
2.Appendvalue tostate.[[Stack]].
3.Letstepback bestate.[[Indent]].
4.Setstate.[[Indent]] to thestring-concatenation ofstate.[[Indent]] andstate.[[Gap]].
i.Letproperties be the String value formed by concatenating all the element Strings ofpartial with each adjacent pair of Strings separated with the code unit 0x002C (COMMA). A comma is not inserted either before the first String or after the last String.
i.Letseparator be thestring-concatenation of the code unit 0x002C (COMMA), the code unit 0x000A (LINE FEED), andstate.[[Indent]].
ii.Letproperties be the String value formed by concatenating all the element Strings ofpartial with each adjacent pair of Strings separated withseparator. Theseparator String is not inserted either before the first String or after the last String.
iii.Letfinal be thestring-concatenation of"[", the code unit 0x000A (LINE FEED),state.[[Indent]],properties, the code unit 0x000A (LINE FEED),stepback, and"]".
11.Remove the last element ofstate.[[Stack]].
12.Setstate.[[Indent]] tostepback.
13.Returnfinal.
Note
The representation of arrays includes only the elements between zero andarray.length - 1 inclusive. Properties whose keys are notarray indexes are excluded from the stringification. An array is stringified as an opening LEFT SQUARE BRACKET, elements separated by COMMA, and a closing RIGHT SQUARE BRACKET.
25.5.3 JSON [ @@toStringTag ]
The initial value of the@@toStringTag property is the String value"JSON".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
26 Managing Memory
26.1 WeakRef Objects
AWeakRef is an object that is used to refer to a target object without preserving it from garbage collection. WeakRefs can be dereferenced to allow access to the target object, if the target object hasn't been reclaimed by garbage collection.
is the initial value of the"WeakRef" property of theglobal object.
creates and initializes a new WeakRef object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specifiedWeakRef behaviour must include asuper call to theWeakRefconstructor to create and initialize the subclass instance with the internal state necessary to support theWeakRef.prototype built-in methods.
26.1.1.1 WeakRef (target )
When theWeakRef function is called with argumenttarget, the following steps are taken:
If theWeakRef returns atarget Object that is notundefined, then thistarget object should not be garbage collected until the current execution of ECMAScript code has completed. TheAddToKeptObjects operation makes sure read consistency is maintained.
This abstract operation is defined separately from WeakRef.prototype.deref strictly to make it possible to succinctly define liveness.
26.1.5 Properties of WeakRef Instances
WeakRef instances are ordinary objects that inherit properties from theWeakRef prototype.WeakRef instances also have a [[WeakRefTarget]] internal slot.
26.2 FinalizationRegistry Objects
AFinalizationRegistry is an object that manages registration and unregistration of cleanup operations that are performed when target objects are garbage collected.
is the initial value of the"FinalizationRegistry" property of theglobal object.
creates and initializes a new FinalizationRegistry object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specifiedFinalizationRegistry behaviour must include asuper call to theFinalizationRegistryconstructor to create and initialize the subclass instance with the internal state necessary to support theFinalizationRegistry.prototype built-in methods.
26.2.1.1 FinalizationRegistry (cleanupCallback )
When theFinalizationRegistry function is called with argumentcleanupCallback, the following steps are taken:
a.IfunregisterToken is notundefined, throw aTypeError exception.
b.SetunregisterToken toempty.
6.Letcell be theRecord { [[WeakRefTarget]]:target, [[HeldValue]]:heldValue, [[UnregisterToken]]:unregisterToken }.
7.Appendcell tofinalizationRegistry.[[Cells]].
8.Returnundefined.
Note
Based on the algorithms and definitions in this specification,cell.[[HeldValue]] islive whencell is infinalizationRegistry.[[Cells]]; however, this does not necessarily mean thatcell.[[UnregisterToken]] orcell.[[Target]] arelive. For example, registering an object with itself as its unregister token would not keep the object alive forever.
An interface is a set of property keys whose associated values match a specific specification. Any object that provides all the properties as described by an interface's specificationconforms to that interface. An interface is not represented by a distinct object. There may be many separately implemented objects that conform to any interface. An individual object may conform to multiple interfaces.
27.1.1.1 TheIterable Interface
TheIterable interface includes the property described inTable 62:
Table 62:Iterable Interface Required Properties
Property
Value
Requirements
@@iterator
A function that returns anIterator object.
The returned object must conform to theIterator interface.
27.1.1.2 TheIterator Interface
An object that implements theIterator interface must include the property inTable 63. Such objects may also implement the properties inTable 64.
Table 63:Iterator Interface Required Properties
Property
Value
Requirements
"next"
A function that returns anIteratorResult object.
The returned object must conform to theIteratorResult interface. If a previous call to thenext method of anIterator has returned anIteratorResult object whose"done" property istrue, then all subsequent calls to thenext method of that object should also return anIteratorResult object whose"done" property istrue. However, this requirement is not enforced.
Note 1
Arguments may be passed to thenext function but their interpretation and validity is dependent upon the targetIterator. The for-of statement and other common users ofIterators do not pass any arguments, soIterator objects that expect to be used in such a manner must be prepared to deal with being called with no arguments.
Table 64:Iterator Interface Optional Properties
Property
Value
Requirements
"return"
A function that returns anIteratorResult object.
The returned object must conform to theIteratorResult interface. Invoking this method notifies theIterator object that the caller does not intend to make any morenext method calls to theIterator. The returnedIteratorResult object will typically have a"done" property whose value istrue, and a"value" property with the value passed as the argument of thereturn method. However, this requirement is not enforced.
"throw"
A function that returns anIteratorResult object.
The returned object must conform to theIteratorResult interface. Invoking this method notifies theIterator object that the caller has detected an error condition. The argument may be used to identify the error condition and typically will be an exception object. A typical response is tothrow the value passed as the argument. If the method does notthrow, the returnedIteratorResult object will typically have a"done" property whose value istrue.
Note 2
Typically callers of these methods should check for their existence before invoking them. Certain ECMAScript language features includingfor-of,yield*, and array destructuring call these methods after performing an existence check. Most ECMAScript library functions that acceptIterable objects as arguments also conditionally call them.
27.1.1.3 TheAsyncIterable Interface
TheAsyncIterable interface includes the properties described inTable 65:
The returned object must conform to theAsyncIterator interface.
27.1.1.4 TheAsyncIterator Interface
An object that implements theAsyncIterator interface must include the properties inTable 66. Such objects may also implement the properties inTable 67.
A function that returns a promise for anIteratorResult object.
The returned promise, when fulfilled, must fulfill with an object which conforms to theIteratorResult interface. If a previous call to thenext method of anAsyncIterator has returned a promise for anIteratorResult object whose"done" property istrue, then all subsequent calls to thenext method of that object should also return a promise for anIteratorResult object whose"done" property istrue. However, this requirement is not enforced.
Additionally, theIteratorResult object that serves as a fulfillment value should have a"value" property whose value is not a promise (or "thenable"). However, this requirement is also not enforced.
Note 1
Arguments may be passed to thenext function but their interpretation and validity is dependent upon the targetAsyncIterator. Thefor-await-of statement and other common users ofAsyncIterators do not pass any arguments, soAsyncIterator objects that expect to be used in such a manner must be prepared to deal with being called with no arguments.
A function that returns a promise for anIteratorResult object.
The returned promise, when fulfilled, must fulfill with an object which conforms to theIteratorResult interface. Invoking this method notifies theAsyncIterator object that the caller does not intend to make any morenext method calls to theAsyncIterator. The returned promise will fulfill with anIteratorResult object which will typically have a"done" property whose value istrue, and a"value" property with the value passed as the argument of thereturn method. However, this requirement is not enforced.
Additionally, theIteratorResult object that serves as a fulfillment value should have a"value" property whose value is not a promise (or "thenable"). If the argument value is used in the typical manner, then if it is a rejected promise, a promise rejected with the same reason should be returned; if it is a fulfilled promise, then its fulfillment value should be used as the"value" property of the returned promise'sIteratorResult object fulfillment value. However, these requirements are also not enforced.
"throw"
A function that returns a promise for anIteratorResult object.
The returned promise, when fulfilled, must fulfill with an object which conforms to theIteratorResult interface. Invoking this method notifies theAsyncIterator object that the caller has detected an error condition. The argument may be used to identify the error condition and typically will be an exception object. A typical response is to return a rejected promise which rejects with the value passed as the argument.
If the returned promise is fulfilled, theIteratorResult fulfillment value will typically have a"done" property whose value istrue. Additionally, it should have a"value" property whose value is not a promise (or "thenable"), but this requirement is not enforced.
Note 2
Typically callers of these methods should check for their existence before invoking them. Certain ECMAScript language features includingfor-await-of andyield* call these methods after performing an existence check.
27.1.1.5 TheIteratorResult Interface
TheIteratorResult interface includes the properties listed inTable 68:
Table 68:IteratorResult Interface Properties
Property
Value
Requirements
"done"
Eithertrue orfalse.
This is the result status of aniteratornext method call. If the end of the iterator was reached"done" istrue. If the end was not reached"done" isfalse and a value is available. If a"done" property (either own or inherited) does not exist, it is consider to have the valuefalse.
If done isfalse, this is the current iteration element value. If done istrue, this is the return value of the iterator, if it supplied one. If the iterator does not have a return value,"value" isundefined. In that case, the"value" property may be absent from the conforming object if it does not inherit an explicit"value" property.
All objects defined in this specification that implement the Iterator interface also inherit from %IteratorPrototype%. ECMAScript code may also define objects that inherit from %IteratorPrototype%. The %IteratorPrototype% object provides a place where additional methods that are applicable to all iterator objects may be added.
The following expression is one way that ECMAScript code can access the %IteratorPrototype% object:
All objects defined in this specification that implement the AsyncIterator interface also inherit from %AsyncIteratorPrototype%. ECMAScript code may also define objects that inherit from %AsyncIteratorPrototype%. The %AsyncIteratorPrototype% object provides a place where additional methods that are applicable to all async iterator objects may be added.
The value of the"name" property of this function is"[Symbol.asyncIterator]".
27.1.4 Async-from-Sync Iterator Objects
An Async-from-Sync Iterator object is an async iterator that adapts a specific synchronous iterator. There is not a namedconstructor for Async-from-Sync Iterator objects. Instead, Async-from-Sync iterator objects are created by theCreateAsyncFromSyncIterator abstract operation as needed.
The abstract operation CreateAsyncFromSyncIterator takes argumentsyncIteratorRecord. It is used to create an async iteratorRecord from a synchronous iteratorRecord. It performs the following steps when called:
27.1.4.2.4 Async-from-Sync Iterator Value Unwrap Functions
An async-from-sync iterator value unwrap function is an anonymous built-in function that is used byAsyncFromSyncIteratorContinuation when processing the"value" property of anIteratorResult object, in order to wait for its value if it is a promise and re-package the result in a new "unwrapped"IteratorResult object. Each async-from-sync iterator value unwrap function has a [[Done]] internal slot.
When an async-from-sync iterator value unwrap function is called with argumentvalue, the following steps are taken:
27.1.4.3 Properties of Async-from-Sync Iterator Instances
Async-from-Sync Iterator instances are ordinary objects that inherit properties from the%AsyncFromSyncIteratorPrototype% intrinsic object. Async-from-Sync Iterator instances are initially created with the internal slots listed inTable 69. Async-from-Sync Iterator instances are not directly observable from ECMAScript code.
Table 69: Internal Slots of Async-from-Sync Iterator Instances
Internal Slot
Description
[[SyncIteratorRecord]]
ARecord, of the type returned byGetIterator, representing the original synchronous iterator which is being adapted.
The abstract operation AsyncFromSyncIteratorContinuation takes argumentsresult andpromiseCapability (aPromiseCapability Record). It performs the following steps when called:
A Promise is an object that is used as a placeholder for the eventual results of a deferred (and possibly asynchronous) computation.
Any Promise object is in one of three mutually exclusive states:fulfilled,rejected, andpending:
A promisep is fulfilled ifp.then(f, r) will immediately enqueue aJob to call the functionf.
A promisep is rejected ifp.then(f, r) will immediately enqueue aJob to call the functionr.
A promise is pending if it is neither fulfilled nor rejected.
A promise is said to besettled if it is not pending, i.e. if it is either fulfilled or rejected.
A promise isresolved if it is settled or if it has been “locked in” to match the state of another promise. Attempting to resolve or reject a resolved promise has no effect. A promise isunresolved if it is not resolved. An unresolved promise is always in the pending state. A resolved promise may be pending, fulfilled or rejected.
27.2.1 Promise Abstract Operations
27.2.1.1 PromiseCapability Records
APromiseCapability Record is aRecord value used to encapsulate a promise object along with the functions that are capable of resolving or rejecting that promise object. PromiseCapability Records are produced by theNewPromiseCapability abstract operation.
PromiseCapability Records have the fields listed inTable 70.
The PromiseReaction is aRecord value used to store information about how a promise should react when it becomes resolved or rejected with a given value. PromiseReaction records are created by thePerformPromiseThen abstract operation, and are used by theAbstract Closure returned byNewPromiseReactionJob.
PromiseReaction records have the fields listed inTable 71.
The function that should be applied to the incoming value, and whose return value will govern what happens to the derived promise. If [[Handler]] isempty, a function that depends on the value of [[Type]] will be used instead.
27.2.1.3 CreateResolvingFunctions (promise )
The abstract operation CreateResolvingFunctions takes argumentpromise. It performs the following steps when called:
1.LetalreadyResolved be theRecord { [[Value]]:false }.
The abstract operation NewPromiseCapability takes argumentC. It attempts to useC as aconstructor in the fashion of the built-in Promiseconstructor to create a Promise object and extract itsresolve andreject functions. The Promise object plus theresolve andreject functions are used to initialize a newPromiseCapability Record. It performs the following steps when called:
This abstract operation supports Promise subclassing, as it is generic on anyconstructor that calls a passed executor function argument in the same way as the Promiseconstructor. It is used to generalize static methods of the Promiseconstructor to any subclass.
27.2.1.5.1 GetCapabilitiesExecutor Functions
A GetCapabilitiesExecutor function is an anonymous built-in function that has a [[Capability]] internal slot.
When a GetCapabilitiesExecutor function is called with argumentsresolve andreject, the following steps are taken:
The abstract operation TriggerPromiseReactions takes argumentsreactions (aList of PromiseReaction Records) andargument. It enqueues a newJob for each record inreactions. Each suchJob processes the [[Type]] and [[Handler]] of the PromiseReactionRecord, and if the [[Handler]] is notempty, calls it passing the given argument. If the [[Handler]] isempty, the behaviour is determined by the [[Type]]. It performs the following steps when called:
Thehost-defined abstract operation HostPromiseRejectionTracker takes argumentspromise (a Promise) andoperation ("reject" or"handle"). It allowshost environments to track promise rejections.
An implementation of HostPromiseRejectionTracker must complete normally in all cases. The default implementation of HostPromiseRejectionTracker is to unconditionally return an empty normal completion.
Note 1
HostPromiseRejectionTracker is called in two scenarios:
When a promise is rejected without any handlers, it is called with itsoperation argument set to"reject".
When a handler is added to a rejected promise for the first time, it is called with itsoperation argument set to"handle".
A typical implementation of HostPromiseRejectionTracker might try to notify developers of unhandled rejections, while also being careful to notify them if such previous notifications are later invalidated by new handlers being attached.
Note 2
Ifoperation is"handle", an implementation should not hold a reference topromise in a way that would interfere with garbage collection. An implementation may hold a reference topromise ifoperation is"reject", since it is expected that rejections will be rare and not on hot code paths.
The abstract operation NewPromiseReactionJob takes argumentsreaction andargument. It returns a newJobAbstract Closure that applies the appropriate handler to the incoming value, and uses the handler's return value to resolve or reject the derived promise associated with that handler. It performs the following steps when called:
1.Letjob be a newJobAbstract Closure with no parameters that capturesreaction andargument and performs the following steps when called:
d.NOTE:handlerRealm is nevernull unless the handler isundefined. When the handler is a revoked Proxy and no ECMAScript code runs,handlerRealm is used to create error objects.
ThisJob uses the supplied thenable and itsthen method to resolve the given promise. This process must take place as aJob to ensure that the evaluation of thethen method occurs after evaluation of any surrounding code has completed.
is the initial value of the"Promise" property of theglobal object.
creates and initializes a new Promise object when called as aconstructor.
is not intended to be called as a function and will throw an exception when called in that manner.
is designed to be subclassable. It may be used as the value in anextends clause of a class definition. Subclass constructors that intend to inherit the specified Promise behaviour must include asuper call to the Promiseconstructor to create and initialize the subclass instance with the internal state necessary to support thePromise andPromise.prototype built-in methods.
27.2.3.1 Promise (executor )
When thePromise function is called with argumentexecutor, the following steps are taken:
Theexecutor argument must be afunction object. It is called for initiating and reporting completion of the possibly deferred action represented by this Promise object. The executor is called with two arguments:resolve andreject. These are functions that may be used by theexecutor function to report eventual completion or failure of the deferred computation. Returning from the executor function does not mean that the deferred action has been completed but only that the request to eventually perform the deferred action has been accepted.
Theresolve function that is passed to anexecutor function accepts a single argument. Theexecutor code may eventually call theresolve function to indicate that it wishes to resolve the associated Promise object. The argument passed to theresolve function represents the eventual value of the deferred action and can be either the actual fulfillment value or another Promise object which will provide the value if it is fulfilled.
Thereject function that is passed to anexecutor function accepts a single argument. Theexecutor code may eventually call thereject function to indicate that the associated Promise is rejected and will never be fulfilled. The argument passed to thereject function is used as the rejection value of the promise. Typically it will be an Error object.
The resolve and reject functions passed to anexecutor function by the Promiseconstructor have the capability to actually resolve and reject the associated promise. Subclasses may have differentconstructor behaviour that passes in customized values for resolve and reject.
Theall function returns a new promise which is fulfilled with an array of fulfillment values for the passed promises, or rejects with the reason of the first passed promise that rejects. It resolves all elements of the passed iterable to promises as it runs this algorithm.
The abstract operation PerformPromiseAll takes argumentsiteratorRecord,constructor,resultCapability (aPromiseCapability Record), andpromiseResolve. It performs the following steps when called:
APromise.all resolve element function is an anonymous built-in function that is used to resolve a specificPromise.all element. EachPromise.all resolve element function has [[Index]], [[Values]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.
When aPromise.all resolve element function is called with argumentx, the following steps are taken:
The"length" property of aPromise.all resolve element function is1𝔽.
27.2.4.2 Promise.allSettled (iterable )
TheallSettled function returns a promise that is fulfilled with an array of promise state snapshots, but only after all the original promises have settled, i.e. become either fulfilled or rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
The abstract operation PerformPromiseAllSettled takes argumentsiteratorRecord,constructor,resultCapability (aPromiseCapability Record), andpromiseResolve. It performs the following steps when called:
27.2.4.2.2Promise.allSettled Resolve Element Functions
APromise.allSettled resolve element function is an anonymous built-in function that is used to resolve a specificPromise.allSettled element. EachPromise.allSettled resolve element function has [[Index]], [[Values]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.
When aPromise.allSettled resolve element function is called with argumentx, the following steps are taken:
The"length" property of aPromise.allSettled resolve element function is1𝔽.
27.2.4.2.3Promise.allSettled Reject Element Functions
APromise.allSettled reject element function is an anonymous built-in function that is used to reject a specificPromise.allSettled element. EachPromise.allSettled reject element function has [[Index]], [[Values]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.
When aPromise.allSettled reject element function is called with argumentx, the following steps are taken:
The"length" property of aPromise.allSettled reject element function is1𝔽.
27.2.4.3 Promise.any (iterable )
Theany function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with anAggregateError holding the rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
The abstract operation PerformPromiseAny takes argumentsiteratorRecord,constructor,resultCapability (aPromiseCapability Record), andpromiseResolve. It performs the following steps when called:
APromise.any reject element function is an anonymous built-in function that is used to reject a specificPromise.any element. EachPromise.any reject element function has [[Index]], [[Errors]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.
When aPromise.any reject element function is called with argumentx, the following steps are taken:
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
27.2.4.5 Promise.race (iterable )
Therace function returns a new promise which is settled in the same way as the first passed promise to settle. It resolves all elements of the passediterable to promises as it runs this algorithm.
If theiterable argument is empty or if none of the promises initerable ever settle then the pending promise returned by this method will never be settled.
Note 2
Therace function expects itsthis value to be aconstructor function that supports the parameter conventions of the Promiseconstructor. It also expects that itsthis value provides aresolve method.
The abstract operation PerformPromiseRace takes argumentsiteratorRecord,constructor,resultCapability (aPromiseCapability Record), andpromiseResolve. It performs the following steps when called:
Thereject function expects itsthis value to be aconstructor function that supports the parameter conventions of the Promiseconstructor.
27.2.4.7 Promise.resolve (x )
Theresolve function returns either a new promise resolved with the passed argument, or the argument itself if the argument is a promise produced by thisconstructor.
1.LetC be thethis value.
2.IfType(C) is not Object, throw aTypeError exception.
Theresolve function expects itsthis value to be aconstructor function that supports the parameter conventions of the Promiseconstructor.
27.2.4.7.1 PromiseResolve (C,x )
The abstract operation PromiseResolve takes argumentsC (aconstructor) andx (anECMAScript language value). It returns a new promise resolved withx. It performs the following steps when called:
Promise[@@species] is anaccessor property whose set accessor function isundefined. Its get accessor function performs the following steps:
1.Return thethis value.
The value of the"name" property of this function is"get [Symbol.species]".
Note
Promise prototype methods normally use theirthis value'sconstructor to create a derived object. However, a subclassconstructor may over-ride that default behaviour by redefining its@@species property.
A Then Finally function is an anonymous built-in function that has a [[Constructor]] and an [[OnFinally]] internal slot. The value of the [[Constructor]] internal slot is aPromise-likeconstructorfunction object, and the value of the [[OnFinally]] internal slot is afunction object.
When a Then Finally function is called with argumentvalue, the following steps are taken:
The"length" property of a Then Finally function is1𝔽.
27.2.5.3.2 Catch Finally Functions
A Catch Finally function is an anonymous built-in function that has a [[Constructor]] and an [[OnFinally]] internal slot. The value of the [[Constructor]] internal slot is aPromise-likeconstructorfunction object, and the value of the [[OnFinally]] internal slot is afunction object.
When a Catch Finally function is called with argumentreason, the following steps are taken:
The abstract operation PerformPromiseThen takes argumentspromise,onFulfilled, andonRejected and optional argumentresultCapability (aPromiseCapability Record). It performs the “then” operation onpromise usingonFulfilled andonRejected as its settlement actions. IfresultCapability is passed, the result is stored by updatingresultCapability's promise. If it is not passed, then PerformPromiseThen is being called by a specification-internal operation where the result does not matter. It performs the following steps when called:
The initial value of the@@toStringTag property is the String value"Promise".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
27.2.6 Properties of Promise Instances
Promise instances are ordinary objects that inherit properties from thePromise prototype object (the intrinsic,%Promise.prototype%). Promise instances are initially created with the internal slots described inTable 72.
Table 72: Internal Slots of Promise Instances
Internal Slot
Description
[[PromiseState]]
One ofpending,fulfilled, orrejected. Governs how a promise will react to incoming calls to itsthen method.
[[PromiseResult]]
The value with which the promise has been fulfilled or rejected, if any. Only meaningful if [[PromiseState]] is notpending.
[[PromiseFulfillReactions]]
AList of PromiseReaction records to be processed when/if the promise transitions from thepending state to thefulfilled state.
[[PromiseRejectReactions]]
AList of PromiseReaction records to be processed when/if the promise transitions from thepending state to therejected state.
[[PromiseIsHandled]]
A boolean indicating whether the promise has ever had a fulfillment or rejection handler; used in unhandled rejection tracking.
creates and initializes a new GeneratorFunction object when called as a function rather than as aconstructor. Thus the function callGeneratorFunction (…) is equivalent to the object creation expressionnew GeneratorFunction (…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified GeneratorFunction behaviour must include asuper call to the GeneratorFunctionconstructor to create and initialize subclass instances with the internal slots necessary for built-in GeneratorFunction behaviour. All ECMAScript syntactic forms for defining generator function objects create direct instances of GeneratorFunction. There is no syntactic means to create instances of GeneratorFunction subclasses.
27.3.1.1 GeneratorFunction (p1,p2, … ,pn,body )
The last argument specifies the body (executable code) of a generator function; any preceding arguments specify formal parameters.
When theGeneratorFunction function is called with some argumentsp1,p2, … ,pn,body (wheren might be 0, that is, there are no “p” arguments, and wherebody might also not be provided), the following steps are taken:
The initial value of the@@toStringTag property is the String value"GeneratorFunction".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
27.3.4 GeneratorFunction Instances
Every GeneratorFunction instance is an ECMAScriptfunction object and has the internal slots listed inTable 29. The value of the [[IsClassConstructor]] internal slot for all such instances isfalse.
Each GeneratorFunction instance has the following own properties:
27.3.4.1 length
The specification for the"length" property of Function instances given in20.2.4.1 also applies to GeneratorFunction instances.
27.3.4.2 name
The specification for the"name" property of Function instances given in20.2.4.2 also applies to GeneratorFunction instances.
27.3.4.3 prototype
Whenever a GeneratorFunction instance is created anotherordinary object is also created and is the initial value of the generator function's"prototype" property. The value of the prototype property is used to initialize the [[Prototype]] internal slot of a newly created Generator object when the generatorfunction object is invoked using [[Call]].
This property has the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:false }.
Note
Unlike Function instances, the object that is the value of the a GeneratorFunction's"prototype" property does not have a"constructor" property whose value is the GeneratorFunction instance.
creates and initializes a new AsyncGeneratorFunction object when called as a function rather than as aconstructor. Thus the function callAsyncGeneratorFunction (...) is equivalent to the object creation expressionnew AsyncGeneratorFunction (...) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified AsyncGeneratorFunction behaviour must include asuper call to the AsyncGeneratorFunctionconstructor to create and initialize subclass instances with the internal slots necessary for built-in AsyncGeneratorFunction behaviour. All ECMAScript syntactic forms for defining async generator function objects create direct instances of AsyncGeneratorFunction. There is no syntactic means to create instances of AsyncGeneratorFunction subclasses.
The last argument specifies the body (executable code) of an async generator function; any preceding arguments specify formal parameters.
When theAsyncGeneratorFunction function is called with some argumentsp1,p2, … ,pn,body (wheren might be 0, that is, there are no "p" arguments, and wherebody might also not be provided), the following steps are taken:
The initial value of the@@toStringTag property is the String value"AsyncGeneratorFunction".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
27.4.4 AsyncGeneratorFunction Instances
Every AsyncGeneratorFunction instance is an ECMAScriptfunction object and has the internal slots listed inTable 29. The value of the [[IsClassConstructor]] internal slot for all such instances isfalse.
Each AsyncGeneratorFunction instance has the following own properties:
27.4.4.1 length
The value of the"length" property is anintegral Number that indicates the typical number of arguments expected by the AsyncGeneratorFunction. However, the language permits the function to be invoked with some other number of arguments. The behaviour of an AsyncGeneratorFunction when invoked on a number of arguments other than the number specified by its"length" property depends on the function.
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
27.4.4.2 name
The specification for the"name" property of Function instances given in20.2.4.2 also applies to AsyncGeneratorFunction instances.
27.4.4.3 prototype
Whenever an AsyncGeneratorFunction instance is created anotherordinary object is also created and is the initial value of the async generator function's"prototype" property. The value of the prototype property is used to initialize the [[Prototype]] internal slot of a newly created AsyncGenerator object when the generatorfunction object is invoked using [[Call]].
This property has the attributes { [[Writable]]:true, [[Enumerable]]:false, [[Configurable]]:false }.
Note
Unlike function instances, the object that is the value of the an AsyncGeneratorFunction's"prototype" property does not have a"constructor" property whose value is the AsyncGeneratorFunction instance.
27.5 Generator Objects
A Generator object is an instance of a generator function and conforms to both theIterator andIterable interfaces.
Generator instances directly inherit properties from the object that is the initial value of the"prototype" property of the Generator function that created the instance. Generator instances indirectly inherit properties from the Generator Prototype intrinsic,%GeneratorFunction.prototype.prototype%.
27.5.1 Properties of the Generator Prototype Object
The abstract operation GeneratorStart takes argumentsgenerator andgeneratorBody (aParse Node or anAbstract Closure with no parameters). It performs the following steps when called:
1.Assert: The value ofgenerator.[[GeneratorState]] isundefined.
f.Once a generator enters thecompleted state it never leaves it and its associatedexecution context is never resumed. Any execution state associated withgenerator can be discarded at this point.
9.Resume the suspended evaluation ofgenContext usingNormalCompletion(value) as the result of the operation that suspended it. Letresult be the value returned by the resumed computation.
The abstract operation GeneratorResumeAbrupt takes argumentsgenerator,abruptCompletion (aCompletion Record whose [[Type]] isreturn orthrow), andgeneratorBrand. It performs the following steps when called:
b.Once a generator enters thecompleted state it never leaves it and its associatedexecution context is never resumed. Any execution state associated withgenerator can be discarded at this point.
10.Resume the suspended evaluation ofgenContext usingabruptCompletion as the result of the operation that suspended it. Letresult be the completion record returned by the resumed computation.
8.Set the code evaluation state ofgenContext such that when evaluation is resumed with aCompletionresumptionValue the following steps will be performed:
a.ReturnresumptionValue.
b.NOTE: This returns to the evaluation of theYieldExpression that originally called this abstract operation.
The abstract operation CreateIteratorFromClosure takes argumentsclosure (anAbstract Closure with no parameters),generatorBrand, andgeneratorPrototype (an Object). It performs the following steps when called:
1.NOTE:closure can contain uses of theYield shorthand to yield an IteratorResult object.
2.LetinternalSlotsList be « [[GeneratorState]], [[GeneratorContext]], [[GeneratorBrand]] ».
An AsyncGenerator object is an instance of an async generator function and conforms to both the AsyncIterator and AsyncIterable interfaces.
AsyncGenerator instances directly inherit properties from the object that is the initial value of the"prototype" property of the AsyncGenerator function that created the instance. AsyncGenerator instances indirectly inherit properties from the AsyncGenerator Prototype intrinsic,%AsyncGeneratorFunction.prototype.prototype%.
27.6.1 Properties of the AsyncGenerator Prototype Object
The initial value of the@@toStringTag property is the String value"AsyncGenerator".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
27.6.2 Properties of AsyncGenerator Instances
AsyncGenerator instances are initially created with the internal slots described below:
Table 74: Internal Slots of AsyncGenerator Instances
Internal Slot
Description
[[AsyncGeneratorState]]
The current execution state of the async generator. The possible values are:undefined,suspendedStart,suspendedYield,executing,awaiting-return, andcompleted.
[[AsyncGeneratorContext]]
Theexecution context that is used when executing the code of this async generator.
[[AsyncGeneratorQueue]]
AList of AsyncGeneratorRequest records which represent requests to resume the async generator.
[[GeneratorBrand]]
A brand used to distinguish different kinds of async generators. The [[GeneratorBrand]] of async generators declared by ECMAScript source text is alwaysempty.
27.6.3 AsyncGenerator Abstract Operations
27.6.3.1 AsyncGeneratorRequest Records
The AsyncGeneratorRequest is aRecord value used to store information about how an async generator should be resumed and contains capabilities for fulfilling or rejecting the corresponding promise.
The abstract operation AsyncGeneratorStart takes argumentsgenerator andgeneratorBody (aParse Node or anAbstract Closure with no parameters). It performs the following steps when called:
18.Resume the suspended evaluation ofgenContext usingcompletion as the result of the operation that suspended it. Letresult be the completion record returned by the resumed computation.
The abstract operation AsyncGeneratorEnqueue takes argumentsgenerator,completion (aCompletion Record), andgeneratorBrand. It performs the following steps when called:
8.Set the code evaluation state ofgenContext such that when evaluation is resumed with aCompletionresumptionValue the following steps will be performed:
a.IfresumptionValue.[[Type]] is notreturn, returnCompletion(resumptionValue).
f.NOTE: When one of the above steps returns, it returns to the evaluation of theYieldExpression production that originally called this abstract operation.
The abstract operation CreateAsyncIteratorFromClosure takes argumentsclosure (anAbstract Closure with no parameters),generatorBrand, andgeneratorPrototype (an Object). It performs the following steps when called:
1.NOTE:closure can contain uses of theAwait shorthand and uses of theYield shorthand to yield an IteratorResult object.
2.LetinternalSlotsList be « [[AsyncGeneratorState]], [[AsyncGeneratorContext]], [[AsyncGeneratorQueue]], [[GeneratorBrand]] ».
creates and initializes a new AsyncFunction object when called as a function rather than as aconstructor. Thus the function callAsyncFunction(…) is equivalent to the object creation expressionnew AsyncFunction(…) with the same arguments.
is designed to be subclassable. It may be used as the value of anextends clause of a class definition. Subclass constructors that intend to inherit the specified AsyncFunction behaviour must include asuper call to the AsyncFunctionconstructor to create and initialize a subclass instance with the internal slots necessary for built-in async function behaviour. All ECMAScript syntactic forms for defining async function objects create direct instances of AsyncFunction. There is no syntactic means to create instances of AsyncFunction subclasses.
27.7.1.1 AsyncFunction (p1,p2, … ,pn,body )
The last argument specifies the body (executable code) of an async function. Any preceding arguments specify formal parameters.
When theAsyncFunction function is called with some argumentsp1,p2, … ,pn,body (wheren might be 0, that is, there are nop arguments, and wherebody might also not be provided), the following steps are taken:
The initial value of the@@toStringTag property is the String value"AsyncFunction".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:true }.
27.7.4 AsyncFunction Instances
Every AsyncFunction instance is an ECMAScriptfunction object and has the internal slots listed inTable 29. The value of the [[IsClassConstructor]] internal slot for all such instances isfalse. AsyncFunction instances are not constructors and do not have a [[Construct]] internal method. AsyncFunction instances do not have a prototype property as they are not constructible.
Each AsyncFunction instance has the following own properties:
27.7.4.1 length
The specification for the"length" property of Function instances given in20.2.4.1 also applies to AsyncFunction instances.
27.7.4.2 name
The specification for the"name" property of Function instances given in20.2.4.2 also applies to AsyncFunction instances.
The abstract operation AsyncFunctionStart takes argumentspromiseCapability (aPromiseCapability Record) andasyncFunctionBody. It performs the following steps when called:
8.Assert:result is a normal completion with a value ofundefined. The possible sources of completion values areAwait or, if the async function doesn't await anything, step4.g above.
9.Return.
28 Reflection
28.1 The Reflect Object
The Reflect object:
is%Reflect%.
is the initial value of the"Reflect" property of theglobal object.
does not have a"prototype" property because Proxy exotic objects do not have a [[Prototype]] internal slot that requires initialization.
has the following properties:
28.2.2.1 Proxy.revocable (target,handler )
TheProxy.revocable function is used to create a revocable Proxy object. WhenProxy.revocable is called with argumentstarget andhandler, the following steps are taken:
The"length" property of a Proxy revocation function is+0𝔽.
28.3 Module Namespace Objects
A Module Namespace Object is amodule namespace exotic object that provides runtime property-based access to a module's exported bindings. There is noconstructor function for Module Namespace Objects. Instead, such an object is created for each module that is imported by anImportDeclaration that includes aNameSpaceImport.
In addition to the properties specified in10.4.6 each Module Namespace Object has the following own property:
28.3.1 @@toStringTag
The initial value of the@@toStringTag property is the String value"Module".
This property has the attributes { [[Writable]]:false, [[Enumerable]]:false, [[Configurable]]:false }.
29 Memory Model
The memory consistency model, ormemory model, specifies the possible orderings ofShared Data Block events, arising via accessing TypedArray instances backed by a SharedArrayBuffer and via methods on the Atomics object. When the program has no data races (defined below), the ordering of events appears as sequentially consistent, i.e., as an interleaving of actions from eachagent. When the program has data races, shared memory operations may appear sequentially inconsistent. For example, programs may exhibit causality-violating behaviour and other astonishments. These astonishments arise from compiler transforms and the design of CPUs (e.g., out-of-order execution and speculation). The memory model defines both the precise conditions under which a program exhibits sequentially consistent behaviour as well as the possible values read from data races. To wit, there is no undefined behaviour.
The memory model is defined as relational constraints on events introduced byabstract operations on SharedArrayBuffer or by methods on the Atomics object during an evaluation.
Note
This section provides an axiomatic model on events introduced by theabstract operations on SharedArrayBuffers. It bears stressing that the model is not expressible algorithmically, unlike the rest of this specification. The nondeterministic introduction of events byabstract operations is the interface between the operational semantics of ECMAScript evaluation and the axiomatic semantics of the memory model. The semantics of these events is defined by considering graphs of all events in an evaluation. These are neither Static Semantics nor Runtime Semantics. There is no demonstrated algorithmic implementation, but instead a set of constraints that determine if a particular event graph is allowed or disallowed.
29.1 Memory Model Fundamentals
Shared memory accesses (reads and writes) are divided into two groups, atomic accesses and data accesses, defined below. Atomic accesses are sequentially consistent, i.e., there is a strict total ordering of events agreed upon by all agents in anagent cluster. Non-atomic accesses do not have a strict total ordering agreed upon by all agents, i.e., unordered.
Note 1
No orderings weaker than sequentially consistent and stronger than unordered, such as release-acquire, are supported.
AShared Data Block event is either aReadSharedMemory,WriteSharedMemory, orReadModifyWriteSharedMemoryRecord.
An abstract closure that returns a modifiedList of byte values from a readList of byte values and [[Payload]].
These events are introduced byabstract operations or by methods on the Atomics object.
Some operations may also introduceSynchronize events. ASynchronize event has no fields, and exists purely to directly constrain the permitted orderings of other events.
In addition toShared Data Block and Synchronize events, there arehost-specific events.
Let the range of a ReadSharedMemory, WriteSharedMemory, or ReadModifyWriteSharedMemory event be the Set of contiguous integers from its [[ByteIndex]] to [[ByteIndex]] + [[ElementSize]] - 1. Two events' ranges are equal when the events have the same [[Block]], and the ranges are element-wise equal. Two events' ranges are overlapping when the events have the same [[Block]], the ranges are not equal and their intersection is non-empty. Two events' ranges are disjoint when the events do not have the same [[Block]] or their ranges are neither equal nor overlapping.
Note 2
Examples ofhost-specific synchronizing events that should be accounted for are: sending a SharedArrayBuffer from oneagent to another (e.g., bypostMessage in a browser), starting and stopping agents, and communicating within theagent cluster via channels other than shared memory. It is assumed those events are appended toagent-order during evaluation like the other SharedArrayBuffer events.
Events are ordered within candidate executions by the relations defined below.
29.2 Agent Events Records
AnAgent Events Record is aRecord with the following fields.
The read-modify-write modification [[ModifyOp]] is given by the function properties on the Atomics object that introduceReadModifyWriteSharedMemory events.
For acandidate executionexecution,execution.[[AgentOrder]] is aRelation on events that satisfies the following.
For each pair (E,D) inEventSet(execution), (E,D) is inexecution.[[AgentOrder]] if there is someAgent Events Recordaer inexecution.[[EventsRecords]] such thatE andD are inaer.[[EventList]] andE is beforeD inList order ofaer.[[EventList]].
Note
Eachagent introduces events in a per-agentstrict total order during the evaluation. This is the union of those strict total orders.
If (E,D) is inexecution.[[HostSynchronizesWith]],E andD are inHostEventSet(execution).
There is no cycle in the union ofexecution.[[HostSynchronizesWith]] andexecution.[[AgentOrder]].
Note 1
For twohost-specific eventsE andD,E host-synchronizes-withD impliesEhappens-beforeD.
Note 2
The host-synchronizes-with relation allows thehost to provide additional synchronization mechanisms, such aspostMessage between HTML workers.
29.6.5 synchronizes-with
For acandidate executionexecution,execution.[[SynchronizesWith]] is the leastRelation on events that satisfies the following.
For each pair (R,W) inexecution.[[ReadsFrom]], (W,R) is inexecution.[[SynchronizesWith]] ifR.[[Order]] isSeqCst,W.[[Order]] isSeqCst, andR andW have equal ranges.
For each elementeventsRecord ofexecution.[[EventsRecords]], the following is true.
For each pair (S,Sw) ineventsRecord.[[AgentSynchronizesWith]], (S,Sw) is inexecution.[[SynchronizesWith]].
For each pair (E,D) inexecution.[[HostSynchronizesWith]], (E,D) is inexecution.[[SynchronizesWith]].
Note 1
Owing to convention, write events synchronizes-with read events, instead of read events synchronizes-with write events.
Note 2
Init events do not participate in synchronizes-with, and are instead constrained directly byhappens-before.
Note 3
Not allSeqCst events related byreads-from are related by synchronizes-with. Only events that also have equal ranges are related by synchronizes-with.
For acandidate executionexecution,execution.[[HappensBefore]] is the leastRelation on events that satisfies the following.
For each pair (E,D) inexecution.[[AgentOrder]], (E,D) is inexecution.[[HappensBefore]].
For each pair (E,D) inexecution.[[SynchronizesWith]], (E,D) is inexecution.[[HappensBefore]].
For each pair (E,D) inSharedDataBlockEventSet(execution), (E,D) is inexecution.[[HappensBefore]] ifE.[[Order]] isInit andE andD have overlapping ranges.
For each pair (E,D) inEventSet(execution), (E,D) is inexecution.[[HappensBefore]] if there is an eventF such that the pairs (E,F) and (F,D) are inexecution.[[HappensBefore]].
Note
Because happens-before is a superset ofagent-order, candidate executions are consistent with the single-thread evaluation semantics of ECMAScript.
29.7 Properties of Valid Executions
29.7.1 Valid Chosen Reads
Acandidate executionexecution has valid chosen reads if the following abstract operation returnstrue.
ii.If there is aWriteSharedMemory orReadModifyWriteSharedMemory eventV that hasbyteLocation in its range such that the pairs (W,V) and (V,R) are inexecution.[[HappensBefore]], then
1.Returnfalse.
iii.SetbyteLocation tobyteLocation + 1.
2.Returntrue.
29.7.3 Tear Free Reads
Acandidate executionexecution has tear free reads if the following abstract operation returnstrue.
i.Assert: The remainder of dividingR.[[ByteIndex]] byR.[[ElementSize]] is 0.
ii.For each eventW such that (R,W) is inexecution.[[ReadsFrom]] andW.[[NoTear]] istrue, do
1.IfR andW have equal ranges, and there is an eventV such thatV andW have equal ranges,V.[[NoTear]] istrue,W is notV, and (R,V) is inexecution.[[ReadsFrom]], then
a.Returnfalse.
2.Returntrue.
Note
An event's [[NoTear]] field istrue when that event was introduced via accessing aninteger TypedArray, andfalse when introduced via accessing a floating point TypedArray or DataView.
Intuitively, this requirement says when a memory range is accessed in an aligned fashion via aninteger TypedArray, a single write event on that range must "win" when in a data race with other write events with equal ranges. More precisely, this requirement says an aligned read event cannot read a value composed of bytes from multiple, different write events all with equal ranges. It is possible, however, for an aligned read event to read from multiple write events with overlapping ranges.
For each pair (E,D) inexecution.[[HappensBefore]], (E,D) is in memory-order.
For each pair (R,W) inexecution.[[ReadsFrom]], there is noWriteSharedMemory orReadModifyWriteSharedMemory eventV inSharedDataBlockEventSet(execution) such thatV.[[Order]] isSeqCst, the pairs (W,V) and (V,R) are in memory-order, and any of the following conditions are true.
The pair (W,R) is inexecution.[[SynchronizesWith]], andV andR have equal ranges.
The pairs (W,R) and (V,R) are inexecution.[[HappensBefore]],W.[[Order]] isSeqCst, andW andV have equal ranges.
The pairs (W,R) and (W,V) are inexecution.[[HappensBefore]],R.[[Order]] isSeqCst, andV andR have equal ranges.
Note 1
This clause additionally constrainsSeqCst events on equal ranges.
This clause together with the forward progress guarantee on agents ensure the liveness condition thatSeqCst writes become visible toSeqCst reads with equal range in finite time.
Acandidate execution has sequentially consistent atomics if a memory-order exists.
Note 3
While memory-order includes all events inEventSet(execution), those that are not constrained byhappens-before orsynchronizes-with are allowed to occur anywhere in the order.
29.7.5 Valid Executions
Acandidate executionexecution is a valid execution (or simply an execution) if all of the following are true.
ii.If either (E,D) or (D,E) is inexecution.[[ReadsFrom]], then
1.Returntrue.
2.Returnfalse.
29.9 Data Races
For an executionexecution, two eventsE andD inSharedDataBlockEventSet(execution) are in a data race if the following abstract operation returnstrue.
1.IfE andD are in a race inexecution, then
a.IfE.[[Order]] is notSeqCst orD.[[Order]] is notSeqCst, then
i.Returntrue.
b.IfE andD have overlapping ranges, then
i.Returntrue.
2.Returnfalse.
29.10 Data Race Freedom
An executionexecution is data race free if there are no two events inSharedDataBlockEventSet(execution) that are in a data race.
A program is data race free if all its executions are data race free.
Thememory model guarantees sequential consistency of all events for data race free programs.
29.11 Shared Memory Guidelines
Note 1
The following are guidelines for ECMAScript programmers working with shared memory.
We recommend programs be kept data race free, i.e., make it so that it is impossible for there to be concurrent non-atomic operations on the same memory location. Data race free programs have interleaving semantics where each step in the evaluation semantics of eachagent are interleaved with each other. For data race free programs, it is not necessary to understand the details of thememory model. The details are unlikely to build intuition that will help one to better write ECMAScript.
More generally, even if a program is not data race free it may have predictable behaviour, so long as atomic operations are not involved in any data races and the operations that race all have the same access size. The simplest way to arrange for atomics not to be involved in races is to ensure that different memory cells are used by atomic and non-atomic operations and that atomic accesses of different sizes are not used to access the same cells at the same time. Effectively, the program should treat shared memory as strongly typed as much as possible. One still cannot depend on the ordering and timing of non-atomic accesses that race, but if memory is treated as strongly typed the racing accesses will not "tear" (bits of their values will not be mixed).
Note 2
The following are guidelines for ECMAScript implementers writing compiler transformations for programs using shared memory.
It is desirable to allow most program transformations that are valid in a single-agent setting in a multi-agent setting, to ensure that the performance of eachagent in a multi-agent program is as good as it would be in a single-agent setting. Frequently these transformations are hard to judge. We outline some rules about program transformations that are intended to be taken as normative (in that they are implied by thememory model or stronger than what thememory model implies) but which are likely not exhaustive. These rules are intended to apply to program transformations that precede the introductions of the events that make up theagent-order.
Let anagent-order slice be the subset of theagent-order pertaining to a singleagent.
Letpossible read values of a read event be the set of all values ofValueOfReadEvent for that event across all valid executions.
Any transformation of an agent-order slice that is valid in the absence of shared memory is valid in the presence of shared memory, with the following exceptions.
Atomics are carved in stone: Program transformations must not cause theSeqCst events in an agent-order slice to be reordered with itsUnordered operations, nor itsSeqCst operations to be reordered with each other, nor may a program transformation remove aSeqCst operation from theagent-order.
(In practice, the prohibition on reorderings forces a compiler to assume that everySeqCst operation is a synchronization and included in the finalmemory-order, which it would usually have to assume anyway in the absence of inter-agent program analysis. It also forces the compiler to assume that every call where the callee's effects on thememory-order are unknown may containSeqCst operations.)
Reads must be stable: Any given shared memory read must only observe a single value in an execution.
(For example, if what is semantically a single read in the program is executed multiple times then the program is subsequently allowed to observe only one of the values read. A transformation known as rematerialization can violate this rule.)
Writes must be stable: All observable writes to shared memory must follow from program semantics in an execution.
(For example, a transformation may not introduce certain observable writes, such as by using read-modify-write operations on a larger location to write a smaller datum, writing a value to memory that the program could not have written, or writing a just-read value back to the location it was read from, if that location could have been overwritten by anotheragent after the read.)
Possible read values must be nonempty: Program transformations cannot cause the possible read values of a shared memory read to become empty.
(Counterintuitively, this rule in effect restricts transformations on writes, because writes have force inmemory model insofar as to be read by read events. For example, writes may be moved and coalesced and sometimes reordered between twoSeqCst operations, but the transformation may not remove every write that updates a location; some write must be preserved.)
Examples of transformations that remain valid are: merging multiple non-atomic reads from the same location, reordering non-atomic reads, introducing speculative non-atomic reads, merging multiple non-atomic writes to the same location, reordering non-atomic writes to different locations, and hoisting non-atomic reads out of loops even if that affects termination. Note in general that aliased TypedArrays make it hard to prove that locations are different.
Note 3
The following are guidelines for ECMAScript implementers generating machine code for shared memory accesses.
For architectures with memory models no weaker than those of ARM or Power, non-atomic stores and loads may be compiled to bare stores and loads on the target architecture. Atomic stores and loads may be compiled down to instructions that guarantee sequential consistency. If no such instructions exist, memory barriers are to be employed, such as placing barriers on both sides of a bare store or load. Read-modify-write operations may be compiled to read-modify-write instructions on the target architecture, such asLOCK-prefixed instructions on x86, load-exclusive/store-exclusive instructions on ARM, and load-link/store-conditional instructions on Power.
Specifically, thememory model is intended to allow code generation as follows.
Every atomic operation in the program is assumed to be necessary.
Atomic operations are never rearranged with each other or with non-atomic operations.
Functions are always assumed to perform atomic operations.
Atomic operations are never implemented as read-modify-write operations on larger data, but as non-lock-free atomics if the platform does not have atomic operations of the appropriate size. (We already assume that every platform has normal memory access operations of every interesting size.)
Naive code generation uses these patterns:
Regular loads and stores compile to single load and store instructions.
Lock-free atomic loads and stores compile to a full (sequentially consistent) fence, a regular load or store, and a full fence.
Lock-free atomic read-modify-write accesses compile to a full fence, an atomic read-modify-write instruction sequence, and a full fence.
Non-lock-free atomics compile to a spinlock acquire, a full fence, a series of non-atomic load and store instructions, a full fence, and a spinlock release.
That mapping is correct so long as an atomic operation on an address range does not race with a non-atomic write or with an atomic operation of different size. However, that is all we need: thememory model effectively demotes the atomic operations involved in a race to non-atomic status. On the other hand, the naive mapping is quite strong: it allows atomic operations to be used as sequentially consistent fences, which thememory model does not actually guarantee.
A number of local improvements to those basic patterns are also intended to be legal:
There are obvious platform-dependent improvements that remove redundant fences. For example, on x86 the fences around lock-free atomic loads and stores can always be omitted except for the fence following a store, and no fence is needed for lock-free read-modify-write instructions, as these all use LOCK-prefixed instructions. On many platforms there are fences of several strengths, and weaker fences can be used in certain contexts without destroying sequential consistency.
Most modern platforms support lock-free atomics for all the data sizes required by ECMAScript atomics. Should non-lock-free atomics be needed, the fences surrounding the body of the atomic operation can usually be folded into the lock and unlock steps. The simplest solution for non-lock-free atomics is to have a single lock word per SharedArrayBuffer.
There are also more complicated platform-dependent local improvements, requiring some code analysis. For example, two back-to-back fences often have the same effect as a single fence, so if code is generated for two atomic operations in sequence, only a single fence need separate them. On x86, even a single fence separating atomic stores can be omitted, as the fence following a store is only needed to separate the store from a subsequent load.
The ECMAScript language syntax and semantics defined in this annex are required when the ECMAScripthost is a web browser. The content of this annex is normative but optional if the ECMAScripthost is not a web browser.
Note
This annex describes various legacy features and other characteristics of web browser ECMAScript hosts. All of the language features and behaviours specified in this annex have one or more undesirable characteristics and in the absence of legacy usage would be removed from this specification. However, the usage of these features by large numbers of existing web pages means that web browsers must continue to support them. The specifications in this annex define the requirements for interoperable implementations of these legacy features.
These features are not considered part of the core ECMAScript language. Programmers should not use or assume the existence of these features and behaviours when writing new ECMAScript code. ECMAScript implementations are discouraged from implementing these features unless the implementation is part of a web browser or is required to run the same legacy ECMAScript code that web browsers encounter.
B.1 Additional Syntax
B.1.1 Numeric Literals
The syntax and semantics of12.8.3 is extended as follows except that this extension is not allowed forstrict mode code:
It is possible for string literals to precede aUse Strict Directive that places the enclosing code instrict mode, and implementations must take care to not use this extended definition ofEscapeSequence with such literals. For example, attempting to parse the following source text must fail:
The syntax of22.2.1 is modified and extended as follows. These changes introduce ambiguities that are broken by the ordering of grammar productions and by contextual information. When parsing using the following grammar, each alternative is considered only if previous production alternatives do not match.
This alternative pattern grammar and semantics only changes the syntax and semantics of BMP patterns. The following grammar extensions include productions parameterized with the [U] parameter. However, none of these extensions change the syntax of Unicode patterns recognized when parsing with the [U] parameter present on thegoal symbol.
Atom (22.2.2.8) evaluation rules for theAtom productions except forAtom::PatternCharacter are also used for theExtendedAtom productions, but withExtendedAtom substituted forAtom. The following evaluation rules, with parameterdirection, are also added:
The productionExtendedAtom::\[lookahead =c] evaluates as follows:
1.LetA be the CharSet containing the single character\ U+005C (REVERSE SOLIDUS).
Theescape function is a property of theglobal object. It computes a new version of a String value in which certain code units have been replaced by a hexadecimal escape sequence.
For those code units being replaced whose value is0x00FF or less, a two-digit escape sequence of the form%xx is used. For those characters being replaced whose code unit value is greater than0x00FF, a four-digit escape sequence of the form%uxxxx is used.
Theescape function is the%escape% intrinsic object. When theescape function is called with one argumentstring, the following steps are taken:
The encoding is partly based on the encoding described in RFC 1738, but the entire encoding specified in this standard is described above without regard to the contents of RFC 1738. This encoding does not reflect changes to RFC 1738 made by RFC 3986.
B.2.1.2 unescape (string )
Theunescape function is a property of theglobal object. It computes a new version of a String value in which each escape sequence of the sort that might be introduced by theescape function is replaced with the code unit that it represents.
Theunescape function is the%unescape% intrinsic object. When theunescape function is called with one argumentstring, the following steps are taken:
B.2.2 Additional Properties of the Object.prototype Object
B.2.2.1 Object.prototype.__proto__
Object.prototype.__proto__ is anaccessor property with attributes { [[Enumerable]]:false, [[Configurable]]:true }. The [[Get]] and [[Set]] attributes are defined as follows:
B.2.2.1.1 get Object.prototype.__proto__
The value of the [[Get]] attribute is a built-in function that requires no arguments. It performs the following steps when called:
B.2.3 Additional Properties of the String.prototype Object
B.2.3.1 String.prototype.substr (start,length )
Thesubstr method takes two arguments,start andlength, and returns asubstring of the result of converting thethis value to a String, starting from indexstart and running forlength code units (or through the end of the String iflength isundefined). Ifstart is negative, it is treated assourceLength +start wheresourceLength is the length of the String. The result is a String value, not a String object. The following steps are taken:
Thesubstr function is intentionally generic; it does not require that itsthis value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.
B.2.3.2 String.prototype.anchor (name )
When theanchor method is called with argumentname, the following steps are taken:
b.LetescapedV be the String value that is the same asV except that each occurrence of the code unit 0x0022 (QUOTATION MARK) inV has been replaced with the six code unit sequence""".
The property"trimStart" is preferred. The"trimLeft" property is provided principally for compatibility with old code. It is recommended that the"trimStart" property be used in new ECMAScript code.
The initial value of the"trimLeft" property is the samefunction object as the initial value of theString.prototype.trimStart property.
B.2.3.16 String.prototype.trimRight ( )
Note
The property"trimEnd" is preferred. The"trimRight" property is provided principally for compatibility with old code. It is recommended that the"trimEnd" property be used in new ECMAScript code.
The initial value of the"trimRight" property is the samefunction object as the initial value of theString.prototype.trimEnd property.
B.2.4 Additional Properties of the Date.prototype Object
B.2.4.1 Date.prototype.getYear ( )
Note
ThegetFullYear method is preferred for nearly all purposes, because it avoids the “year 2000 problem.”
When thegetYear method is called with no arguments, the following steps are taken:
11.Return the value of the [[DateValue]] internal slot ofthis Date object.
B.2.4.3 Date.prototype.toGMTString ( )
Note
ThetoUTCString method is preferred. ThetoGMTString method is provided principally for compatibility with old code.
Thefunction object that is the initial value ofDate.prototype.toGMTString is the samefunction object that is the initial value ofDate.prototype.toUTCString.
B.2.5 Additional Properties of the RegExp.prototype Object
B.2.5.1 RegExp.prototype.compile (pattern,flags )
When thecompile method is called with argumentspattern andflags, the following steps are taken:
Thecompile method completely reinitializes thethis value RegExp with a new pattern and flags. An implementation may interpret use of this method as an assertion that the resulting RegExp object will be used multiple times and hence is a candidate for extra optimization.
B.3 Other Additional Features
B.3.1 __proto__ Property Names in Object Initializers
The following Early Error rule is added to those in13.2.6.1. This rule isnot applied under any of the following circumstances:
Prior to ECMAScript 2015, the specification ofLabelledStatement did not allow for the association of a statement label with aFunctionDeclaration. However, a labelledFunctionDeclaration was an allowable extension fornon-strict code and most browser-hosted ECMAScript implementations supported that extension. In ECMAScript 2015 and later, the grammar production forLabelledStatement permits use ofFunctionDeclaration as aLabelledItem but14.13.1 includes an Early Error rule that produces a Syntax Error if that occurs. That rule is modified with the addition of thehighlighted text:
B.3.3 Block-Level Function Declarations Web Legacy Compatibility Semantics
Prior to ECMAScript 2015, the ECMAScript specification did not define the occurrence of aFunctionDeclaration as an element of aBlock statement'sStatementList. However, support for that form ofFunctionDeclaration was an allowable extension and most browser-hosted ECMAScript implementations permitted them. Unfortunately, the semantics of such declarations differ among those implementations. Because of these semantic differences, existing web ECMAScript code that usesBlock level function declarations is only portable among browser implementation if the usage only depends upon the semantic intersection of all of the browser implementations for such declarations. The following are the use cases that fall within that intersection semantics:
A function is declared and only referenced within a single block
One or moreFunctionDeclarations whoseBindingIdentifier is the namef occur within the function code of an enclosing functiong and that declaration is nested within aBlock.
No other declaration off that is not avar declaration occurs within the function code ofg
A function is declared and possibly used within a singleBlock but also referenced by an inner function definition that is not contained within that sameBlock.
One or moreFunctionDeclarations whoseBindingIdentifier is the namef occur within the function code of an enclosing functiong and that declaration is nested within aBlock.
No other declaration off that is not avar declaration occurs within the function code ofg
There is at least one occurrence off as anIdentifierReference within another functionh that is nested withing and no other declaration off shadows the references tof from withinh.
All invocations ofh occur after the declaration off has been evaluated.
A function is declared and possibly used within a single block but also referenced within subsequent blocks.
One or moreFunctionDeclaration whoseBindingIdentifier is the namef occur within the function code of an enclosing functiong and that declaration is nested within aBlock.
No other declaration off that is not avar declaration occurs within the function code ofg
There is at least one occurrence off as anIdentifierReference within the function code ofg that lexically follows theBlock containing the declaration off.
The first use case is interoperable with the semantics ofBlock level function declarations provided by ECMAScript 2015. Any pre-existing ECMAScript code that employs that use case will operate using the Block level function declarations semantics defined by clauses10,14, and15.
ECMAScript 2015 interoperability for the second and third use cases requires the following extensions to the clause10, clause15, clause19.2.1 and clause16.1.7 semantics.
If an ECMAScript implementation has a mechanism for reporting diagnostic warning messages, a warning should be produced when code contains aFunctionDeclaration for which these compatibility semantics are applied and introduce observable differences from non-compatibility semantics. For example, if a var binding is not introduced because its introduction would create anearly error, a warning message should not be produced.
B.3.3.1 Changes to FunctionDeclarationInstantiation
1.NOTE: A var binding forF is only instantiated here if it is neither a VarDeclaredName, the name of a formal parameter, or anotherFunctionDeclaration.
2.IfinitializedBindings does not containF andF is not"arguments", then
It is a Syntax Error if theLexicallyDeclaredNames ofStatementList contains any duplicate entries, unless the source code matching this production is notstrict mode code and the duplicate entries are only bound by FunctionDeclarations.
It is a Syntax Error if theLexicallyDeclaredNames ofCaseBlock contains any duplicate entries, unless the source code matching this production is notstrict mode code and the duplicate entries are only bound by FunctionDeclarations.
This production only applies when parsingnon-strict code. Code matching this production is processed as if each matching occurrence ofFunctionDeclaration[?Yield, ?Await, ~Default] was the soleStatementListItem of aBlockStatement occupying that position in the source code. The semantics of such a syntheticBlockStatement includes the web legacy compatibility semantics specified inB.3.3.
B.3.5 VariableStatements in Catch Blocks
The content of subclause14.15.1 is replaced with the following:
TheBlock of aCatch clause may containvar declarations that bind a name that is also bound by theCatchParameter. At runtime, such bindings are instantiated in the VariableDeclarationEnvironment. They do not shadow the same-named bindings introduced by theCatchParameter and hence theInitializer for suchvar declarations will assign to the corresponding catch parameter rather than thevar binding.
This modified behaviour also applies tovar andfunction declarations introduced bydirect eval calls contained within theBlock of aCatch clause. This change is accomplished by modifying the algorithm of19.2.1.3 as follows:
Objects with an [[IsHTMLDDA]] internal slot are never created by this specification. However, thedocument.all object in web browsers is ahost-definedexotic object with this slot that exists for web compatibility purposes. There are no other known examples of this type of object and implementations should not create any with the exception ofdocument.all.
B.3.7.1 Changes to ToBoolean
The result column inTable 11 for an argument type of Object is replaced with the following algorithm:
Assignment to an undeclared identifier or otherwise unresolvable reference does not create a property in theglobal object. When a simple assignment occurs withinstrict mode code, itsLeftHandSideExpression must not evaluate to an unresolvableReference. If it does aReferenceError exception is thrown (6.2.4.5). TheLeftHandSideExpression also may not be a reference to adata property with the attribute value { [[Writable]]:false }, to anaccessor property with the attribute value { [[Set]]:undefined }, nor to a non-existent property of an object whose [[Extensible]] internal slot has the valuefalse. In these cases aTypeError exception is thrown (13.15).
Arguments objects for strict functions define a non-configurableaccessor property"callee" which throws aTypeError exception on access (10.4.4.6).
Arguments objects for strict functions do not dynamically share theirarray-indexed property values with the corresponding formal parameter bindings of their functions. (10.4.4).
For strict functions, if an arguments object is created the binding of the local identifierarguments to the arguments object is immutable and hence may not be the target of an assignment expression. (10.2.10).
Strict mode eval code cannot instantiate variables or functions in the variable environment of the caller to eval. Instead, a new variable environment is created and that environment is used for declaration binding instantiation for the eval code (19.2.1).
Ifthis is evaluated withinstrict mode code, then thethis value is not coerced to an object. Athis value ofundefined ornull is not converted to theglobal object and primitive values are not converted to wrapper objects. Thethis value passed via a function call (including calls made usingFunction.prototype.apply andFunction.prototype.call) do not coerce the passedthis value to an object (10.2.1.2,20.2.3.1,20.2.3.3).
When adelete operator occurs withinstrict mode code, aSyntaxError is thrown if itsUnaryExpression is a direct reference to a variable, function argument, or function name (13.5.1.1).
When adelete operator occurs withinstrict mode code, aTypeError is thrown if the property to be deleted has the attribute { [[Configurable]]:false } or otherwise cannot be deleted (13.5.1.2).
An implementation may not extend, beyond that defined in this specification, the meanings within strict functions of properties named"caller" or"arguments" of function instances.
Any of the essential internal methods inTable 6 for anyexotic object not specified within this specification.
D.6 Built-in Objects and Methods
Any built-in objects and methods not defined within this specification, except as restricted in17.1.
E Corrections and Clarifications in ECMAScript 2015 with Possible Compatibility Impact
9.1.1.4.15-9.1.1.4.18 Edition 5 and 5.1 used a property existence test to determine whether aglobal object property corresponding to a new global declaration already existed. ECMAScript 2015 uses an own property existence test. This corresponds to what has been most commonly implemented by web browsers.
10.4.2.1: The 5th Edition moved the capture of the current array length prior to theinteger conversion of thearray index or new length value. However, the captured length value could become invalid if the conversion process has the side-effect of changing the array length. ECMAScript 2015 specifies that the current array length must be captured after the possible occurrence of such side-effects.
21.4.1.14: Previous editions permitted theTimeClip abstract operation to return either+0𝔽 or-0𝔽 as the representation of a 0time value. ECMAScript 2015 specifies that+0𝔽 always returned. This means that for ECMAScript 2015 thetime value of a Date object is never observably-0𝔽 and methods that return time values never return-0𝔽.
21.4.1.15: If a UTC offset representation is not present, the local time zone is used. Edition 5.1 incorrectly stated that a missing time zone should be interpreted as"z".
21.4.4.36: If the year cannot be represented using the Date Time String Format specified in21.4.1.15 a RangeError exception is thrown. Previous editions did not specify the behaviour for that case.
21.4.4.41: Previous editions did not specify the value returned byDate.prototype.toString whenthis time value isNaN. ECMAScript 2015 specifies the result to be the String value"Invalid Date".
22.2.3.1,22.2.3.2.5: Any LineTerminator code points in the value of the"source" property of a RegExp instance must be expressed using an escape sequence. Edition 5.1 only required the escaping of/.
22.2.5.7,22.2.5.10: In previous editions, the specifications forString.prototype.match andString.prototype.replace was incorrect for cases where the pattern argument was a RegExp value whoseglobal flag is set. The previous specifications stated that for each attempt to match the pattern, iflastIndex did not change it should be incremented by 1. The correct behaviour is thatlastIndex should be incremented by one only if the pattern matched the empty String.
23.1.3.27,23.1.3.27.1: Previous editions did not specify how aNaN value returned by acomparefn was interpreted byArray.prototype.sort. ECMAScript 2015 specifies that such as value is treated as if+0𝔽 was returned from thecomparefn. ECMAScript 2015 also specifies thatToNumber is applied to the result returned by acomparefn. In previous editions, the effect of acomparefn result that is not aNumber value wasimplementation-defined. In practice, implementations callToNumber.
F Additions and Changes That Introduce Incompatibilities with Prior Editions
6.2.4: In ECMAScript 2015, Function calls are not allowed to return aReference Record.
9.2: In ECMAScript 2018, Template objects are canonicalized based onParse Node (source location), instead of across all occurrences of that template literal or tagged template in aRealm in previous editions.
12.2: In ECMAScript 2016, Unicode 8.0.0 or higher is mandated, as opposed to ECMAScript 2015 which mandated Unicode 5.1. In particular, this caused U+180E MONGOLIAN VOWEL SEPARATOR, which was in theSpace_Separator (Zs) category and thus treated as whitespace in ECMAScript 2015, to be moved to theFormat (Cf) category (as of Unicode 6.3.0). This causes whitespace-sensitive methods to behave differently. For example,"\u180E".trim().length was0 in previous editions, but1 in ECMAScript 2016 and later. Additionally, ECMAScript 2017 mandated always using the latest version of the Unicode standard.
12.6: In ECMAScript 2015, the valid code points for anIdentifierName are specified in terms of the Unicode properties “ID_Start” and “ID_Continue”. In previous editions, the validIdentifierName orIdentifier code points were specified by enumerating various Unicode code point categories.
12.9.1: In ECMAScript 2015, Automatic Semicolon Insertion adds a semicolon at the end of a do-while statement if the semicolon is missing. This change aligns the specification with the actual behaviour of most existing implementations.
13.2.6.1: In ECMAScript 2015, it is no longer anearly error to have duplicate property names in Object Initializers.
13.15.1: In ECMAScript 2015,strict mode code containing an assignment to an immutable binding such as the function name of aFunctionExpression does not produce anearly error. Instead it produces a runtime error.
14.2: In ECMAScript 2015, aStatementList beginning with the token let followed by the input elementsLineTerminator thenIdentifier is the start of aLexicalDeclaration. In previous editions, automatic semicolon insertion would always insert a semicolon before theIdentifier input element.
14.6.2: In ECMAScript 2015, the normal completion value of anIfStatement is never the valueempty. If noStatement part is evaluated or if the evaluatedStatement part produces a normal completion whose value isempty, the completion value of theIfStatement isundefined.
14.7: In ECMAScript 2015, if the( token of a for statement is immediately followed by the token sequencelet [ then thelet is treated as the start of aLexicalDeclaration. In previous editions such a token sequence would be the start of anExpression.
14.7: In ECMAScript 2015, if the ( token of a for-in statement is immediately followed by the token sequencelet [ then thelet is treated as the start of aForDeclaration. In previous editions such a token sequence would be the start of anLeftHandSideExpression.
14.7: Prior to ECMAScript 2015, an initialization expression could appear as part of theVariableDeclaration that precedes theinkeyword. In ECMAScript 2015, theForBinding in that same position does not allow the occurrence of such an initializer. In ECMAScript 2017, such an initializer is permitted only innon-strict code.
14.7: In ECMAScript 2015, the completion value of anIterationStatement is never the valueempty. If theStatement part of anIterationStatement is not evaluated or if the final evaluation of theStatement part produces a completion whose value isempty, the completion value of theIterationStatement isundefined.
14.11.2: In ECMAScript 2015, the normal completion value of aWithStatement is never the valueempty. If evaluation of theStatement part of aWithStatement produces a normal completion whose value isempty, the completion value of theWithStatement isundefined.
14.15: In ECMAScript 2015, it is anearly error for aCatch clause to contain avar declaration for the sameIdentifier that appears as theCatch clause parameter. In previous editions, such a variable declaration would be instantiated in the enclosing variable environment but the declaration'sInitializer value would be assigned to theCatch parameter.
14.15,19.2.1.3: In ECMAScript 2015, a runtimeSyntaxError is thrown if aCatch clause evaluates a non-strict directeval whose eval code includes avar orFunctionDeclaration declaration that binds the sameIdentifier that appears as theCatch clause parameter.
14.15.3: In ECMAScript 2015, the completion value of aTryStatement is never the valueempty. If theBlock part of aTryStatement evaluates to a normal completion whose value isempty, the completion value of theTryStatement isundefined. If theBlock part of aTryStatement evaluates to a throw completion and it has aCatch part that evaluates to a normal completion whose value isempty, the completion value of theTryStatement isundefined if there is noFinally clause or if itsFinally clause evaluates to anempty normal completion.
15.4.5 In ECMAScript 2015, the function objects that are created as the values of the [[Get]] or [[Set]] attribute of accessor properties in anObjectLiteral are notconstructor functions and they do not have a"prototype" own property. In the previous edition, they were constructors and had a"prototype" property.
20.1.2.6: In ECMAScript 2015, if the argument toObject.freeze is not an object it is treated as if it was a non-extensibleordinary object with no own properties. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.8: In ECMAScript 2015, if the argument toObject.getOwnPropertyDescriptor is not an object an attempt is made to coerce the argument usingToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.10: In ECMAScript 2015, if the argument toObject.getOwnPropertyNames is not an object an attempt is made to coerce the argument usingToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.12: In ECMAScript 2015, if the argument toObject.getPrototypeOf is not an object an attempt is made to coerce the argument usingToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.14: In ECMAScript 2015, if the argument toObject.isExtensible is not an object it is treated as if it was a non-extensibleordinary object with no own properties. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.15: In ECMAScript 2015, if the argument toObject.isFrozen is not an object it is treated as if it was a non-extensibleordinary object with no own properties. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.16: In ECMAScript 2015, if the argument toObject.isSealed is not an object it is treated as if it was a non-extensibleordinary object with no own properties. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.17: In ECMAScript 2015, if the argument toObject.keys is not an object an attempt is made to coerce the argument usingToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.18: In ECMAScript 2015, if the argument toObject.preventExtensions is not an object it is treated as if it was a non-extensibleordinary object with no own properties. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.1.2.20: In ECMAScript 2015, if the argument toObject.seal is not an object it is treated as if it was a non-extensibleordinary object with no own properties. In the previous edition, a non-object argument always causes aTypeError to be thrown.
20.2.3.2: In ECMAScript 2015, the [[Prototype]] internal slot of abound function is set to the [[GetPrototypeOf]] value of its target function. In the previous edition, [[Prototype]] was always set to%Function.prototype%.
20.2.4.1: In ECMAScript 2015, the"length" property of function instances is configurable. In previous editions it was non-configurable.
21.4.4 In ECMAScript 2015, theDate prototype object is not a Date instance. In previous editions it was a Date instance whose TimeValue wasNaN.
22.1.3.10 In ECMAScript 2015, theString.prototype.localeCompare function must treat Strings that are canonically equivalent according to the Unicode standard as being identical. In previous editions implementations were permitted to ignore canonical equivalence and could instead use a bit-wise comparison.
22.1.3.26 and22.1.3.28 In ECMAScript 2015, lowercase/upper conversion processing operates on code points. In previous editions such the conversion processing was only applied to individual code units. The only affected code points are those in the Deseret block of Unicode.
22.1.3.29 In ECMAScript 2015, theString.prototype.trim method is defined to recognize white space code points that may exists outside of the Unicode BMP. However, as of Unicode 7 no such code points are defined. In previous editions such code points would not have been recognized as white space.
22.2.3.1 In ECMAScript 2015, If thepattern argument is a RegExp instance and theflags argument is notundefined, a new RegExp instance is created just likepattern except thatpattern's flags are replaced by the argumentflags. In previous editions aTypeError exception was thrown whenpattern was a RegExp instance andflags was notundefined.
22.2.5 In ECMAScript 2015, theRegExp prototype object is not a RegExp instance. In previous editions it was a RegExp instance whose pattern is the empty String.
22.2.5 In ECMAScript 2015,"source","global","ignoreCase", and"multiline" are accessor properties defined on theRegExp prototype object. In previous editions they were data properties defined on RegExp instances.
25.4.12: In ECMAScript 2019,Atomics.wake has been renamed toAtomics.notify to prevent confusion withAtomics.wait.
27.1.4.4,27.6.3.6: In ECMAScript 2019, the number of Jobs enqueued byawait was reduced, which could create an observable difference in resolution order between athen() call and anawait expression.
G Colophon
This specification is authored onGitHub in a plaintext source format calledEcmarkup. Ecmarkup is an HTML and Markdown dialect that provides a framework and toolset for authoring ECMAScript specifications in plaintext and processing the specification into a full-featured HTML rendering that follows the editorial conventions for this document. Ecmarkup builds on and integrates a number of other formats and technologies includingGrammarkdown for defining syntax andEcmarkdown for authoring algorithm steps. PDF renderings of this specification are produced by printing the HTML rendering to a PDF.
Prior editions of this specification were authored using Word—the Ecmarkup source text that formed the basis of this edition was produced by converting the ECMAScript 2015 Word document to Ecmarkup using an automated conversion tool.
H Bibliography
IEEE 754-2019:IEEE Standard for Floating-Point Arithmetic. Institute of Electrical and Electronic Engineers, New York (2019)Note
There are no normative changes between IEEE 754-2008 and IEEE 754-2019 that affect the ECMA-262 specification.
This document may be copied, published and distributed to others, and certain derivative works of it may be prepared, copied, published, and distributed, in whole or in part, provided that the above copyright notice and this Copyright License and Disclaimer are included on all such copies and derivative works. The only derivative works that are permissible under this Copyright License and Disclaimer are:
(i) works which incorporate all or portion of this document for the purpose of providing commentary or explanation (such as an annotated version of the document),
(ii) works which incorporate all or portion of this document for the purpose of incorporating features that provide accessibility,
(iii) translations of this document into languages other than English and into different formats and
(iv) works by making use of this specification in standard conformant products by implementing (e.g. by copy and paste wholly or partly) the functionality therein.
However, the content of this document itself may not be modified in any way, including by removing the copyright notice or references to Ecma International, except as required to translate it into languages other than English or into a different format.
The official version of an Ecma International document is the English language version on the Ecma International website. In the event of discrepancies between a translated version and the official version, the official version shall govern.
The limited permissions granted above are perpetual and will not be revoked by Ecma International or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and ECMA INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Software License
All Software contained in this document ("Software") is protected by copyright and is being made available under the "BSD License", included below. This Software may be subject to third party rights (rights from parties other than Ecma International), including patent rights, and no licenses under such third party rights are granted under this license even if the third party concerned is a member of Ecma International. SEE THE ECMA CODE OF CONDUCT IN PATENT MATTERS AVAILABLE AT https://ecma-international.org/memento/codeofconduct.htm FOR INFORMATION REGARDING THE LICENSING OF PATENT CLAIMS THAT ARE REQUIRED TO IMPLEMENT ECMA INTERNATIONAL STANDARDS.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the authors nor Ecma International may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE ECMA INTERNATIONAL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ECMA INTERNATIONAL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.