Sketch out IDBCursor.close()

Author: inexorabletash

index.bs

@@ -4299,6 +4299,7 @@ interface IDBCursor {
   void advance([EnforceRange] unsigned long count);
   void continue(optional any key);
   void continuePrimaryKey(any key, any primaryKey);
+  void close();
 
   [NewObject] IDBRequest update(any value);
   [NewObject] IDBRequest delete();
@@ -4342,7 +4343,8 @@ enum IDBCursorDirection {
 The <dfn attribute for=IDBCursor>source</dfn> attribute's getter must
 return [=/this=]'s [=cursor/source=]. This
 attribute never returns null or throws an exception, even if the
-cursor is currently being iterated, has iterated past its end, or its
+cursor is currently being iterated, has iterated past its end,
+{{IDBCursor/close()}} has been called, or its
 [=/transaction=] is not [=transaction/active=].
 
 The <dfn attribute for=IDBCursor>direction</dfn> attribute's getter
@@ -4412,6 +4414,12 @@ return [=/this=]'s [=cursor/request=].
         Advances the cursor to the next [=object-store/record=] in range matching
         or after |key| and |primaryKey|. Throws an "{{InvalidAccessError}}" {{DOMException}}
         if the [=cursor/source=] is not an [=/index=].
+
+
+    : |cursor| . {{IDBCursor/close()|close}}()
+    ::
+        Signals that the cursor is no longer needed, and that any associated resources can be released.
+
 </div>
 
 
@@ -4431,9 +4439,9 @@ invoked, must run these steps:
 1. If [=/this=]'s [=cursor/source=] or [=effective object
     store=] has been deleted, [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
-1. If [=/this=]'s [=cursor/got value flag=] is false, indicating that
-    the cursor is being iterated or has iterated past its end,
-    [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+1. If [=/this=]'s [=cursor/got value flag=] is false
+    (indicating that the cursor is being iterated, has iterated past its end, or that {{IDBCursor/close()}} was called),
+    then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
 1. Set [=/this=]'s [=cursor/got value flag=] to false.
 
@@ -4473,9 +4481,9 @@ invoked, must run these steps:
     [=effective object store=] has been deleted, [=throw=] an
     "{{InvalidStateError}}" {{DOMException}}.
 
-1. If [=/this=]'s [=cursor/got value flag=] is false, indicating that
-    the cursor is being iterated or has iterated past its end,
-    [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+1. If [=/this=]'s [=cursor/got value flag=] is false
+    (indicating that the cursor is being iterated, has iterated past its end, or that {{IDBCursor/close()}} was called),
+    then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
 1. If |key| is given, then:
 
@@ -4538,9 +4546,9 @@ The <dfn method for=IDBCursor>continuePrimaryKey(|key|,
 1. If [=/this=]'s [=cursor/direction=] is not {{"next"}} or {{"prev"}},
     [=throw=] an "{{InvalidAccessError}}" {{DOMException}}.
 
-1. If [=/this=]'s [=cursor/got value flag=] is false, indicating that
-    the cursor is being iterated or has iterated past its end,
-    [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+1. If [=/this=]'s [=cursor/got value flag=] is false
+    (indicating that the cursor is being iterated, has iterated past its end, or that {{IDBCursor/close()}} was called),
+    then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
 1. Let |r| be the result of running [=convert a value to
     a key=] with |key|. Rethrow any exceptions.
@@ -4599,6 +4607,39 @@ The <dfn method for=IDBCursor>continuePrimaryKey(|key|,
   flag=] has been set to false.
 </aside>
 
+<div class=algorithm>
+
+The <dfn method for=IDBCursor>close()</dfn> method, when invoked, must run these steps:
+
+1. Let |transaction| be [=/this=]'s [=cursor/transaction=].
+
+1. If |transaction|'s [=transaction/state=] is not [=transaction/active=], then [=throw=] a "{{TransactionInactiveError}}" {{DOMException}}.
+
+1. If [=/this=]'s [=cursor/source=] or [=effective object store=] has been deleted, then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+
+1. If [=/this=]'s [=cursor/got value flag=] is false
+    (indicating that the cursor is being iterated, has iterated past its end, or that {{IDBCursor/close()}} was called),
+    then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+
+1. Set [=/this=]'s [=cursor/got value flag=] to false.
+
+1. Set [=/this=]'s [=cursor/key=] to undefined.
+
+1. If [=/this=]'s [=cursor/source=] is an [=/index=], then set [=/this=]'s [=object store position=] to undefined.
+
+1. If [=/this=]'s [=cursor/key only flag=] is false, then set [=/this=]'s [=cursor/value=] to undefined.
+
+</div>
+
+<aside class=note>
+  The {{IDBCursor/close()}} method allows web applications to hint to the user agent that the cursor will no longer be iterated, and that any state associated with the cursor can be discarded.
+</aside>
+
+<aside class=advisement>
+  &#x1F6A7;
+  The {{IDBCursor/close()}} method is new in this edition.
+  &#x1F6A7;
+</aside>
 
 
 <div class="domintro note">
@@ -4643,9 +4684,9 @@ invoked, must run these steps:
 1. If [=/this=]'s [=cursor/source=] or [=effective object
     store=] has been deleted, [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
-1. If [=/this=]'s [=cursor/got value flag=] is false, indicating that
-    the cursor is being iterated or has iterated past its end,
-    [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+1. If [=/this=]'s [=cursor/got value flag=] is false
+    (indicating that the cursor is being iterated, has iterated past its end, or that {{IDBCursor/close()}} was called),
+    then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
 1. If [=/this=]'s [=cursor/key only flag=] is true, [=throw=] an
     "{{InvalidStateError}}" {{DOMException}}.
@@ -4709,9 +4750,9 @@ must run these steps:
 1. If [=/this=]'s [=cursor/source=] or [=effective object
     store=] has been deleted, [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
-1. If [=/this=]'s [=cursor/got value flag=] is false, indicating that
-    the cursor is being iterated or has iterated past its end,
-    [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
+1. If [=/this=]'s [=cursor/got value flag=] is false
+    (indicating that the cursor is being iterated, has iterated past its end, or that {{IDBCursor/close()}} was called),
+    then [=throw=] an "{{InvalidStateError}}" {{DOMException}}.
 
 1. If [=/this=]'s [=cursor/key only flag=] is true, [=throw=] an
     "{{InvalidStateError}}" {{DOMException}}.
@@ -6816,6 +6857,7 @@ For the revision history of the second edition, see [that document's Revision Hi
 * Transactions are now temporarily made inactive during clone operations.
 * Added {{IDBTransactionOptions/durability}} option and {{IDBTransaction/durability}} attribute. ([Issue #50](https://github.com/w3c/IndexedDB/issues/50))
 * Specified [[#transaction-scheduling]] more precisely and disallow starting read/write transactions while read-only transactions with overlapping scope are running. ([Issue #253](https://github.com/w3c/IndexedDB/issues/253))
+* Added {{IDBCursor/close()}} method for {{IDBCursor}}. ([Issue #185](https://github.com/w3c/IndexedDB/issues/185))
 
 <!-- ============================================================ -->
 # Acknowledgements # {#acknowledgements}