- From: CVS User ihickson <cvsmail@w3.org>
- Date: Fri, 08 Mar 2013 20:08:03 +0000
- To: public-html-commits@w3.org
Update of /sources/public/html5/webstorage In directory roscoe:/tmp/cvs-serv20310 Modified Files: Overview.html Log Message: Cleanup (whatwg r7744) --- /sources/public/html5/webstorage/Overview.html 2013/02/13 00:03:25 1.214 +++ /sources/public/html5/webstorage/Overview.html 2013/03/08 20:08:03 1.215 @@ -215,7 +215,7 @@ <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p> <h1>Web Storage</h1> - <h2 class="no-num no-toc" id="editor-s-draft-13-february-2013">Editor's Draft 13 February 2013</h2> + <h2 class="no-num no-toc" id="editor-s-draft-8-march-2013">Editor's Draft 8 March 2013</h2> <dl><dt>Latest Published Version:</dt> <dd><a href="http://www.w3.org/TR/webstorage/">http://www.w3.org/TR/webstorage/</a></dd> <dt>Latest Editor's Draft:</dt> @@ -351,7 +351,7 @@ </dl><p>The W3C <a href="http://www.w3.org/2008/webapps/">Web Applications Working Group</a> is the W3C working group responsible for this specification's progress along the W3C Recommendation track. - This specification is the 13 February 2013 Editor's Draft. + This specification is the 8 March 2013 Editor's Draft. </p> @@ -593,7 +593,6 @@ <h3 id="the-storage-interface"><span class="secno">4.1 </span>The <code><a href="#storage-0">Storage</a></code> interface</h3> - <pre class="idl">interface <dfn id="storage-0">Storage</dfn> { readonly attribute unsigned long <a href="#dom-storage-length" title="dom-Storage-length">length</a>; DOMString? <a href="#dom-storage-key" title="dom-Storage-key">key</a>(unsigned long index); @@ -605,82 +604,66 @@ - <p>Each <code><a href="#storage-0">Storage</a></code> object provides access to a list of - key/value pairs, which are sometimes called items. Keys are - strings. Any string (including the empty string) is a valid - key. Values are similarly strings.</p> - - <p>Each <code><a href="#storage-0">Storage</a></code> object is associated with a list of - key/value pairs when it is created, as defined in the sections on - the <code title="dom-sessionStorage"><a href="#dom-sessionstorage">sessionStorage</a></code> and <code title="dom-localStorage"><a href="#dom-localstorage">localStorage</a></code> attributes. Multiple - separate objects implementing the <code><a href="#storage-0">Storage</a></code> interface can - all be associated with the same list of key/value pairs - simultaneously.</p> - - <p>The <dfn id="dom-storage-length" title="dom-Storage-length"><code>length</code></dfn> - attribute must return the number of key/value pairs currently - present in the list associated with the object.</p> - - <p>The <dfn id="dom-storage-key" title="dom-Storage-key"><code>key(<var title="">n</var>)</code></dfn> method must return the name of the - <var title="">n</var>th key in the list. The order of keys is - user-agent defined, but must be consistent within an object so long - as the number of keys doesn't change. (Thus, <a href="#dom-storage-setitem" title="dom-Storage-setItem">adding</a> or <a href="#dom-storage-removeitem" title="dom-Storage-removeItem">removing</a> a key may change the - order of the keys, but merely changing the value of an existing key - must not.) If <var title="">n</var> is greater than or equal to the number of key/value pairs + <p>Each <code><a href="#storage-0">Storage</a></code> object provides access to a list of key/value pairs, which are + sometimes called items. Keys are strings. Any string (including the empty string) is a valid key. + Values are similarly strings.</p> + + <p>Each <code><a href="#storage-0">Storage</a></code> object is associated with a list of key/value pairs when it is + created, as defined in the sections on the <code title="dom-sessionStorage"><a href="#dom-sessionstorage">sessionStorage</a></code> + and <code title="dom-localStorage"><a href="#dom-localstorage">localStorage</a></code> attributes. Multiple separate objects + implementing the <code><a href="#storage-0">Storage</a></code> interface can all be associated with the same list of + key/value pairs simultaneously.</p> + + <p>The <dfn id="dom-storage-length" title="dom-Storage-length"><code>length</code></dfn> attribute must return the number + of key/value pairs currently present in the list associated with the object.</p> + + <p>The <dfn id="dom-storage-key" title="dom-Storage-key"><code>key(<var title="">n</var>)</code></dfn> method must + return the name of the <var title="">n</var>th key in the list. The order of keys is user-agent + defined, but must be consistent within an object so long as the number of keys doesn't change. + (Thus, <a href="#dom-storage-setitem" title="dom-Storage-setItem">adding</a> or <a href="#dom-storage-removeitem" title="dom-Storage-removeItem">removing</a> a key may change the order of the keys, but merely + changing the value of an existing key must not.) If <var title="">n</var> is + greater than or equal to the number of key/value pairs in the object, then this method must return null.</p> - <p>The <span>supported property names</span> on a - <code><a href="#storage-0">Storage</a></code> object are the keys of each key/value pair - currently present in the list associated with the object, in the order that the keys were last - added to the storage area.</p> - - <p>The <dfn id="dom-storage-getitem" title="dom-Storage-getItem"><code>getItem(<var title="">key</var>)</code></dfn> method must return - the current value associated with - the given <var title="">key</var>. If the given <var title="">key</var> does not exist in the list associated with the - object then this method must return null. - </p> + <p>The <span>supported property names</span> on a <code><a href="#storage-0">Storage</a></code> object are the keys of each + key/value pair currently present in the list associated with the object, in the order that the + keys were last added to the storage area.</p> + + <p>The <dfn id="dom-storage-getitem" title="dom-Storage-getItem"><code>getItem(<var title="">key</var>)</code></dfn> method + must return the current value associated with the given <var title="">key</var>. If the given <var title="">key</var> does not exist in the list associated with the object then this method must + return null. </p> + + <p>The <dfn id="dom-storage-setitem" title="dom-Storage-setItem"><code>setItem(<var title="">key</var>, <var title="">value</var>)</code></dfn> method must first check if a key/value pair with the given <var title="">key</var> already exists in the list associated with the object.</p> - <p>The <dfn id="dom-storage-setitem" title="dom-Storage-setItem"><code>setItem(<var title="">key</var>, <var title="">value</var>)</code></dfn> method - must first check if a key/value pair - with the given <var title="">key</var> already exists in the list - associated with the object.</p> - - <p>If it does not, then a new key/value pair must be added to the - list, with the given <var title="">key</var> and with its value set - to <var title="">value</var>.</p> + <p>If it does not, then a new key/value pair must be added to the list, with the given <var title="">key</var> and with its value set to <var title="">value</var>.</p> <p>If the given <var title="">key</var> <em>does</em> exist in the list, and its value is not equal to <var title="">value</var>, then it must have its value updated to <var title="">value</var>. If its previous value <em>is</em> equal to <var title="">value</var>, then the method must do nothing.</p> - <p>If it couldn't set the new value, the method must throw an - <code>QuotaExceededError</code> exception. (Setting could fail if, - e.g., the user has disabled storage for the site, or if the quota - has been exceeded.)</p> - - <p>The <dfn id="dom-storage-removeitem" title="dom-Storage-removeItem"><code>removeItem(<var title="">key</var>)</code></dfn> method must cause the key/value - pair with the given <var title="">key</var> to be removed from the - list associated with the object, if it exists. If no item with that - key exists, the method must do nothing.</p> - - <p>The <code title="dom-Storage-setItem"><a href="#dom-storage-setitem">setItem()</a></code> and <code title="dom-Storage-removeItem"><a href="#dom-storage-removeitem">removeItem()</a></code> methods must be - atomic with respect to failure. In the case of failure, the method - does nothing. That is, changes to the data storage area must either - be successful, or the data storage area must not be changed at - all.</p> - - <p>The <dfn id="dom-storage-clear" title="dom-Storage-clear"><code>clear()</code></dfn> - method must atomically cause the list associated with the object to - be emptied of all key/value pairs, if there are any. If there are - none, then the method must do nothing.</p> + <p>If it couldn't set the new value, the method must throw an <code>QuotaExceededError</code> + exception. (Setting could fail if, e.g., the user has disabled storage for the site, or if the + quota has been exceeded.)</p> + + <p>The <dfn id="dom-storage-removeitem" title="dom-Storage-removeItem"><code>removeItem(<var title="">key</var>)</code></dfn> + method must cause the key/value pair with the given <var title="">key</var> to be removed from the + list associated with the object, if it exists. If no item with that key exists, the method must do + nothing.</p> + + <p>The <code title="dom-Storage-setItem"><a href="#dom-storage-setitem">setItem()</a></code> and <code title="dom-Storage-removeItem"><a href="#dom-storage-removeitem">removeItem()</a></code> methods must be atomic with respect to failure. + In the case of failure, the method does nothing. That is, changes to the data storage area must + either be successful, or the data storage area must not be changed at all.</p> + + <p>The <dfn id="dom-storage-clear" title="dom-Storage-clear"><code>clear()</code></dfn> method must atomically cause the + list associated with the object to be emptied of all key/value pairs, if there are any. If there + are none, then the method must do nothing.</p> <p class="note">When the <code title="dom-Storage-setItem"><a href="#dom-storage-setitem">setItem()</a></code>, <code title="dom-Storage-removeItem"><a href="#dom-storage-removeitem">removeItem()</a></code>, and <code title="dom-Storage-clear"><a href="#dom-storage-clear">clear()</a></code> methods are invoked, events are fired on the <code>Window</code> objects of other <code>Document</code>s that can access the newly stored or removed data, as defined in the sections on the <code title="dom-sessionStorage"><a href="#dom-sessionstorage">sessionStorage</a></code> and <code title="dom-localStorage"><a href="#dom-localstorage">localStorage</a></code> attributes.</p> - <p class="note">This specification does not require that the above - methods wait until the data has been physically written to - disk. Only consistency in what different scripts accessing the same + <p class="note">This specification does not require that the above methods wait until the data has + been physically written to disk. Only consistency in what different scripts accessing the same underlying list of key/value pairs see is required.</p>
Received on Friday, 8 March 2013 20:08:08 UTC