Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
f784db1c
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
“e3685f1a483b32d7325128a1d32bd32cb13b6467”上不存在“git@gitcode.net:SFFPCJ/gpt-prompt_01.git”
提交
f784db1c
编写于
11月 11, 2022
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
c8b39499
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
155 addition
and
151 deletion
+155
-151
zh-cn/application-dev/reference/arkui-ts/ts-state-management.md
...application-dev/reference/arkui-ts/ts-state-management.md
+153
-151
zh-cn/application-dev/website.md
zh-cn/application-dev/website.md
+2
-0
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-state-management.md
浏览文件 @
f784db1c
...
@@ -2,7 +2,9 @@
...
@@ -2,7 +2,9 @@
状态管理模块提供了应用程序的数据存储能力、持久化数据管理能力、Ability数据存储能力和应用程序需要的环境状态,其中Ability数据存储从API version9开始支持。
状态管理模块提供了应用程序的数据存储能力、持久化数据管理能力、Ability数据存储能力和应用程序需要的环境状态,其中Ability数据存储从API version9开始支持。
> 说明:本模块首批接口从API version 7开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
> 本模块首批接口从API version 7开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## AppStorage
## AppStorage
...
@@ -15,13 +17,13 @@ Link(propName: string): any
...
@@ -15,13 +17,13 @@ Link(propName: string): any
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | :----------
-----------
|
| -------- | ------ | :--- | :---------- |
| propName | string | 是 | 要双向绑定的属性名称。 |
| propName | string | 是 | 要双向绑定的属性名称。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Link | 在具有给定键的数据,则返回到此属性的双向数据绑定,该双向绑定意味着变量或者组件对数据的更改将同步到AppStorage,通过AppStorage对数据的修改将同步到变量或者组件。 |
| @Link | 在具有给定键的数据,则返回到此属性的双向数据绑定,该双向绑定意味着变量或者组件对数据的更改将同步到AppStorage,通过AppStorage对数据的修改将同步到变量或者组件。 |
```
ts
```
ts
...
@@ -37,15 +39,15 @@ SetAndLink\<T>(propName: string, defaultValue: T): SubscribedAbstractProperty\<T
...
@@ -37,15 +39,15 @@ SetAndLink\<T>(propName: string, defaultValue: T): SubscribedAbstractProperty\<T
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | :--- | -----------
---------
|
| ------------ | ------ | :--- | ----------- |
| propName | string | 是 | 要进行创建的key值。 |
| propName | string | 是 | 要进行创建的key值。 |
| defaultValue | T | 是 | 要进行设置的默认值。 |
| defaultValue | T | 是 | 要进行设置的默认值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Link | 与Link接口类似,如果当前的key保存于
Local
Storage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 |
| @Link | 与Link接口类似,如果当前的key保存于
App
Storage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 |
```
ts
```
ts
let
simple
=
AppStorage
.
SetAndLink
(
'
simpleProp
'
,
121
);
let
simple
=
AppStorage
.
SetAndLink
(
'
simpleProp
'
,
121
);
...
@@ -60,13 +62,13 @@ Prop(propName: string): any
...
@@ -60,13 +62,13 @@ Prop(propName: string): any
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--: | -----------
--------
|
| -------- | ------ | :--: | ----------- |
| propName | string | 是 | 要进行创建的key值。 |
| propName | string | 是 | 要进行创建的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Prop | 如果存在具有给定键的属性,则返回此属性的单向数据绑定。该单向绑定意味着只能通过AppStorage将属性的更改同步到变量或者组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态属性,如果具有此键的属性不存在则返回undefined。 |
| @Prop | 如果存在具有给定键的属性,则返回此属性的单向数据绑定。该单向绑定意味着只能通过AppStorage将属性的更改同步到变量或者组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态属性,如果具有此键的属性不存在则返回undefined。 |
```
ts
```
ts
...
@@ -82,15 +84,15 @@ SetAndProp\<S>(propName: string, defaultValue: S): SubscribedAbstractProperty\<S
...
@@ -82,15 +84,15 @@ SetAndProp\<S>(propName: string, defaultValue: S): SubscribedAbstractProperty\<S
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | :--: | ---------------
------------
|
| ------------ | ------ | :--: | --------------- |
| propName | string | 是 | 要保存的的键值对中的key值。 |
| propName | string | 是 | 要保存的的键值对中的key值。 |
| defaultValue | S | 是 | 创建的默认值。 |
| defaultValue | S | 是 | 创建的默认值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Prop | 如果当前的key保存
与Local
Storage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 |
| @Prop | 如果当前的key保存
于App
Storage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 |
```
ts
```
ts
let
simple
=
AppStorage
.
SetAndProp
(
'
simpleProp
'
,
121
);
let
simple
=
AppStorage
.
SetAndProp
(
'
simpleProp
'
,
121
);
...
@@ -105,13 +107,13 @@ Has(propName: string): boolean
...
@@ -105,13 +107,13 @@ Has(propName: string): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -------
-------
|
| -------- | ------ | :--- | ------- |
| propName | string | 是 | 属性的属性值。 |
| propName | string | 是 | 属性的属性值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | -------------
-------------
|
| ------- | ------------- |
| boolean | 返回属性的属性值是否存在。 |
| boolean | 返回属性的属性值是否存在。 |
```
ts
```
ts
...
@@ -127,13 +129,13 @@ Get\<T>(propName: string): T | undefined
...
@@ -127,13 +129,13 @@ Get\<T>(propName: string): T | undefined
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---- | -----------
--------
|
| -------- | ------ | ---- | ----------- |
| propName | string | 是 | 要获取对应的key值。 |
| propName | string | 是 | 要获取对应的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -----------------
- | -------------
------------- |
| -----------------
|
------------- |
| boolean或undefined | 返回属性的属性值是否存在。 |
| boolean或undefined | 返回属性的属性值是否存在。 |
```
ts
```
ts
...
@@ -149,14 +151,14 @@ Set<T>(propName: string, newValue: T): boolean
...
@@ -149,14 +151,14 @@ Set<T>(propName: string, newValue: T): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -----------
------
|
| -------- | ------ | :--- | ----------- |
| propName | string | 是 | 要设置的key值。 |
| propName | string | 是 | 要设置的key值。 |
| newValue | T | 是 | 要设置的value值。 |
| newValue | T | 是 | 要设置的value值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | -----------------------------------
------------------
|
| ------- | ----------------------------------- |
| boolean | 如果存在key值,设置value值并返回true,否则返回false。 |
| boolean | 如果存在key值,设置value值并返回true,否则返回false。 |
```
ts
```
ts
...
@@ -172,15 +174,15 @@ SetOrCreate<T>(propName: string, newValue: T): void
...
@@ -172,15 +174,15 @@ SetOrCreate<T>(propName: string, newValue: T): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | ---------------
----------
|
| -------- | ------ | :--- | --------------- |
| propName | string | 是 | 要更新或者创建的key值。 |
| propName | string | 是 | 要更新或者创建的key值。 |
| newValue | T | 是 | 要更新或者创建的value值。 |
| newValue | T | 是 | 要更新或者创建的value值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在
Local
Storage中创建具有给定默认值的新属性,默认值必须是T类型。不允许undefined 或 null 返回true。 |
| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在
App
Storage中创建具有给定默认值的新属性,默认值必须是T类型。不允许undefined 或 null 返回true。 |
```
ts
```
ts
let
simple
=
AppStorage
.
SetOrCreate
(
'
simpleProp
'
,
121
);
let
simple
=
AppStorage
.
SetOrCreate
(
'
simpleProp
'
,
121
);
...
@@ -195,13 +197,13 @@ Delete(propName: string): boolean
...
@@ -195,13 +197,13 @@ Delete(propName: string): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | ------------
---------
|
| -------- | ------ | :--- | ------------ |
| propName | string | 是 | 要删除的属性的key值。 |
| propName | string | 是 | 要删除的属性的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 |
| boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 |
```
ts
```
ts
...
@@ -217,7 +219,7 @@ keys(): IterableIterator\<string>
...
@@ -217,7 +219,7 @@ keys(): IterableIterator\<string>
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -------------- | --------------
--------------
|
| -------------- | -------------- |
| array
\<
string> | 返回包含所有键的字符串数组。 |
| array
\<
string> | 返回包含所有键的字符串数组。 |
```
ts
```
ts
...
@@ -233,7 +235,7 @@ staticClear(): boolean
...
@@ -233,7 +235,7 @@ staticClear(): boolean
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ---------------------------------
---------------------------
|
| ------- | --------------------------------- |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
```
ts
```
ts
...
@@ -249,13 +251,13 @@ IsMutable(propName: string): boolean
...
@@ -249,13 +251,13 @@ IsMutable(propName: string): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | ------------
---------
|
| -------- | ------ | :--- | ------------ |
| propName | string | 是 | 要查询的属性的key值。 |
| propName | string | 是 | 要查询的属性的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ------------------
------------------
|
| ------- | ------------------ |
| boolean | 返回此属性是否存在并且是否可以改变。 |
| boolean | 返回此属性是否存在并且是否可以改变。 |
```
ts
```
ts
...
@@ -271,7 +273,7 @@ Size(): number
...
@@ -271,7 +273,7 @@ Size(): number
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------ | ---------
---------
|
| ------ | --------- |
| number | 返回键值对的数量。 |
| number | 返回键值对的数量。 |
```
ts
```
ts
...
@@ -289,7 +291,7 @@ constructor(initializingProperties?: Object)
...
@@ -289,7 +291,7 @@ constructor(initializingProperties?: Object)
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ---------------------- | ------ | ---- | ----------------------------------------
--------------------
|
| ---------------------- | ------ | ---- | ---------------------------------------- |
| initializingProperties | Object | 否 | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 |
| initializingProperties | Object | 否 | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 |
```
ts
```
ts
...
@@ -307,7 +309,7 @@ static GetShared(): LocalStorage
...
@@ -307,7 +309,7 @@ static GetShared(): LocalStorage
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ----------------------------- | -----------------
-----
|
| ----------------------------- | ----------------- |
|
[
LocalStorage
](
#localstorage
)
| 返回LocalStorage对象。 |
|
[
LocalStorage
](
#localstorage
)
| 返回LocalStorage对象。 |
```
ts
```
ts
...
@@ -323,13 +325,13 @@ has(propName: string): boolean
...
@@ -323,13 +325,13 @@ has(propName: string): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -------
-------
|
| -------- | ------ | :--- | ------- |
| propName | string | 是 | 属性的属性值。 |
| propName | string | 是 | 属性的属性值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | -------------
-------------
|
| ------- | ------------- |
| boolean | 返回属性的属性值是否存在。 |
| boolean | 返回属性的属性值是否存在。 |
```
ts
```
ts
...
@@ -346,13 +348,13 @@ get\<T>(propName: string): T
...
@@ -346,13 +348,13 @@ get\<T>(propName: string): T
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -----------
--------
|
| -------- | ------ | :--- | ----------- |
| propName | string | 是 | 要获取对应的key值。 |
| propName | string | 是 | 要获取对应的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -------------- | ----------------------------------------
---------------
|
| -------------- | ---------------------------------------- |
| T
\|
undefined | 当keyvalue存在时,返回keyvalue值。不存在返回undefined。 |
| T
\|
undefined | 当keyvalue存在时,返回keyvalue值。不存在返回undefined。 |
```
ts
```
ts
...
@@ -369,14 +371,14 @@ set\<T>(propName: string, newValue: T): boolean
...
@@ -369,14 +371,14 @@ set\<T>(propName: string, newValue: T): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -----------
------
|
| -------- | ------ | :--- | ----------- |
| propName | string | 是 | 要设置的key值。 |
| propName | string | 是 | 要设置的key值。 |
| newValue | T | 是 | 要设置的value值。 |
| newValue | T | 是 | 要设置的value值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | -----------------------------------
------------------
|
| ------- | ----------------------------------- |
| boolean | 如果存在key值,设置value值并返回true,否则返回false。 |
| boolean | 如果存在key值,设置value值并返回true,否则返回false。 |
```
ts
```
ts
...
@@ -393,14 +395,14 @@ setOrCreate\<T>(propName: string, newValue: T): boolean
...
@@ -393,14 +395,14 @@ setOrCreate\<T>(propName: string, newValue: T): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | --------------
---------
|
| -------- | ------ | :--- | -------------- |
| propName | string | 是 | 要更新或创建的key值。 |
| propName | string | 是 | 要更新或创建的key值。 |
| newValue | T | 是 | 要更新或创建的value值。 |
| newValue | T | 是 | 要更新或创建的value值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在LocalStorage中创建具有给定默认值的新属性,默认值必须是T类型,不允许undefined 或 null 。 |
| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在LocalStorage中创建具有给定默认值的新属性,默认值必须是T类型,不允许undefined 或 null 。 |
```
ts
```
ts
...
@@ -417,13 +419,13 @@ link\<T>(propName: string): T
...
@@ -417,13 +419,13 @@ link\<T>(propName: string): T
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -----------
-----------
|
| -------- | ------ | :--- | ----------- |
| propName | string | 是 | 要双向绑定的属性名称。 |
| propName | string | 是 | 要双向绑定的属性名称。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ---- | ----------------------------------------
--------------------
|
| ---- | ---------------------------------------- |
| T | 如果存在具有给定键的属性,返回到此属性的双向绑定,该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage,然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性,返回undefined。 |
| T | 如果存在具有给定键的属性,返回到此属性的双向绑定,该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage,然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性,返回undefined。 |
```
ts
```
ts
...
@@ -440,14 +442,14 @@ setAndLink\<T>(propName: string, defaultValue: T): T
...
@@ -440,14 +442,14 @@ setAndLink\<T>(propName: string, defaultValue: T): T
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | :--- | -----------
---------
|
| ------------ | ------ | :--- | ----------- |
| propName | string | 是 | 要进行创建的key值。 |
| propName | string | 是 | 要进行创建的key值。 |
| defaultValue | T | 是 | 要进行设置的默认值。 |
| defaultValue | T | 是 | 要进行设置的默认值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -----
------------------------------- | --------------------
---------------------------------------- |
| -----
|
---------------------------------------- |
| @Link | 与Link接口类似,如果当前的key保存于LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 |
| @Link | 与Link接口类似,如果当前的key保存于LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 |
```
ts
```
ts
...
@@ -464,13 +466,13 @@ prop\<T>(propName: string): T
...
@@ -464,13 +466,13 @@ prop\<T>(propName: string): T
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | -------------
----------
|
| -------- | ------ | :--- | ------------- |
| propName | string | 是 | 要单向数据绑定的key值。 |
| propName | string | 是 | 要单向数据绑定的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -----
------------------------------- | --------------------
---------------------------------------- |
| -----
|
---------------------------------------- |
| @Prop | 如果存在具有给定键的属性,返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
| @Prop | 如果存在具有给定键的属性,返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
```
ts
```
ts
...
@@ -487,14 +489,14 @@ setAndProp\<T>(propName: string, defaultValue: T): T
...
@@ -487,14 +489,14 @@ setAndProp\<T>(propName: string, defaultValue: T): T
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | :--- | --------------
-----------
|
| ------------ | ------ | :--- | -------------- |
| propName | string | 是 | 要保存的键值对中的key值。 |
| propName | string | 是 | 要保存的键值对中的key值。 |
| defaultValue | T | 是 | 创建的默认值。 |
| defaultValue | T | 是 | 创建的默认值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -----
------------------------------- | --------------------
---------------------------------------- |
| -----
|
---------------------------------------- |
| @Prop | 如果当前的key保存与LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 |
| @Prop | 如果当前的key保存与LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 |
```
ts
```
ts
...
@@ -511,13 +513,13 @@ delete(propName: string): boolean
...
@@ -511,13 +513,13 @@ delete(propName: string): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | ------------
---------
|
| -------- | ------ | :--- | ------------ |
| propName | string | 是 | 要删除的属性的key值。 |
| propName | string | 是 | 要删除的属性的key值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 |
| boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 |
```
ts
```
ts
...
@@ -534,7 +536,7 @@ keys(): IterableIterator\<string>
...
@@ -534,7 +536,7 @@ keys(): IterableIterator\<string>
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| -------------- | --------------
--------------
|
| -------------- | -------------- |
| array
\<
string> | 返回包含所有键的字符串数组。 |
| array
\<
string> | 返回包含所有键的字符串数组。 |
```
ts
```
ts
...
@@ -551,7 +553,7 @@ size(): number
...
@@ -551,7 +553,7 @@ size(): number
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------ | ---------
---------
|
| ------ | --------- |
| number | 返回键值对的数量。 |
| number | 返回键值对的数量。 |
```
ts
```
ts
...
@@ -568,7 +570,7 @@ clear(): boolean
...
@@ -568,7 +570,7 @@ clear(): boolean
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ---------------------------------
---------------------------
|
| ------- | --------------------------------- |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
```
ts
```
ts
...
@@ -587,7 +589,7 @@ constructor(appStorage: AppStorage, storage: Storage)
...
@@ -587,7 +589,7 @@ constructor(appStorage: AppStorage, storage: Storage)
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ---------- | ---------- | :--- | ----------------
----------------
|
| ---------- | ---------- | :--- | ---------------- |
| appStorage | AppStorage | 是 | 保存所有属性及属性值的单例对象。 |
| appStorage | AppStorage | 是 | 保存所有属性及属性值的单例对象。 |
| storage | Storage | 是 | Storage实例对象。 |
| storage | Storage | 是 | Storage实例对象。 |
...
@@ -604,7 +606,7 @@ PersistProp(key:string,defaultValue:T):void
...
@@ -604,7 +606,7 @@ PersistProp(key:string,defaultValue:T):void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | :--- | --------------
---------
|
| ------------ | ------ | :--- | -------------- |
| key | string | 是 | 要关联的属性的key值。 |
| key | string | 是 | 要关联的属性的key值。 |
| defaultValue | T | 是 | 要关联的属性的value值。 |
| defaultValue | T | 是 | 要关联的属性的value值。 |
...
@@ -621,7 +623,7 @@ DeleteProp(key: string): void
...
@@ -621,7 +623,7 @@ DeleteProp(key: string): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ----
-- | ------ | :--- | ---------
------------ |
| ----
| ------ | :--- |
------------ |
| key | string | 是 | 要取消的属性的key值。 |
| key | string | 是 | 要取消的属性的key值。 |
```
ts
```
ts
...
@@ -637,7 +639,7 @@ PersistProps(properties: {key: string, defaultValue: any}[]): void;
...
@@ -637,7 +639,7 @@ PersistProps(properties: {key: string, defaultValue: any}[]): void;
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 |
| ----
-- | ---------------------------------- | :--: | ---------
--------- |
| ----
| ---------------------------------- | :--: |
--------- |
| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 |
| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 |
```
ts
```
ts
...
@@ -653,7 +655,7 @@ Keys(): Array<string>
...
@@ -653,7 +655,7 @@ Keys(): Array<string>
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------------- | -------------
-------------
|
| ------------- | ------------- |
| Array
<string>
| 返回所有持久化属性的标记。 |
| Array
<string>
| 返回所有持久化属性的标记。 |
```
ts
```
ts
...
@@ -685,14 +687,14 @@ EnvProp\<S>(key: string, value: S): boolean
...
@@ -685,14 +687,14 @@ EnvProp\<S>(key: string, value: S): boolean
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 |
| -----
- | ------ | :--- | --------------- | ------
----------- |
| -----
| ------ | :--- | ---------- |
----------- |
| key | string | 是 | 要关联的key值 | 要关联的key值。 |
| key | string | 是 | 要关联的key值 | 要关联的key值。 |
| value | S | 是 | 要关联的value值 | 要关联的value值。 |
| value | S | 是 | 要关联的value值 | 要关联的value值。 |
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------- | ----------------------
------------
|
| ------- | ---------------------- |
| boolean | 返回该属性在AppStorage中是否存在。 |
| boolean | 返回该属性在AppStorage中是否存在。 |
```
ts
```
ts
...
@@ -708,7 +710,7 @@ EnvProps(props: {key: string;defaultValue: any}[]): void
...
@@ -708,7 +710,7 @@ EnvProps(props: {key: string;defaultValue: any}[]): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 |
| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 |
| ----
-- | ---------------------------------- | :--- | ------------------ | ---------
--------- |
| ----
| ---------------------------------- | :--- | --------- |
--------- |
| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | 要关联的属性数组。 |
| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | 要关联的属性数组。 |
```
ts
```
ts
...
@@ -724,7 +726,7 @@ Keys(): Array<string>
...
@@ -724,7 +726,7 @@ Keys(): Array<string>
**返回值:**
**返回值:**
| 类型 | 描述 |
| 类型 | 描述 |
| ------------- | -----------
-----------
|
| ------------- | ----------- |
| Array
<string>
| 返回关联的系统项数组。 |
| Array
<string>
| 返回关联的系统项数组。 |
```
ts
```
ts
...
...
zh-cn/application-dev/website.md
浏览文件 @
f784db1c
...
@@ -490,6 +490,8 @@
...
@@ -490,6 +490,8 @@
-
[
时间选择弹窗
](
reference/arkui-ts/ts-methods-timepicker-dialog.md
)
-
[
时间选择弹窗
](
reference/arkui-ts/ts-methods-timepicker-dialog.md
)
-
[
文本选择弹窗
](
reference/arkui-ts/ts-methods-textpicker-dialog.md
)
-
[
文本选择弹窗
](
reference/arkui-ts/ts-methods-textpicker-dialog.md
)
-
[
菜单
](
reference/arkui-ts/ts-methods-menu.md
)
-
[
菜单
](
reference/arkui-ts/ts-methods-menu.md
)
-
[
应用级变量的状态管理
](
reference/arkui-ts/ts-state-management.md
)
-
[
像素单位
](
reference/arkui-ts/ts-pixel-units.md
)
-
[
枚举说明
](
reference/arkui-ts/ts-appendix-enums.md
)
-
[
枚举说明
](
reference/arkui-ts/ts-appendix-enums.md
)
-
[
类型说明
](
reference/arkui-ts/ts-types.md
)
-
[
类型说明
](
reference/arkui-ts/ts-types.md
)
-
组件参考(兼容JS的类Web开发范式)
-
组件参考(兼容JS的类Web开发范式)
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录