WorkletSharedStorage: length() method

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 length() method of the WorkletSharedStorage interface returns the number of entries currently stored in shared storage for the current origin.

Syntax

js
length()

Parameters

None.

Return value

A Promise that fulfills with a number, which represents the total count of key-value pairs currently in the shared storage.

Exceptions

TypeError

Thrown if:

  • The worklet module has not yet been added with addModule().
  • The calling site does not have the Shared Storage API included in a successful privacy sandbox enrollment process.
  • The browser fails to retrieve the number of entries for some other reason.

Examples

js
// length() available inside a shared storage worklet module

async function retrieveLength() {
  const length = await this.sharedStorage.length();
  console.log(length);
}

Specifications

Specification
Shared Storage API
# dom-workletsharedstorage-length

Browser compatibility

BCD tables only load in the browser

See also