Editorial: Make GetIterator's hint parameter required (#3021)

Author: syg

spec.html

@@ -6819,14 +6819,13 @@ <h1>
       <h1>
         GetIterator (
           _obj_: an ECMAScript language value,
-          optional _hint_: ~sync~ or ~async~,
+          _kind_: ~sync~ or ~async~,
         ): either a normal completion containing an Iterator Record or a throw completion
       </h1>
       <dl class="header">
       </dl>
       <emu-alg>
-        1. If _hint_ is not present, set _hint_ to ~sync~.
-        1. If _hint_ is ~async~, then
+        1. If _kind_ is ~async~, then
           1. Let _method_ be ? GetMethod(_obj_, @@asyncIterator).
           1. If _method_ is *undefined*, then
             1. Let _syncMethod_ be ? GetMethod(_obj_, @@iterator).
@@ -9363,7 +9362,7 @@ <h1>
       </emu-alg>
       <emu-grammar>BindingPattern : ArrayBindingPattern</emu-grammar>
       <emu-alg>
-        1. Let _iteratorRecord_ be ? GetIterator(_value_).
+        1. Let _iteratorRecord_ be ? GetIterator(_value_, ~sync~).
         1. Let _result_ be Completion(IteratorBindingInitialization of |ArrayBindingPattern| with arguments _iteratorRecord_ and _environment_).
         1. If _iteratorRecord_.[[Done]] is *false*, return ? IteratorClose(_iteratorRecord_, _result_).
         1. Return ? _result_.
@@ -18058,7 +18057,7 @@ <h1>
         <emu-alg>
           1. Let _spreadRef_ be ? Evaluation of |AssignmentExpression|.
           1. Let _spreadObj_ be ? GetValue(_spreadRef_).
-          1. Let _iteratorRecord_ be ? GetIterator(_spreadObj_).
+          1. Let _iteratorRecord_ be ? GetIterator(_spreadObj_, ~sync~).
           1. Repeat,
             1. Let _next_ be ? IteratorStep(_iteratorRecord_).
             1. If _next_ is *false*, return _nextIndex_.
@@ -19099,7 +19098,7 @@ <h1>Runtime Semantics: ArgumentListEvaluation ( ): either a normal completion co
           1. Let _list_ be a new empty List.
           1. Let _spreadRef_ be ? Evaluation of |AssignmentExpression|.
           1. Let _spreadObj_ be ? GetValue(_spreadRef_).
-          1. Let _iteratorRecord_ be ? GetIterator(_spreadObj_).
+          1. Let _iteratorRecord_ be ? GetIterator(_spreadObj_, ~sync~).
           1. Repeat,
             1. Let _next_ be ? IteratorStep(_iteratorRecord_).
             1. If _next_ is *false*, return _list_.
@@ -19117,7 +19116,7 @@ <h1>Runtime Semantics: ArgumentListEvaluation ( ): either a normal completion co
         <emu-alg>
           1. Let _precedingArgs_ be ? ArgumentListEvaluation of |ArgumentList|.
           1. Let _spreadRef_ be ? Evaluation of |AssignmentExpression|.
-          1. Let _iteratorRecord_ be ? GetIterator(? GetValue(_spreadRef_)).
+          1. Let _iteratorRecord_ be ? GetIterator(? GetValue(_spreadRef_), ~sync~).
           1. Repeat,
             1. Let _next_ be ? IteratorStep(_iteratorRecord_).
             1. If _next_ is *false*, return _precedingArgs_.
@@ -20541,19 +20540,19 @@ <h1>
         </emu-alg>
         <emu-grammar>ArrayAssignmentPattern : `[` `]`</emu-grammar>
         <emu-alg>
-          1. Let _iteratorRecord_ be ? GetIterator(_value_).
+          1. Let _iteratorRecord_ be ? GetIterator(_value_, ~sync~).
           1. Return ? IteratorClose(_iteratorRecord_, NormalCompletion(~unused~)).
         </emu-alg>
         <emu-grammar>ArrayAssignmentPattern : `[` Elision `]`</emu-grammar>
         <emu-alg>
-          1. Let _iteratorRecord_ be ? GetIterator(_value_).
+          1. Let _iteratorRecord_ be ? GetIterator(_value_, ~sync~).
           1. Let _result_ be Completion(IteratorDestructuringAssignmentEvaluation of |Elision| with argument _iteratorRecord_).
           1. If _iteratorRecord_.[[Done]] is *false*, return ? IteratorClose(_iteratorRecord_, _result_).
           1. Return _result_.
         </emu-alg>
         <emu-grammar>ArrayAssignmentPattern : `[` Elision? AssignmentRestElement `]`</emu-grammar>
         <emu-alg>
-          1. Let _iteratorRecord_ be ? GetIterator(_value_).
+          1. Let _iteratorRecord_ be ? GetIterator(_value_, ~sync~).
           1. If |Elision| is present, then
             1. Let _status_ be Completion(IteratorDestructuringAssignmentEvaluation of |Elision| with argument _iteratorRecord_).
             1. If _status_ is an abrupt completion, then
@@ -20565,14 +20564,14 @@ <h1>
         </emu-alg>
         <emu-grammar>ArrayAssignmentPattern : `[` AssignmentElementList `]`</emu-grammar>
         <emu-alg>
-          1. Let _iteratorRecord_ be ? GetIterator(_value_).
+          1. Let _iteratorRecord_ be ? GetIterator(_value_, ~sync~).
           1. Let _result_ be Completion(IteratorDestructuringAssignmentEvaluation of |AssignmentElementList| with argument _iteratorRecord_).
           1. If _iteratorRecord_.[[Done]] is *false*, return ? IteratorClose(_iteratorRecord_, _result_).
           1. Return _result_.
         </emu-alg>
         <emu-grammar>ArrayAssignmentPattern : `[` AssignmentElementList `,` Elision? AssignmentRestElement? `]`</emu-grammar>
         <emu-alg>
-          1. Let _iteratorRecord_ be ? GetIterator(_value_).
+          1. Let _iteratorRecord_ be ? GetIterator(_value_, ~sync~).
           1. Let _status_ be Completion(IteratorDestructuringAssignmentEvaluation of |AssignmentElementList| with argument _iteratorRecord_).
           1. If _status_ is an abrupt completion, then
             1. If _iteratorRecord_.[[Done]] is *false*, return ? IteratorClose(_iteratorRecord_, _status_).
@@ -21903,9 +21902,9 @@ <h1>
             1. Return the Iterator Record { [[Iterator]]: _iterator_, [[NextMethod]]: _nextMethod_, [[Done]]: *false* }.
           1. Else,
             1. Assert: _iterationKind_ is either ~iterate~ or ~async-iterate~.
-            1. If _iterationKind_ is ~async-iterate~, let _iteratorHint_ be ~async~.
-            1. Else, let _iteratorHint_ be ~sync~.
-            1. Return ? GetIterator(_exprValue_, _iteratorHint_).
+            1. If _iterationKind_ is ~async-iterate~, let _iteratorKind_ be ~async~.
+            1. Else, let _iteratorKind_ be ~sync~.
+            1. Return ? GetIterator(_exprValue_, _iteratorKind_).
         </emu-alg>
       </emu-clause>
 
@@ -40402,7 +40401,7 @@ <h1>
           <dd>_adder_ will be invoked, with _target_ as the receiver.</dd>
         </dl>
         <emu-alg>
-          1. Let _iteratorRecord_ be ? GetIterator(_iterable_).
+          1. Let _iteratorRecord_ be ? GetIterator(_iterable_, ~sync~).
           1. Repeat,
             1. Let _next_ be ? IteratorStep(_iteratorRecord_).
             1. If _next_ is *false*, return _target_.
@@ -40714,7 +40713,7 @@ <h1>Set ( [ _iterable_ ] )</h1>
           1. If _iterable_ is either *undefined* or *null*, return _set_.
           1. Let _adder_ be ? Get(_set_, *"add"*).
           1. If IsCallable(_adder_) is *false*, throw a *TypeError* exception.
-          1. Let _iteratorRecord_ be ? GetIterator(_iterable_).
+          1. Let _iteratorRecord_ be ? GetIterator(_iterable_, ~sync~).
           1. Repeat,
             1. Let _next_ be ? IteratorStep(_iteratorRecord_).
             1. If _next_ is *false*, return _set_.
@@ -41153,7 +41152,7 @@ <h1>WeakSet ( [ _iterable_ ] )</h1>
           1. If _iterable_ is either *undefined* or *null*, return _set_.
           1. Let _adder_ be ? Get(_set_, *"add"*).
           1. If IsCallable(_adder_) is *false*, throw a *TypeError* exception.
-          1. Let _iteratorRecord_ be ? GetIterator(_iterable_).
+          1. Let _iteratorRecord_ be ? GetIterator(_iterable_, ~sync~).
           1. Repeat,
             1. Let _next_ be ? IteratorStep(_iteratorRecord_).
             1. If _next_ is *false*, return _set_.
@@ -44505,7 +44504,7 @@ <h1>Promise.all ( _iterable_ )</h1>
           1. Let _promiseCapability_ be ? NewPromiseCapability(_C_).
           1. Let _promiseResolve_ be Completion(GetPromiseResolve(_C_)).
           1. IfAbruptRejectPromise(_promiseResolve_, _promiseCapability_).
-          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_)).
+          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_, ~sync~)).
           1. IfAbruptRejectPromise(_iteratorRecord_, _promiseCapability_).
           1. Let _result_ be Completion(PerformPromiseAll(_iteratorRecord_, _C_, _promiseCapability_, _promiseResolve_)).
           1. If _result_ is an abrupt completion, then
@@ -44608,7 +44607,7 @@ <h1>Promise.allSettled ( _iterable_ )</h1>
           1. Let _promiseCapability_ be ? NewPromiseCapability(_C_).
           1. Let _promiseResolve_ be Completion(GetPromiseResolve(_C_)).
           1. IfAbruptRejectPromise(_promiseResolve_, _promiseCapability_).
-          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_)).
+          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_, ~sync~)).
           1. IfAbruptRejectPromise(_iteratorRecord_, _promiseCapability_).
           1. Let _result_ be Completion(PerformPromiseAllSettled(_iteratorRecord_, _C_, _promiseCapability_, _promiseResolve_)).
           1. If _result_ is an abrupt completion, then
@@ -44735,7 +44734,7 @@ <h1>Promise.any ( _iterable_ )</h1>
           1. Let _promiseCapability_ be ? NewPromiseCapability(_C_).
           1. Let _promiseResolve_ be Completion(GetPromiseResolve(_C_)).
           1. IfAbruptRejectPromise(_promiseResolve_, _promiseCapability_).
-          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_)).
+          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_, ~sync~)).
           1. IfAbruptRejectPromise(_iteratorRecord_, _promiseCapability_).
           1. Let _result_ be Completion(PerformPromiseAny(_iteratorRecord_, _C_, _promiseCapability_, _promiseResolve_)).
           1. If _result_ is an abrupt completion, then
@@ -44831,7 +44830,7 @@ <h1>Promise.race ( _iterable_ )</h1>
           1. Let _promiseCapability_ be ? NewPromiseCapability(_C_).
           1. Let _promiseResolve_ be Completion(GetPromiseResolve(_C_)).
           1. IfAbruptRejectPromise(_promiseResolve_, _promiseCapability_).
-          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_)).
+          1. Let _iteratorRecord_ be Completion(GetIterator(_iterable_, ~sync~)).
           1. IfAbruptRejectPromise(_iteratorRecord_, _promiseCapability_).
           1. Let _result_ be Completion(PerformPromiseRace(_iteratorRecord_, _C_, _promiseCapability_, _promiseResolve_)).
           1. If _result_ is an abrupt completion, then