Storage.setItem()

La méthode setItem() de l'interface Storage, lorsque lui sont passées le duo clé-valeur, les ajoute à l'emplacement de stockage, sinon elle met à jour la valeur si la clé existe déjà.

Syntaxe

storage.setItem(nomClé, valeurClé);

Paramètres

nomClé
C'est une DOMString contenant le nom de la clé que l'on souhaite créer/modifier.
valeurClé
C'est une DOMString contenant la valeur associée à son nom de clé que l'on souhaite créer/modifier.

Retourne

Aucune valeur de retour.

Exceptions

setItem() peut émettre une exception si l'emplacement de stockage est plein. En particulier pour Safari mobile (depuis iOS 5), elle émettra une exception si l'utilisateur passe en navigation privée (contrairement aux autres navigateur qui autorisent le stockage même en navigation privée en utilisant un conteneur de données séparé, Safari met son quota de stockage à 0 octets).
Par conséquent les développeurs devraient être sûrs de toujours de systématiquement capturer toute possible exception venant de setItem().

Exemple

La fonction suivante crée trois éléments à l'intérieur du stockage local.

function remplissageStockage() {
  localStorage.setItem('bgcolor', 'red');
  localStorage.setItem('font', 'Helvetica');
  localStorage.setItem('image', 'myCat.png');
}

Note : Pour voir ceci utilisé dans un exemple concret, regardez notre Web Storage Demo.

Spécifications

Spécification Statut Commentaire
HTML Living Standard
La définition de 'Storage.setItem' dans cette spécification.		 Standard évolutif

Compatibilité

Nous convertissons les données de compatibilité dans un format JSON. Ce tableau de compatibilité utilise encore l'ancien format car nous n'avons pas encore converti les données qu'il contient. Vous pouvez nous aider en contribuant !

Fonctionnalité Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
localStorage 4 (Oui) 3.5 8 10.50 4
sessionStorage 5 ? 2 8 10.50 4
Fonctionnalité Android Edge Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Support basique 2.1 (Oui) ? 8 11 iOS 3.2

Tous les navigateurs ont des niveaux de capacité de stockage variables, que ce soit pour localStorage ou sessionStorage. Pour un test de l'ensemble des capacités des différents navigateurs voir ici.

Note : Depuis iOS 5.1, Safari Mobile stocke les données liées à localStorage dans un fichier de cache qui est sujet à un nettoyage occasionnel par ordre du système d'exploitation, surtout lorsqu'il reste peu de place.

À voir également