title: Taro.getStorage(option)

sidebar_label: getStorage

Asynchronously gets the content of the specified key from the local cache.

Reference

Type

  1. (option: Option) => Promise<SuccessCallbackResult>

Parameters

Option

Property Type Required Description
key string Yes The specified key in the local cache
complete (res: any) => void No The callback function used when the API call completed (always executed whether the call succeeds or fails)
fail (res: any) => void No The callback function for a failed API call
success (res: Result) => void No The callback function for a successful API call

SuccessCallbackResult

Property Type Description
data any Content of the key
errMsg string Call result

Sample Code

  1. Taro.getStorage({
  2.   key: 'key',
  3.   success: function (res) {
  4.     console.log(res.data)
  5.   }
  6. })
  1. try {
  2.   var value = Taro.getStorageSync('key')
  3.   if (value) {
  4.     // Do something with return value
  5.   }
  6. } catch (e) {
  7.   // Do something when catch error
  8. }

API Support

API WeChat Mini-Program H5 React Native
Taro.getStorage ✔️ ✔️ ✔️