jsapi_properties.md

layout
doc

pyChariot.api.properties

此模块用来保存一些简单的数据，数据保存在 _properties.json 中，当小应用启动时自动装载，退出时自动保存。

set(name, value) {#set}

设置指定属性的值

参数	类型	说明
name	string	属性变量名称
value	string	属性变量值，可忽略，默认为 null（即删除属性）

await __A.properties.set('nnn', 'vvv');    // 设置属性 nnn 的值为 "vvv"
await __A.properties.set('nnn', 12345);    // 设置属性 nnn 的值为 "12345"
await __A.properties.set('nnn', null);     // 删除名称属性 nnn
await __A.properties.set('nnn');           // 删除名称属性 nnn

unset(name) {#unset}

删除指定属性

参数	说明	默认值
name	string	属性名称

await __A.properties.unset('nnn');           // 删除属性 nnn

get(name, default) {#get}

获取指定属性的值。

参数	类型	说明
name	string	属性名称
default	string	默认值，可忽略，默认为 null

返回值	说明
string	返回属性的值，如果指定属性不存在则返回默认值。

await __A.properties.get('nnn');           // 获取属性 nnn，默认返回 null
await __A.properties.get('nnn', null);     // 获取属性 nnn，默认返回 null
await __A.properties.get('nnn', 12345);    // 获取属性 nnn，默认返回 "12345"
await __A.properties.get('nnn', "vvv");    // 获取属性 nnn，默认返回 "vvv"

pop(name, default) {#pop}

删除指定属性，并返回其值。

参数	说明	默认值
name	string	属性名称
default	string	默认值，可忽略，默认为 null

返回值	说明
string	返回属性的值，如果指定的属性不存在则返回指定的默认值。

await __A.properties.pop('nnn');           // 获取属性 nnn，默认返回 null
await __A.properties.pop('nnn', null);     // 获取属性 nnn，默认返回 null
await __A.properties.pop('nnn', 12345);    // 获取属性 nnn，默认返回 "12345"
await __A.properties.pop('nnn', "vvv");    // 获取属性 nnn，默认返回 "vvv"

getsep() {#getsep}

获取指定属性中使用的分隔符

返回值	说明
string	属性中使用的分隔符，: 或者 ;。

await __A.properties.getsep();

items() {#items}

获取当前所有属性名值对对象

返回值	说明
object

env = await __A.properties.items();

keys() {#keys}

获取当前所有属性的名称

返回值	说明
object

env = await __A.properties.keys();

values() {#values}

获取当前所有属性的值

返回值	说明
object

env = await __A.properties.values();

save() {#save}

将数据保存到文件 _properties.json 中

env = await __A.properties.save();