@capacitor/storage

The Storage API provides a simple key/value persistent store for lightweight data.

Mobile OS’s may periodically clear data set in window.localStorage, so this API should be used instead. This API will fall back to using localStorage when running as a Progressive Web App.

This plugin will use UserDefaults on iOS and SharedPreferences on Android. Stored data is cleared if the app is uninstalled.

Note: This API is not meant to be used as a local database. If your app stores a lot of data, has high read/write load, or requires complex querying, take a look at @capacitor-community/sqlite.

Install

npm install @capacitor/storage
npx cap sync

Example

import { Storage } from '@capacitor/storage';

const setName = () => {
  await Storage.set({
    key: 'name',
    value: 'Max',
  });
};

const checkName = async () => {
  const { value } = await Storage.get({ key: 'name' });

  alert(`Hello ${value}!`);
};

const removeName = async () => {
  await Storage.remove({ key: 'name' });
};

Working with JSON

The Storage API only supports string values. You can, however, use JSON if you JSON.stringify the object before calling set(), then JSON.parse the value returned from get().

This method can also be used to store non-string values, such as numbers and booleans.

API

configure(options: ConfigureOptions) => Promise<void>

get(options: GetOptions) => Promise<GetResult>

set(options: SetOptions) => Promise<void>

remove(options: RemoveOptions) => Promise<void>

clear() => Promise<void>

keys() => Promise<KeysResult>

migrate() => Promise<MigrateResult>