jiangbo91@huawei.com

local_storage开发文档
Signed-off-by: Njiangbo <jiangbo91@huawei.com>
Change-Id: I0fc7e7d972da9019e3694dca1bdec8452404530d

zh-cn/application-dev/ui/ui-ts-local_storage.md

@@ -26,91 +26,241 @@ LocalStorage的生命周期跟随其关联的Ability。
 
 ### Constructor  
 
+constructor(initializingProperties?: Object)
+
 创建一个新的LocalStorage对象，对对象进行初始化。
 
-| 参数名 | 类型   | 返回值 | 必填 | 描述                                                         |
-| ------ | ------ | ------ | :--: | ------------------------------------------------------------ |
-| obj    | Object | N/A    |  否  | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 |
+| 参数名                 | 类型   | 返回值 | 必填 | 参数描述                                                     |
+| ---------------------- | ------ | ------ | :--: | ------------------------------------------------------------ |
+| initializingProperties | Object | N/A    |  否  | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 |
 
 ### Has
 
-| 参数名 | 类型   | 返回值  | 必填 | 描述                           |
-| ------ | ------ | ------- | :--: | ------------------------------ |
-| key    | string | boolean |  是  | 判断对应属性的属性值是否存在。 |
+has(propName: string): boolean
+
+判断属性值是否存在。
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述       |
+| -------- | ------ | :--: | ------ | -------------- |
+| propName | string |  是  | -      | 属性的属性值。 |
+
+#### 返回值：
+
+| 类型    | 描述                   |
+| ------- | ---------------------- |
+| boolean | 返回判断后的布尔类型。 |
+
+
 
 ### Get
 
-| 参数名 | 类型   | 返回值         | 必填 | 描述                 |
-| ------ | ------ | -------------- | :--: | -------------------- |
-| key    | string | T or undefined |  是  | 获取对应key值的value |
+get<T>(propName: string): T
+
+获取对应key值的value。
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述          |
+| -------- | ------ | :--: | ------ | ----------------- |
+| propName | string |  是  | -      | 传入对应的key值。 |
+
+#### 返回值：
+
+| 类型           | 描述               |
+| -------------- | ------------------ |
+| T or undefined | 返回获得后的结果。 |
 
 ### Set
 
-| 参数名   | 类型   | 返回值  | 必填 | 描述                                                  |
-| -------- | ------ | ------- | :--: | ----------------------------------------------------- |
-| key      | string | boolean |  是  | 如果存在key值，设置value值并返回true。否则返回false。 |
-| newValue | T      | boolean |  是  | 如果存在key值，设置value值并返回true。否则返回false。 |
+ set<T>(propName: string, newValue: T): boolean
+
+存储value值。
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述          |
+| -------- | ------ | :--: | ------ | ----------------- |
+| propName | string |  是  | -      | 要设置的key值。   |
+| newValue | T      |  是  | -      | 要设置的value值。 |
+
+#### 返回值：
+
+| 类型    | 描述                                                  |
+| ------- | ----------------------------------------------------- |
+| boolean | 如果存在key值，设置value值并返回true，否则返回false。 |
 
 ### SetOrCreate
 
-| 参数名   | 类型   | 返回值  | 必填 | 描述                                                         |
-| -------- | ------ | ------- | :--: | ------------------------------------------------------------ |
-| key      | string | boolean |  是  | 如果已存在与给定键名字相同的属性，更新其值且返回true。       |
-| newValue | T      | boolean |  是  | 如果不存在具有给定名称的属性，在LocalStorage中创建具有给定默认值的新属性，默认值必须是T类型。不允许undefined or null 返回true。 |
+ setOrCreate<T>(propName: string, newValue: T): boolean
+
+创建或更新setOrCreate内部的值
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述                    |
+| -------- | ------ | :--: | ------ | --------------------------- |
+| propName | string |  是  | -      | 传入要更新或者创建的key值。 |
+| newValue | T      |  是  | -      | 传入要更新或创建的value值。 |
+
+#### 返回值：
+
+| 类型    | 描述                                                         |
+| ------- | ------------------------------------------------------------ |
+| boolean | 如果已存在与给定键名字相同的属性，更新其值且返回true。如果不存在具有给定名称的属性，在LocalStorage中创建具有给定默认值的新属性，默认值必须是T类型。不允许undefined or null 返回true。 |
 
 ### Link
 
-| 参数名 | 类型   | 返回值 | 必填 | 描述                                                         |
-| ------ | ------ | ------ | :--: | ------------------------------------------------------------ |
-| key    | string | T      |  是  | 如果存在具有给定键的属性，返回到此属性的双向绑定，该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage，然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性，返回undefined。 |
+ link<T>(propName: string, linkUser?: T, subscribersName?: string): T
+
+与localStorage双向数据绑定。
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述               |
+| -------- | ------ | :--: | ------ | ---------------------- |
+| propName | string |  是  | -      | 要双向绑定的属性名称。 |
+
+#### 返回值：
+
+| 类型 | 描述                                                         |
+| ---- | ------------------------------------------------------------ |
+| T    | 如果存在具有给定键的属性，返回到此属性的双向绑定，该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage，然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性，返回undefined。 |
 
 ### SetAndLink
 
-| 参数名       | 类型   | 返回值 | 必填 | 描述                                                         |
-| ------------ | ------ | ------ | :--: | ------------------------------------------------------------ |
-| key          | string | @Link  |  是  | 与Link接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Link返回。 |
-| defaultValue | T      | @Link  |  是  | 与Link接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Link返回。 |
+ setAndLink<T>(propName: string, defaultValue: T, linkUser?: T, subscribersName?: string): T
+
+与link接口类似，双向数据绑定localStorage。
+
+#### 参数：
+
+| 参数名       | 类型   | 必填 | 默认值 | 参数描述              |
+| ------------ | ------ | :--: | ------ | --------------------- |
+| propName     | string |  是  | -      | 传入要进行创建的key值 |
+| defaultValue | T      |  是  | -      | 要进行设置的默认值    |
+
+#### 返回值：
+
+| 类型  | 描述                                                         |
+| ----- | ------------------------------------------------------------ |
+| @Link | 与Link接口类似，如果当前的key保存于LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Link返回。 |
 
  注：Link接口链接：https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ts-component-states-link.md
 
 ### Prop
 
-| 参数名 | 类型   | 返回值 | 必填 | 描述                                                         |
-| ------ | ------ | ------ | :--: | ------------------------------------------------------------ |
-| key    | string | @Prop  |  是  | 如果存在具有给定键的属性，返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量，适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
+prop<T>(propName: string, propUser?: T, subscribersName?: string): T
+
+单向属性绑定的一种。更新组件的状态。
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述                  |
+| -------- | ------ | :--: | ------ | ------------------------- |
+| propName | string |  是  | -      | 传入要单向数据绑定的key值 |
+
+#### 返回值：
+
+| 类型  | 描述                                                         |
+| ----- | ------------------------------------------------------------ |
+| @Prop | 如果存在具有给定键的属性，返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量，适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
 
 ### SetAndProp
 
-| 参数名       | 类型   | 返回值 | 必填 | 描述                                                         |
-| ------------ | ------ | ------ | :--: | ------------------------------------------------------------ |
-| key          | string | @Prop  |  是  | 与Prop接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Prop返回。 |
-| defaultValue | S      | @Prop  |  是  | 与Prop接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Prop返回。 |
+setAndProp<T>(propName: string, defaultValue: T, propUser?: T, subscribersName?: string): T
+
+与Prop接口类似，存在localStorage的单向数据绑定prop值
+
+#### 参数：
+
+| 参数名       | 类型   | 必填 | 默认值 | 参数描述                    |
+| ------------ | ------ | :--: | ------ | --------------------------- |
+| propName     | string |  是  | -      | 要保存的的键值对中的key值。 |
+| defaultValue | S      |  是  | -      | 创建的默认值。              |
+
+#### 返回值：
+
+| 类型  | 描述                                                         |
+| ----- | ------------------------------------------------------------ |
+| @Prop | 如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Prop返回。 |
+
+
 
 注：Prop接口链接：https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ts-component-states-prop.md
 
 ### Delete
 
-| 参数名 | 类型   | 返回值  | 必填 | 描述                                                         |
-| ------ | ------ | ------- | :--: | ------------------------------------------------------------ |
-| key    | string | boolean |  是  | 删除key指定的键值对，如果存在且删除成功返回true，不存在或删除失败返回false。 |
+delete(propName: string): boolean
+
+删除key指定的键值对
+
+#### 参数：
+
+| 参数名   | 类型   | 必填 | 默认值 | 参数描述              |
+| -------- | ------ | :--: | ------ | --------------------- |
+| propName | string |  是  | -      | 要删除的属性的key值。 |
+
+#### 返回值：
+
+| 类型    | 描述                                                         |
+| ------- | ------------------------------------------------------------ |
+| boolean | 删除key指定的键值对，如果存在且删除成功返回true，不存在或删除失败返回false。 |
 
 ### Keys
 
-| 参数名 | 类型 | 返回值        | 必填 | 描述                         |
-| ------ | ---- | ------------- | :--: | ---------------------------- |
-| none   | none | array<string> |  是  | 返回包含所有键的字符串数组。 |
+keys(): IterableIterator<string>
+
+查找所有键
+
+#### 参数：
+
+| 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
+| ------ | ---- | :--: | ------ | -------- |
+| none   | none |  是  | -      | 无       |
+
+#### 返回值：
+
+| 类型          | 描述                         |
+| ------------- | ---------------------------- |
+| array<string> | 返回包含所有键的字符串数组。 |
 
 ### Size
 
-| 参数名 | 类型 | 返回值 | 必填 | 描述                   |
-| ------ | ---- | ------ | :--: | ---------------------- |
-| none   | none | number |  是  | 与Map.size()用法相同。 |
+size(): number
+
+存在的键值对的个数
+
+#### 参数：
+
+| 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
+| ------ | ---- | :--: | ------ | -------- |
+| none   | none |  是  | -      | 无       |
+
+#### 返回值：
+
+| 类型   | 描述                   |
+| ------ | ---------------------- |
+| number | 与Map.size()用法相同。 |
 
 ### Clear
 
-| 参数名 | 类型 | 返回值  | 必填 | 描述                                                        |
-| ------ | ---- | ------- | :--: | ----------------------------------------------------------- |
-| none   | none | boolean |  是  | 删除所有的属性，如果当前有状态变量依旧引用此属性，返回false |
+clear(): boolean
+
+删除所有的属性
+
+#### 参数：
+
+| 参数名 | 类型 | 必填 | 默认值 | 参数描述 |
+| ------ | ---- | :--: | ------ | -------- |
+| none   | none |  是  | -      | 无       |
+
+#### 返回值：
+
+| 类型    | 描述                                                        |
+| ------- | ----------------------------------------------------------- |
+| boolean | 删除所有的属性，如果当前有状态变量依旧引用此属性，返回false |
 
 ### 示例1（在一个Ability创建的LocalStorage）：