ContextQMD
Back to Content

WorkletSharedStorage: length() method

files/en-us/web/api/workletsharedstorage/length/index.md

latest1.2 KB
Original Source

{{APIRef("Shared Storage API")}}{{deprecated_header}}

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

Syntax

js-nolint
length()

Parameters

None.

Return value

A {{jsxref("Promise")}} that fulfills with a number, which represents the total count of key-value pairs currently in the shared storage.

Exceptions

  • {{jsxref("TypeError")}}
    • : Thrown if:
      • The worklet module has not yet been added with {{domxref("Worklet.addModule", "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

{{Specifications}}

Browser compatibility

{{Compat}}

See also