diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md b/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md index 430fed2b85aa5c25fd862ab75617ba932c53fce2..d4bacca8962448d668fdf4e2f1849f973797f09a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md @@ -223,7 +223,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): **示例:** ```ts - preferences.get('startup', 'default', function(err, value) { +preferences.get('startup', 'default', function(err, value) { if (err) { console.info("Get value of startup failed, err: " + err) return @@ -277,7 +277,7 @@ getAll(callback: AsyncCallback<Object>): void; **示例:** ```ts -preferences.get.getAll(function (err, value) { +preferences.getAll(function (err, value) { if (err) { console.info("getAll failed, err: " + err) return @@ -288,6 +288,7 @@ preferences.get.getAll(function (err, value) { }); ``` + ### getAll getAll(): Promise<Object> @@ -339,6 +340,7 @@ preferences.put('startup', 'auto', function (err) { }) ``` + ### put put(key: string, value: ValueType): Promise<void> @@ -383,7 +385,6 @@ has(key: string, callback: AsyncCallback<boolean>): void | key | string | 是 | 要检查的存储key名称,不能为空。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。返回存储对象是否包含给定key的存储键值对,true表示存在,false表示不存在。 | - **示例:** ```ts preferences.has('startup', function (err, isExist) { @@ -595,33 +596,36 @@ on(type: 'change', callback: Callback<{ key : string }>): void **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core **参数:** - | 参数名 | 类型 |必填 | 说明 | - | -------- | -------- | -------- |-------- | - | type | string | 是 | 事件类型,固定值'change',表示数据变更。 | - | callback | Callback<{ key : string }> | 是 | 回调对象实例。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 事件类型,固定值'change',表示数据变更。 | + | callback | Callback<{ key : string }> | 是| 回调对象实例。 | **示例:** ```ts -var observer = function (key) { - console.info("The key of " + key + " changed.") -} - -... - -preferences.on('change', observer) -preferences.put('startup', 'auto', function (err) { +data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) { if (err) { - console.info("Put the value of startup failed, err: " + err) - return + console.info("Get preferences failed.") + return; } - console.info("Put the value of startup successfully.") - - preferences.flush(function (err) { + var observer = function (key) { + console.info("The key of " + key + " changed.") + } + preferences.on('change', observer) + preferences.put('startup', 'auto', function (err) { if (err) { - console.info("Flush to file failed, err: " + err) + console.info("Put the value of startup failed, err: " + err) return } - console.info("Flushed to file successfully.") // observer will be called. + console.info("Put the value of startup successfully.") + + preferences.flush(function (err) { + if (err) { + console.info("Flush to file failed, err: " + err) + return + } + console.info("Flushed to file successfully.") // observer will be called. + }) }) }) ``` @@ -637,32 +641,35 @@ off(type: 'change', callback?: Callback<{ key : string }>): void **参数:** | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- |-------- | - | type | string| 是 | 事件类型,固定值'change',表示数据变更。 | - | callback | Callback<{ key : string }> | 否| 需要取消的回调对象实例,不填则全部取消。 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 事件类型,固定值'change',表示数据变更。 | + | callback | Callback<{ key : string }> | 否| 需要取消的回调对象实例,不填则全部取消。 | **示例:** ```ts -var observer = function (key) { - console.info("The key of " + key + " changed.") -} - -... - -preferences.on('change', observer) -preferences.put('startup', 'auto', function (err) { +data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) { if (err) { - console.info("Put the value of startup failed, err: " + err) - return + console.info("Get preferences failed.") + return; } - console.info("Put the value of startup successfully.") - - preferences.flush(function (err) { + var observer = function (key) { + console.info("The key of " + key + " changed.") + } + preferences.on('change', observer) + preferences.put('startup', 'auto', function (err) { if (err) { - console.info("Flush to file failed, err: " + err) + console.info("Put the value of startup failed, err: " + err) return } - console.info("Flushed to file successfully.") // observer will be called. + console.info("Put the value of startup successfully.") + + preferences.flush(function (err) { + if (err) { + console.info("Flush to file failed, err: " + err) + return + } + console.info("Flushed to file successfully.") // observer will be called. + }) preferences.off('change', observer) }) }) @@ -674,8 +681,8 @@ preferences.put('startup', 'auto', function (err) { **系统能力:** SystemCapability.DistributedDataManager.Preferences.Core -| 名称 | 说明 | -| ------- | -------------------- | -| number | 表示值类型为数字。 | -| string | 表示值类型为字符。 | -| boolean | 表示值类型为布尔值。 | +| 名称 | 说明 | +| -------------- | ------------------------------ | +| number | 表示值类型为数字。 | +| string | 表示值类型为字符串。 | +| boolean | 表示值类型为布尔值。 |