websockets.idl - mozsearch

Enable keyboard shortcuts

// GENERATED CONTENT - DO NOT EDIT

// Content was automatically extracted by Reffy into webref

// (https://github.com/w3c/webref)

// Source: WebSockets Standard (https://websockets.spec.whatwg.org/)

enum BinaryType { "blob", "arraybuffer" };

[Exposed=(Window,Worker)]

interface WebSocket : EventTarget {

  constructor(USVString url, optional (DOMString or sequence<DOMString>) protocols = []);

  readonly attribute USVString url;

  // ready state

  const unsigned short CONNECTING = 0;

  const unsigned short OPEN = 1;

  const unsigned short CLOSING = 2;

  const unsigned short CLOSED = 3;

  readonly attribute unsigned short readyState;

  readonly attribute unsigned long long bufferedAmount;

  // networking

  attribute EventHandler onopen;

  attribute EventHandler onerror;

  attribute EventHandler onclose;

  readonly attribute DOMString extensions;

  readonly attribute DOMString protocol;

  undefined close(optional [Clamp] unsigned short code, optional USVString reason);

  // messaging

  attribute EventHandler onmessage;

  attribute BinaryType binaryType;

  undefined send((BufferSource or Blob or USVString) data);

};

[Exposed=(Window,Worker)]

interface CloseEvent : Event {

  constructor(DOMString type, optional CloseEventInit eventInitDict = {});

  readonly attribute boolean wasClean;

  readonly attribute unsigned short code;

  readonly attribute USVString reason;

};

dictionary CloseEventInit : EventInit {

  boolean wasClean = false;

  unsigned short code = 0;

  USVString reason = "";

};