06 本地存储模块 - MiEcosystem/miot-plugin-sdk GitHub Wiki

本地轻量级存储服务, 键值对格式 对于key-value的数据存储，我们提供的能力具体如下： 1、单个key-value的数据存储 2、批量key-value的数据存储 注意事项： 1、目前删除设备没有做自动清除本地缓存的能力(计划安排中)

Export: public
Doc_name: 本地存储模块
Doc_index: 6
Doc_directory: host
Example

import { Host} from "miot";
Host.storage.get("key-1").then(res => {
  console.log("res", res)
}).catch(error => {
   console.log("error", error)
});

• miot/host/storage
  • ~IStorage
    • .get(key) ⇒ [ 'Promise' ].<string>
    • .set(key, val, [opt]) ⇒ void
    • .load(keys) ⇒ [ 'promise' ].<Array.<json>>
    • .save(keyValues, [opt]) ⇒ void

Kind: inner interface of miot/host/storage

• ~IStorage
  • .get(key) ⇒ [ 'Promise' ].<string>
  • .set(key, val, [opt]) ⇒ void
  • .load(keys) ⇒ [ 'promise' ].<Array.<json>>
  • .save(keyValues, [opt]) ⇒ void

获取一个key 保存的字符串，如果已经调用 set 则返回对应的值，未调用 set 则返回空字串 '' 如果value已过期，则会reject

Kind: instance method of IStorage
Returns: [ 'Promise' ].<string> - 成功时：直接返回key 对于的 value 失败时："expired"

Example

import {Host} from 'miot'
...
var value = await Host.storage.get('prop1')
//or
Host.storage.get('prpp1')
.then(val => {
 //load val success}
 console.log('load value:', val)
)
.catch(err => {
 //load val error 
 if (err === 'expired') {console.log('value for key already expired')}
})
...

和 get 相对应，持久化一个 key=value 的数据

Kind: instance method of IStorage

Example

import {Host} from 'miot'
...
Host.storage.set('key1','value1')
//or
Host.storage.set('key1','value1', {expire:3600})
...

获取所有 keys 的 values

Kind: instance method of IStorage
Returns: [ 'promise' ].<Array.<json>> - 返回的promise传出的值是values数组，和传入的keys对应 [{key,value}] 成功时：["value1", "value2", ...] 失败时：string类型字符串

Example

import {Host} from 'miot'
...
Host.storage.load(['key1','key2']).then(res => console.log('success'))
...

保存所有 keyValues 的数据，例如{key1:value1 , key2:value2 , key3:value3} 每个 key 可单独更新数据，如果调用 set(key2,value4) 则只更新 key2，key1和 key3的值保持不变

Kind: instance method of IStorage

Example

import {Host} from 'miot'
...
Host.storage.save({'key1':'val1','key2':'val2'})
//or
Host.storage.save({'key1':'val1','key2':'val2'}, {expire:3600})
...