Files
rudder-js-sdk/skills/rudder-web-sdk/reference/storage.md
T

967 B

Storage — client.storage

Per-player storage, one item per type. StorageDomain, revision key storage. Source: src/domains/StorageDomain.ts.

client.storage.value   // GetStorageResponse | undefined
await client.storage.reload();
interface GetStorageResponse {
  items?: StorageItem[];
  nextCursor?: string;
}
interface StorageItem {
  data?: string;   // opaque payload, JSON-stringify yourself
  id?: string;     // server-assigned
  type?: string;   // the storage key
}
  • The client cannot write storage. Module functions (kernel Storage.Set) and the batch admin API write it; call reload() after a module call that saved.

Limits and notes

  • The state loads with { limit: 100 }; nextCursor pagination is not surfaced.
  • data is a raw string on the wire; serialize and parse JSON yourself.
  • Project storage is not reachable from the client SDK. It stays available to modules, the dashboard and /game/v1.