本地存储

本地的持久化存储，有效范围为整个插件。

API 调用

QN.localstore.set(options)

存储数据

API 调用入参

名称 类型 是否可选 含义
options Object 选项
options.query Object 需要存储的数据对象，key/value 的形式，支持多个
options.success Function optional 调用成功的回调函数
options.error Function optional 调用失败的回调函数

API 响应结果

名称 类型 是否必须返回 含义
result Object 响应对象
result.errorCode Number 错误码，成功为0，失败为非0
result.errorMsg String 错误信息

调用示例

QN.localstore.set({
    query: {
        name: '张三',
        age: 18,
        data: {x: 1, y: 2},
    },
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

QN.localstore.get(options)

查询数据

API 调用入参

名称 类型 是否可选 含义
options Object 选项
options.query Object 请求参数
options.query.key String Array 存储的 key 或 以 key 组成的数组
options.success Function optional 调用成功的回调函数
options.error Function optional 调用失败的回调函数

API 响应结果

名称 类型 是否必须返回 含义
result Object 响应对象
result.errorCode Number 错误码，成功为0，失败为非0
result.errorMsg String 错误信息
result.data Object 获取到的数据，格式为 key value，如果某个 key 未取到值，则 data 中将不包含该 key

调用示例

// 获取一个 key 的数据
QN.localstore.get({
    query: {
        key: 'name'
    },
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 获取多个 key 的数据
QN.localstore.get({
    query: {
        key: ['name', 'age', 'data', 'job']
    },
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    }
}).then(result => {
    console.log(result);
    /**
     * // `job` 这个字段没有值，`data` 中将不包含 `job` 字段
     * {
     *   errorCode: 0,
     *   errorMsg: '',
     *   data: {
     *      name: '张三',
     *      age: '18',
     *      data: {x: 1, y: 2},
     *      job: null  // 如果存储中没有数据，则返回null
     *   }
     * }
     */
}, error => {
    console.log(error);
});

QN.localstore.remove(options)

删除数据

API 调用入参

名称 类型 是否可选 含义
options Object 选项
options.query Object 请求参数
options.query.key String Array 存储的 key 或 以 key 组成的数组
options.success Function optional 调用成功的回调函数
options.error Function optional 调用失败的回调函数

API 响应结果

名称 类型 是否必须返回 含义
result Object 响应对象
result.errorCode Number 错误码，成功为0，失败为非0
result.errorMsg String 错误信息

调用示例

// 删除一个 key 的数据
QN.localstore.remove({
    query: {
        key: 'name'
    },
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

// 删除多个 key 的数据
QN.localstore.remove({
    query: {
        key: ['name', 'age', 'data', 'job']
    },
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});

QN.localstore.clear(options)

清除数据

API 调用入参

名称 类型 是否可选 含义
options Object optional 选项
options.success Function optional 调用成功的回调函数
options.error Function optional 调用失败的回调函数

API 响应结果

名称 类型 是否必须返回 含义
result Object 响应对象
result.errorCode Number 错误码，成功为0，失败为非0
result.errorMsg String 错误信息

调用示例

QN.localstore.clear({
    success(result) {
        console.log(result);
    },
    error(error) {
        console.log(error);
    }
}).then(result => {
    console.log(result);
}, error => {
    console.log(error);
});