SharedWorkerGlobalScope.onconnect

The onconnect property of the SharedWorkerGlobalScope interface is an EventHandler representing the code to be called when the connect event is raised — that is, when a MessagePort connection is opened between the associated SharedWorker and the main thread.

Syntax

onconnect = function() { ... };

Specifications

Specification	Status	Comment
WHATWG HTML Living Standard The definition of 'onconnect' in that specification.	Living Standard	No change from Web Workers.
Web Workers The definition of 'onconnect' in that specification.	Candidate Recommendation	Initial definition.

Example

This example shows a shared worker file — when a connection to the worker occurs from a main thread via a MessagePort, the onconnect event handler fires. The connecting port can be referenced through the event's ports parameter; this reference can have an onmessage handler attached to it to handle messages coming in through the port, and its postMessage() method can be used to send messages back to the main thread using the worker.

onconnect = function(e) {
    var port = e.ports[0];

    port.onmessage = function(e) {
      var workerResult = 'Result: ' + (e.data[0] * e.data[1]);
      port.postMessage(workerResult);
    }

    port.start();
}

For a complete running example, see our Basic shared worker example (run shared worker.)

Browser compatibility

See also

• SharedWorkerGlobalScope