SharedStorageWorkletGlobalScope

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The SharedStorageWorkletGlobalScope interface of the Shared Storage API represents the global scope of a SharedStorageWorklet module.

WorkletGlobalScope SharedStorageWorkletGlobalScope

Instance properties

sharedStorage

Contains an instance of the WorkletSharedStorage object, representing the shared storage for a particular origin as exposed in a worklet context.

Instance methods

register()

Registers an operation defined inside the current worklet module.

Examples

js
// ab-testing-worklet.js
class SelectURLOperation {
  async run(urls, data) {
    // Read the user's experiment group from shared storage
    const experimentGroup = await this.sharedStorage.get("ab-testing-group");

    // Return the group number
    return experimentGroup;
  }
}

register("ab-testing", SelectURLOperation);

See the Shared Storage API landing page for a walkthrough of this example and links to other examples.

Specifications

Specification
Shared Storage API
# sharedstorageworkletglobalscope

Browser compatibility

BCD tables only load in the browser

See also