WorkletSharedStorage: length() method

The length() method of the WorkletSharedStorage interface returns the number of entries currently stored in shared storage for the current origin.

Syntax

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

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

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

Specifications

Browser compatibility

See also

• Shared Storage API