--- title: WebSocket slug: Web/API/WebSocket browser-compat: api.WebSocket translation_of: Web/API/WebSocket ---
{{APIRef("Web Sockets API")}}

L'objet WebSocket fournit l'API qui permet de créer et de gérer une connexion WebSocket à un serveur ainsi que d'envoyer et de recevoir des données sur cette connexion.

Pour construire un objet WebSocket, on utilisera le constructeur WebSocket().

{{AvailableInWorkers}}

Constructeur

WebSocket(url[, protocols])
Renvoie un nouvel objet WebSocket.

Constantes

Constante Valeur
WebSocket.CONNECTING 0
WebSocket.OPEN 1
WebSocket.CLOSING 2
WebSocket.CLOSED 3

Propriétés

WebSocket.binaryType
Le type de données binaire utilisé par la connexion.
WebSocket.bufferedAmount {{readonlyinline}}
Le nombre d'octets de données dans la queue.
WebSocket.extensions {{readonlyinline}}
Les extensions sélectionnées par le serveur.
WebSocket.onclose
Un gestionnaire d'évènement à appeler lorsque la connexion est fermée.
WebSocket.onerror
Un gestionnaire d'évènement à appeler en cas d'erreur.
WebSocket.onmessage
Un gestionnaire d'évènement à appeler lors de la réception d'un message du serveur.
WebSocket.onopen
Un gestionnaire d'évènement à appeler lorsque la connexion est ouverte.
WebSocket.protocol {{readonlyinline}}
Le sous-protocole sélectionné par le serveur.
WebSocket.readyState {{readonlyinline}}
L'état courant de la connexion.
WebSocket.url {{readonlyinline}}
L'URL absolue de la WebSocket.

Méthodes

WebSocket.close([code[, reason]])
Ferme la connexion.
WebSocket.send(data)
Ajoute des données à transmettre à la queue.

Évènements

close
Déclenché lorsqu'une connexion avec une WebSocket est fermée. Également disponible avec la propriété onclose.
error
Déclenché lorsqu'une connexion avec une WebSocket a été fermée à cause d'une erreur, par exemple lorsque des données n'ont pu être envoyées. Également disponible avec la propriété onerror.
message
Déclenché lorsque des données sont reçues via une WebSocket. Également disponible avec la propriété onmessage.
open
Déclenché lorsqu'une connexion avec une WebSocket est ouverte. Également disponible avec la propriété onopen.

Exemples

// Créer une connexion WebSocket
const socket = new WebSocket('ws://localhost:8080');

// La connexion est ouverte
socket.addEventListener('open', function (event) {
 socket.send('Coucou le serveur !');
});

// Écouter les messages
socket.addEventListener('message', function (event) {
  console.log('Voici un message du serveur', event.data);
});

Spécifications

{{Specifications}}

Compatibilité des navigateurs

{{Compat}}

Voir aussi