From ec4bd5d1cea307fcda80a33a7d7964b0dace407a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=91=9B=E4=BA=9A=E8=8A=B3?= Date: Tue, 16 Aug 2022 12:53:30 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-data-storage.md. Signed-off-by: @ge-yafang MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 葛亚芳 --- .../reference/apis/js-apis-data-storage.md | 854 ++++++++++-------- 1 file changed, 491 insertions(+), 363 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md index bf111b8806..6fd73e6a7a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md @@ -5,9 +5,9 @@ > **说明：** > -> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> -> - 从API Version 9开始，该接口不再维护，推荐使用新接口[`@ohos.data.preferences`](js-apis-data-preferences.md)。 +> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> - 从API Version 9开始，该接口不再维护，推荐使用新接口[`@ohos.data.preferences`](js-apis-data-preferences.md)。 ## 导入模块 @@ -20,10 +20,10 @@ import data_storage from '@ohos.data.storage'; **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制，需小于80字节。 | -| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制，需小于8192字节。 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ---------------- | -------- | ---- | ---- | ------------------------------------- | +| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制，需小于80字节。 | +| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制，需小于8192字节。 | ## data_storage.getStorageSync @@ -35,25 +35,33 @@ getStorageSync(path: string): Storage **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | [Storage](#storage) | 获取到要操作的Storage实例，用于进行数据存储操作。 | + +| 类型 | 说明 | +| ------------------- | ------------------------------------------------- | +| [Storage](#storage) | 获取到要操作的Storage实例，用于进行数据存储操作。 | **示例：** - ```js - import data_storage from '@ohos.data.storage' - - let path = '/data/storage/el2/database' - let storage = data_storage.getStorageSync(path + '/mystore') - storage.putSync('startup', 'auto') - storage.flushSync() - - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +let storage = data_storage.getStorageSync(path + '/mystore'); +storage.putSync('startup', 'auto'); +storage.flushSync(); +``` ## data_storage.getStorage @@ -65,25 +73,33 @@ getStorage(path: string, callback: AsyncCallback<Storage>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | - | callback | AsyncCallback<[Storage](#storage)> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | +| callback | AsyncCallback<[Storage](#storage)> | 是 | 回调函数。 | **示例：** - ```js - import data_storage from '@ohos.data.storage' - - let path = '/data/storage/el2/database' - data_storage.getStorage(path + '/mystore', function (err, storage) { - if (err) { - console.info("Get the storage failed, path: " + path + '/mystore') - return; - } - storage.putSync('startup', 'auto') - storage.flushSync() - }) - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +data_storage.getStorage(path + '/mystore', function (err, storage) { + if (err) { + console.info("Failed to get the storage. path: " + path + '/mystore'); + return; + } + storage.putSync('startup', 'auto'); + storage.flushSync(); +}) +``` ## data_storage.getStorage @@ -95,29 +111,37 @@ getStorage(path: string): Promise<Storage> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[Storage](#storage)> | Promise实例，用于异步获取结果。 | + +| 类型 | 说明 | +| ---------------------------------- | ------------------------------- | +| Promise<[Storage](#storage)> | Promise实例，用于异步获取结果。 | **示例：** - ```js - import data_storage from '@ohos.data.storage' - - let path = '/data/storage/el2/database' - - let getPromise = data_storage.getStorage(path + '/mystore') - getPromise.then((storage) => { - storage.putSync('startup', 'auto') - storage.flushSync() - }).catch((err) => { - console.info("Get the storage failed, path: " + path + '/mystore') - }) - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +let getPromise = data_storage.getStorage(path + '/mystore'); +getPromise.then((storage) => { + storage.putSync('startup', 'auto'); + storage.flushSync(); +}).catch((err) => { + console.info("Failed to get the storage. path: " + path + '/mystore'); +}) +``` ## data_storage.deleteStorageSync @@ -129,15 +153,25 @@ deleteStorageSync(path: string): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | **示例：** - ```js - let path = '/data/storage/el2/database' - data_storage.deleteStorageSync(path + '/mystore') - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +data_storage.deleteStorageSync(path + '/mystore'); +``` ## data_storage.deleteStorage @@ -149,22 +183,32 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js - let path = '/data/storage/el2/database' - data_storage.deleteStorage(path + '/mystore', function (err) { - if (err) { - console.info("Deleted failed with err: " + err) - return - } - console.info("Deleted successfully.") - }) - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +data_storage.deleteStorage(path + '/mystore', function (err) { + if (err) { + console.info("Failed to delete the storage with err: " + err); + return; + } + console.info("Succeeded in deleting the storage."); +}) +``` ## data_storage.deleteStorage @@ -176,25 +220,36 @@ deleteStorage(path: string): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步获取结果。 | + +| 类型 | 说明 | +| ------------------- | ------------------------------- | +| Promise<void> | Promise实例，用于异步获取结果。 | **示例：** - ```js - let path = '/data/storage/el2/database' - let promisedelSt = data_storage.deleteStorage(path + '/mystore') - promisedelSt.then(() => { - console.info("Deleted successfully.") - }).catch((err) => { - console.info("Deleted failed with err: " + err) - }) - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +let promisedelSt = data_storage.deleteStorage(path + '/mystore'); +promisedelSt.then(() => { + console.info("Succeeded in deleting the storage."); +}).catch((err) => { + console.info("Failed to delete the storage with err: " + err); +}) +``` ## data_storage.removeStorageFromCacheSync @@ -206,15 +261,24 @@ removeStorageFromCacheSync(path: string): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | **示例：** - ```js - let path = '/data/storage/el2/database' - data_storage.removeStorageFromCacheSync(path + '/mystore') - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +data_storage.removeStorageFromCacheSync(path + '/mystore'); +``` ## data_storage.removeStorageFromCache @@ -226,22 +290,32 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js - let path = '/data/storage/el2/database' - data_storage.removeStorageFromCache(path + '/mystore', function (err) { - if (err) { - console.info("Removed storage from cache failed with err: " + err) - return - } - console.info("Removed storage from cache successfully.") - }) - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +data_storage.removeStorageFromCache(path + '/mystore', function (err) { + if (err) { + console.info("Failed to remove storage from cache with err: " + err); + return; + } + console.info("Succeeded in removing storage from cache."); +}) +``` ## data_storage.removeStorageFromCache @@ -253,25 +327,36 @@ removeStorageFromCache(path: string): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | path | string | 是 | 应用程序内部数据存储路径。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 应用程序内部数据存储路径。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步获取结果。 | + +| 类型 | 说明 | +| ------------------- | ------------------------------- | +| Promise<void> | Promise实例，用于异步获取结果。 | **示例：** - ```js - let path = '/data/storage/el2/database' - let promiserevSt = data_storage.removeStorageFromCache(path + '/mystore') - promiserevSt.then(() => { - console.info("Removed storage from cache successfully.") - }).catch((err) => { - console.info("Removed storage from cache failed with err: " + err) - }) - ``` + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +var path; +var context = featureAbility.getContext(); +context.getFilesDir().then((filePath) => { + path = filePath; + console.info("======================>getFilesDirPromsie====================>"); +}); + +let promiserevSt = data_storage.removeStorageFromCache(path + '/mystore') +promiserevSt.then(() => { + console.info("Succeeded in removing storage from cache."); +}).catch((err) => { + console.info("Failed to remove storage from cache with err: " + err); +}) +``` ## Storage @@ -288,21 +373,24 @@ getSync(key: string, defValue: ValueType): ValueType **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称，不能为空。 | - | defValue | [ValueType](#valuetype) | 是 | 给定key的存储不存在，则要返回的默认值。支持number、string、boolean。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| key | string | 是 | 要获取的存储key名称，不能为空。 | +| defValue | [ValueType](#valuetype) | 是 | 给定key的存储不存在，则要返回的默认值。支持number、string、boolean。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | ValueType | 键对应的值，如果值为null或者非默认值类型，返回默认数据。 | + +| 类型 | 说明 | +| --------- | -------------------------------------------------------- | +| ValueType | 键对应的值，如果值为null或者非默认值类型，返回默认数据。 | **示例：** - ```js - let value = storage.getSync('startup', 'default') - console.info("The value of startup is " + value) - ``` + +```js +let value = storage.getSync('startup', 'default'); +console.info("The value of startup is " + value); +``` ### get @@ -314,22 +402,24 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称，不能为空。 | - | defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | - | callback | AsyncCallback<ValueType> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------ | ---- | ----------------------------------------- | +| key | string | 是 | 要获取的存储key名称，不能为空。 | +| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | +| callback | AsyncCallback<ValueType> | 是 | 回调函数。 | **示例：** - ```js - storage.get('startup', 'default', function(err, value) { - if (err) { - console.info("Get the value of startup failed with err: " + err) - return + +```js +storage.get('startup', 'default', function(err, value) { + if (err) { + console.info("Failed to get the value of startup with err: " + err); + return; } - console.info("The value of startup is " + value) - }) - ``` + console.info("The value of startup is " + value); +}) +``` ### get @@ -342,25 +432,27 @@ get(key: string, defValue: ValueType): Promise<ValueType> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | string | 是 | 要获取的存储key名称，不能为空。 | -| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ----------------------------------------- | +| key | string | 是 | 要获取的存储key名称，不能为空。 | +| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<ValueType> | Promise实例，用于异步获取结果。 | + +| 类型 | 说明 | +| ------------------------ | ------------------------------- | +| Promise<ValueType> | Promise实例，用于异步获取结果。 | **示例：** - ```js - let promiseget = storage.get('startup', 'default') - promiseget.then((value) => { - console.info("The value of startup is " + value) - }).catch((err) => { - console.info("Get the value of startup failed with err: " + err) - }) - ``` + +```js +let promiseget = storage.get('startup', 'default'); +promiseget.then((value) => { + console.info("The value of startup is " + value) +}).catch((err) => { + console.info("Failed to get the value of startup with err: " + err); +}) +``` ### putSync @@ -372,15 +464,17 @@ putSync(key: string, value: ValueType): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要修改的存储的key，不能为空。 | - | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------- | ---- | ----------------------------------------- | +| key | string | 是 | 要修改的存储的key，不能为空。 | +| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | **示例：** - ```js - storage.putSync('startup', 'auto') - ``` + +```js +storage.putSync('startup', 'auto'); +``` ### put @@ -392,22 +486,24 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要修改的存储的key，不能为空。 | - | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------------------------------------- | +| key | string | 是 | 要修改的存储的key，不能为空。 | +| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js - storage.put('startup', 'auto', function (err) { - if (err) { - console.info("Put the value of startup failed with err: " + err) - return - } - console.info("Put the value of startup successfully.") - }) - ``` + +```js +storage.put('startup', 'auto', function (err) { + if (err) { + console.info("Failed to put the value of startup with err: " + err); + return; + } + console.info("Succeeded in putting the value of startup."); +}) +``` ### put @@ -419,25 +515,28 @@ put(key: string, value: ValueType): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要修改的存储的key，不能为空。 | - | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------- | ---- | ----------------------------------------- | +| key | string | 是 | 要修改的存储的key，不能为空。 | +| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步处理。 | + +| 类型 | 说明 | +| ------------------- | --------------------------- | +| Promise<void> | Promise实例，用于异步处理。 | **示例：** - ```js - let promiseput = storage.put('startup', 'auto') - promiseput.then(() => { - console.info("Put the value of startup successfully.") - }).catch((err) => { - console.info("Put the value of startup failed with err: " + err) - }) - ``` + +```js +let promiseput = storage.put('startup', 'auto'); +promiseput.then(() => { + console.info("Succeeded in putting the value of startup."); +}).catch((err) => { + console.info("Failed to put the value of startup with err: " + err); +}) +``` ### hasSync @@ -449,22 +548,25 @@ hasSync(key: string): boolean **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称，不能为空。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------- | +| key | string | 是 | 要获取的存储key名称，不能为空。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true 表示存在，false表示不存在。 | + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| boolean | true 表示存在，false表示不存在。 | **示例：** - ```js - let isExist = storage.hasSync('startup') - if (isExist) { - console.info("The key of startup is contained.") - } - ``` + +```js +let isExist = storage.hasSync('startup'); +if (isExist) { + console.info("The key of startup is contained."); +} +``` ### has @@ -476,28 +578,31 @@ has(key: string, callback: AsyncCallback<boolean>): boolean **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称，不能为空。 | - | callback | AsyncCallback<boolean> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ------------------------------- | +| key | string | 是 | 要获取的存储key名称，不能为空。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true表示存在，false表示不存在。 | + +| 类型 | 说明 | +| ------- | ------------------------------- | +| boolean | true表示存在，false表示不存在。 | **示例：** - ```js - storage.has('startup', function (err, isExist) { - if (err) { - console.info("Check the key of startup failed with err: " + err) - return - } - if (isExist) { - console.info("The key of startup is contained.") - } - }) - ``` + +```js +storage.has('startup', function (err, isExist) { + if (err) { + console.info("Failed to check the key of startup with err: " + err); + return; + } + if (isExist) { + console.info("The key of startup is contained."); + } +}) +``` ### has @@ -509,26 +614,29 @@ has(key: string): Promise<boolean> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称，不能为空。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------- | +| key | string | 是 | 要获取的存储key名称，不能为空。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | Promise实例，用于异步处理。 | + +| 类型 | 说明 | +| ---------------------- | --------------------------- | +| Promise<boolean> | Promise实例，用于异步处理。 | **示例：** - ```js - let promisehas = storage.has('startup') - promisehas.then((isExist) => { - if (isExist) { - console.info("The key of startup is contained.") - } - }).catch((err) => { - console.info("Check the key of startup failed with err: " + err) - }) - ``` + +```js +let promisehas = storage.has('startup') +promisehas.then((isExist) => { + if (isExist) { + console.info("The key of startup is contained."); + } +}).catch((err) => { + console.info("Failed to check the key of startup with err: " + err); +}) +``` ### deleteSync @@ -540,14 +648,16 @@ deleteSync(key: string): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称。它不能为空。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | --------------------------------- | +| key | string | 是 | 要获取的存储key名称。它不能为空。 | **示例：** - ```js - storage.deleteSync('startup') - ``` + +```js + storage.deleteSync('startup'); +``` ### delete @@ -559,21 +669,23 @@ delete(key: string, callback: AsyncCallback<void>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称，不能为空。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------- | +| key | string | 是 | 要获取的存储key名称，不能为空。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js - storage.delete('startup', function (err) { - if (err) { - console.info("Delete startup key failed with err: " + err) - return - } - console.info("Deleted startup key successfully.") - }) - ``` + +```js +storage.delete('startup', function (err) { + if (err) { + console.info("Failed to delete startup key failed err: " + err); + return; + } + console.info("Succeeded in deleting startup key."); +}) +``` ### delete @@ -585,24 +697,27 @@ delete(key: string): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称。 | + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | --------------------- | +| key | string | 是 | 要获取的存储key名称。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步处理。 | + +| 类型 | 说明 | +| ------------------- | --------------------------- | +| Promise<void> | Promise实例，用于异步处理。 | **示例：** - ```js - let promisedel = storage.delete('startup') - promisedel.then(() => { - console.info("Deleted startup key successfully.") - }).catch((err) => { - console.info("Delete startup key failed with err: " + err) - }) - ``` + +```js +let promisedel = storage.delete('startup') +promisedel.then(() => { + console.info("Succeeded in deleting startup key."); +}).catch((err) => { + console.info("Failed to delete startup key failed err: " + err); +}) +``` ### flushSync @@ -614,9 +729,10 @@ flushSync(): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **示例：** - ```js - storage.flushSync() - ``` + +```js +storage.flushSync(); +``` ### flush @@ -628,20 +744,22 @@ flush(callback: AsyncCallback<void>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js - storage.flush(function (err) { - if (err) { - console.info("Flush to file failed with err: " + err) - return - } - console.info("Flushed to file successfully.") - }) - ``` + +```js +storage.flush(function (err) { + if (err) { + console.info("Failed to flush to file with err: " + err); + return; + } + console.info("Succeeded in flushing to file."); +}) +``` ### flush @@ -653,19 +771,21 @@ flush(): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步处理。 | + +| 类型 | 说明 | +| ------------------- | --------------------------- | +| Promise<void> | Promise实例，用于异步处理。 | **示例：** - ```js - let promiseflush = storage.flush() - promiseflush.then(() => { - console.info("Flushed to file successfully.") - }).catch((err) => { - console.info("Flush to file failed with err: " + err) - }) - ``` + +```js +let promiseflush = storage.flush(); +promiseflush.then(() => { + console.info("Succeeded in flushing to file."); +}).catch((err) => { + console.info("Failed to flush to file with err: " + err); +}) +``` ### clearSync @@ -677,9 +797,10 @@ clearSync(): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **示例：** - ```js - storage.clearSync() - ``` + +```js +storage.clearSync(); +``` ### clear @@ -691,20 +812,22 @@ clear(callback: AsyncCallback<void>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 回调函数。 | + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** - ```js - storage.clear(function (err) { - if (err) { - console.info("Clear to file failed with err: " + err) - return - } - console.info("Cleared to file successfully.") - }) - ``` + +```js +storage.clear(function (err) { + if (err) { + console.info("Failed to clear the storage with err: " + err); + return; + } + console.info("Succeeded in clearing the storage."); +}) +``` ### clear @@ -716,19 +839,20 @@ clear(): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步处理。 | +| 类型 | 说明 | +| ------------------- | --------------------------- | +| Promise<void> | Promise实例，用于异步处理。 | **示例：** - ```js - let promiseclear = storage.clear() - promiseclear.then(() => { - console.info("Cleared to file successfully.") - }).catch((err) => { - console.info("Clear to file failed with err: " + err) - }) - ``` + +```js +let promiseclear = storage.clear(); +promiseclear.then(() => { + console.info("Succeeded in clearing the storage."); +}).catch((err) => { + console.info("Failed to clear the storage with err: " + err); +}) +``` ### on('change') @@ -740,20 +864,22 @@ on(type: 'change', callback: Callback<StorageObserver>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 说明 | - | -------- | -------- | -------- | - | type | string | 事件类型，固定值'change'，表示数据变更。 | - | callback | Callback<[StorageObserver](#storageobserver)> | 回调对象实例。 | + +| 参数名 | 类型 | 说明 | +| -------- | --------------------------------------------------- | ---------------------------------------- | +| type | string | 事件类型，固定值'change'，表示数据变更。 | +| callback | Callback<[StorageObserver](#storageobserver)> | 回调对象实例。 | **示例：** - ```js - var observer = function (key) { - console.info("The key of " + key + " changed.") - } - storage.on('change', observer) - storage.putSync('startup', 'auto') - storage.flushSync() // observer will be called. - ``` + +```js +var observer = function (key) { + console.info("The key of " + key + " changed."); +} +storage.on('change', observer); +storage.putSync('startup', 'auto'); +storage.flushSync(); // observer will be called. +``` ### off('change') @@ -765,27 +891,29 @@ off(type: 'change', callback: Callback<StorageObserver>): void **系统能力：** SystemCapability.DistributedDataManager.Preferences.Core **参数：** - | 参数名 | 类型 | 说明 | - | -------- | -------- | -------- | - | type | string | 事件类型，固定值'change'，表示数据变更。 | - | callback | Callback<[StorageObserver](#storageobserver)> | 需要取消的回调对象实例。 | + +| 参数名 | 类型 | 说明 | +| -------- | --------------------------------------------------- | ---------------------------------------- | +| type | string | 事件类型，固定值'change'，表示数据变更。 | +| callback | Callback<[StorageObserver](#storageobserver)> | 需要取消的回调对象实例。 | **示例：** - ```js - var observer = function (key) { - console.info("The key of " + key + " changed.") - } - storage.off('change', observer) - ``` + +```js +var observer = function (key) { + console.info("The key of " + key + " changed."); +} +storage.off('change', observer); +``` ## StorageObserver -**系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core +**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core -| 名称 | 参数类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | string | 否 | 变更的数据内容。 | +| 名称 | 参数类型 | 必填 | 说明 | +| ---- | -------- | ---- | ---------------- | +| key | string | 否 | 变更的数据内容。 | ## ValueType @@ -797,4 +925,4 @@ off(type: 'change', callback: Callback<StorageObserver>): void | ------- | -------------------- | | number | 表示值类型为数字。 | | string | 表示值类型为字符。 | -| boolean | 表示值类型为布尔值。 | +| boolean | 表示值类型为布尔值。 | \ No newline at end of file -- GitLab