diff options
Diffstat (limited to 'files/fr/web/api/idbkeyrange/upperbound/index.md')
-rw-r--r-- | files/fr/web/api/idbkeyrange/upperbound/index.md | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/files/fr/web/api/idbkeyrange/upperbound/index.md b/files/fr/web/api/idbkeyrange/upperbound/index.md new file mode 100644 index 0000000000..6adcc4fe8b --- /dev/null +++ b/files/fr/web/api/idbkeyrange/upperbound/index.md @@ -0,0 +1,103 @@ +--- +title: IDBKeyRange.upperBound() +slug: Web/API/IDBKeyRange/upperBound +tags: + - API + - IDBKeyRange + - IndexedDB + - Méthode + - Reference +translation_of: Web/API/IDBKeyRange/upperBound +--- +<div>{{APIRef("IndexedDB")}}</div> + +<p>La méthode <strong><code>upperBound()</code></strong>, rattachée à l'interface {{domxref("IDBKeyRange")}}, crée un intervalle de clé avec une borne supérieure.</p> + +<p>Par défaut, la borne est inclue dans l'intervalle (autrement dit, il est fermé à droite).</p> + +<p>{{AvailableInWorkers}}</p> + +<h2 id="Syntaxe">Syntaxe</h2> + +<pre class="brush: js">IDBKeyRange.upperBound(borne); +IDBKeyRange.upperBound(borne, ouvert);</pre> + +<h3 id="Paramètres">Paramètres</h3> + +<dl> + <dt><code>borne</code></dt> + <dd>La valeur de la borne supérieure pour l'intervalle.</dd> + <dt><code>ouvert {{optional_inline}}</code></dt> + <dd>Ce booléen indique si l'intervalle est ouvert à droite (autrement dit, s'il vaut <code>false</code> la borne est inclue et s'il vaut <code>true</code> la borne n'est pas inclue dans l'intervalle).</dd> +</dl> + +<h3 id="Valeur_de_retour">Valeur de retour</h3> + +<p>Un objet {{domxref("IDBKeyRange")}} qui correspond à l'intervalle de clé créé.</p> + +<h3 id="Exceptions">Exceptions</h3> + +<p>Cette méthode peut lever une exception {{domxref("DOMException")}} de type <code>DataError</code> lorsque la valeur passée en paramètre n'est pas une clé valide.</p> + +<h2 id="Exemples">Exemples</h2> + +<p>Dans l'exemple qui suit, on illustre comment créer un intervalle de clé avec une borne supérieure, on utilise <code>keyRangeValue = IDBKeyRange.upperBound("F");</code> — cela permet de créer un intervalle qui contient "F" et les valeurs inférieures. On ouvre ensuite une transaction grâce à {{domxref("IDBTransaction")}}) puis un magasin d'objet et un curseur avec la méthode {{domxref("IDBObjectStore.openCursor")}} à laquelle on associe l'intervalle de clé <code>keyRangeValue</code>.</p> + +<p>Si on a avait utilisé <code>IDBKeyRange.upperBound("F", true);</code>, "F" n'aurait pas fait partie de l'intervalle.</p> + +<pre class="brush: js">function displayData() { + var keyRangeValue = IDBKeyRange.upperBound("F"); + + var transaction = db.transaction(['fThings'], 'readonly'); + var objectStore = transaction.objectStore('fThings'); + + objectStore.openCursor(keyRangeValue).onsuccess = function(event) { + var cursor = event.target.result; + if(cursor) { + var listItem = document.createElement('li'); + listItem.innerHTML = '<strong>' + cursor.value.fThing + '</strong>, ' + cursor.value.fRating; + list.appendChild(listItem); + + cursor.continue(); + } else { + console.log('Les éléments sont affichés.'); + } + }; + };</pre> + +<div class="note"> +<p><strong>Note :</strong> Pour un exemple complet qui utilise les intervalles de clé, vous pouvez consulter <a href="https://github.com/mdn/IDBKeyRange-example">le dépôt GitHub IDBKeyRange-example</a> (<a href="https://mdn.github.io/IDBKeyRange-example/">ainsi que la démonstration associée</a>).</p> +</div> + +<h2 id="Spécification">Spécification</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">Spécification</th> + <th scope="col">État</th> + <th scope="col">Commentaires</th> + </tr> + <tr> + <td>{{SpecName('IndexedDB', '#widl-IDBKeyRange-upperBound-IDBKeyRange-any-upper-boolean-open', 'upperBound()')}}</td> + <td>{{Spec2('IndexedDB')}}</td> + <td> </td> + </tr> + </tbody> +</table> + +<h2 id="Compatibilité_des_navigateurs">Compatibilité des navigateurs</h2> + +<p>{{Compat("api.IDBKeyRange.upperBound")}}</p> + +<h2 id="Voir_aussi">Voir aussi</h2> + +<ul> + <li><a href="/fr/docs/Web/API/API_IndexedDB/Using_IndexedDB">Utiliser IndexedDB</a></li> + <li>Initier une connexion : {{domxref("IDBDatabase")}}</li> + <li>Utiliser les transactions : {{domxref("IDBTransaction")}}</li> + <li>Définir un intervalle de clés : {{domxref("IDBKeyRange")}}</li> + <li>Récupérer et modifier les données : {{domxref("IDBObjectStore")}}</li> + <li>Utiliser les curseurs {{domxref("IDBCursor")}}</li> + <li>Exemple de référence : <a href="https://github.com/mdn/to-do-notifications/tree/gh-pages">To-do Notifications</a> (<a href="https://mdn.github.io/to-do-notifications/">exemple <em>live</em></a>).</li> +</ul> |