EasyBox3Lib~ DataStorage

代表数据存储空间的类。仅能通过 getDataStorage 创建。能够以键值对的形式存储数据,提供方法处理空间内键值对相关的操作。
和官方的GameDataStorage不同,DataStorage自带缓存
也可以直接在Pro编辑器使用

Constructor

new DataStorage(key, gameDataStorage)

定义一个DataStorage

Parameters:
NameTypeDescription
keystring

空间名称(只读)

gameDataStorageGameDataStorage

对应的GameDataStorage

Members

key :string

数据储存空间名称

Type:
  • string

key :string

数据储存空间名称

Type:
  • string

Methods

(async) get(key) → {ReturnValue|undefined}

获取指定键对应的值
如果没有指定的键,返回undefined
注意:非Pro地图version将会返回空字符串

Parameters:
NameTypeDescription
keystring

指定的键

Returns:
Type: 
ReturnValue | undefined

(async) set(key, value)

传入指定键与值,无论该键是否存在,均将值设置到此键上。

Parameters:
NameTypeDescription
keystring

需要设置的键

valueJSONValue

需要设置的值

(async) update(key, handler)

使用传入的方法更新键值对

Parameters:
NameTypeDescription
keystring

需要更新的键

handlerdataStorageUpdateCallBack

处理更新的方法,接受一个参数,为当前键的值,返回一个更新后的值

(async) list(options) → {QueryList|Array.<ReturnValue>}

批量获取键值对
注意:该方法不会创建缓存和读取缓存,所以比get更慢 目前在完全缓存的情况下可以在此使用缓存,需要更改配置文件

Parameters:
NameTypeDescription
optionsListPageOptions

批量获取键值对的配置项

Returns:
Type: 
QueryList | Array.<ReturnValue>

(async) remove(key)

删除键值对

Parameters:
NameTypeDescription
keystring

需要删除的键

(async) drop()

删除表格
警告:删除之后无法恢复,请谨慎使用!!!

(async) createCache()

创建数据储存空间缓存
会缓存全部数据
对于有大量数据的数据库来说,不建议这么做,因为会消耗大量内存

(async) get(key) → {ReturnValue|undefined}

获取指定键对应的值
如果没有指定的键,返回undefined
注意:非Pro地图version将会返回空字符串

Parameters:
NameTypeDescription
keystring

指定的键

Returns:
Type: 
ReturnValue | undefined

(async) set(key, value)

传入指定键与值,无论该键是否存在,均将值设置到此键上。

Parameters:
NameTypeDescription
keystring

需要设置的键

valueJSONValue

需要设置的值

(async) update(key, handler)

使用传入的方法更新键值对

Parameters:
NameTypeDescription
keystring

需要更新的键

handlerdataStorageUpdateCallBack

处理更新的方法,接受一个参数,为当前键的值,返回一个更新后的值

(async) list(options) → {QueryList|Array.<ReturnValue>}

批量获取键值对
注意:该方法不会创建缓存和读取缓存,所以比get更慢 目前在完全缓存的情况下可以在此使用缓存,需要更改配置文件

Parameters:
NameTypeDescription
optionsListPageOptions

批量获取键值对的配置项

Returns:
Type: 
QueryList | Array.<ReturnValue>

(async) remove(key)

删除键值对

Parameters:
NameTypeDescription
keystring

需要删除的键

(async) drop()

删除表格
警告:删除之后无法恢复,请谨慎使用!!!

(async) createCache()

创建数据储存空间缓存
会缓存全部数据
对于有大量数据的数据库来说,不建议这么做,因为会消耗大量内存

EasyBox3Lib~ DataStorage

代表数据存储空间的类。仅能通过 getDataStorage 创建。能够以键值对的形式存储数据,提供方法处理空间内键值对相关的操作。
和官方的GameDataStorage不同,DataStorage自带缓存
也可以直接在Pro编辑器使用

Constructor

new DataStorage(key, gameDataStorage)

定义一个DataStorage

Parameters:
NameTypeDescription
keystring

空间名称(只读)

gameDataStorageGameDataStorage

对应的GameDataStorage

Members

key :string

数据储存空间名称

Type:
  • string

key :string

数据储存空间名称

Type:
  • string

Methods

(async) get(key) → {ReturnValue|undefined}

获取指定键对应的值
如果没有指定的键,返回undefined
注意:非Pro地图version将会返回空字符串

Parameters:
NameTypeDescription
keystring

指定的键

Returns:
Type: 
ReturnValue | undefined

(async) set(key, value)

传入指定键与值,无论该键是否存在,均将值设置到此键上。

Parameters:
NameTypeDescription
keystring

需要设置的键

valueJSONValue

需要设置的值

(async) update(key, handler)

使用传入的方法更新键值对

Parameters:
NameTypeDescription
keystring

需要更新的键

handlerdataStorageUpdateCallBack

处理更新的方法,接受一个参数,为当前键的值,返回一个更新后的值

(async) list(options) → {QueryList|Array.<ReturnValue>}

批量获取键值对
注意:该方法不会创建缓存和读取缓存,所以比get更慢 目前在完全缓存的情况下可以在此使用缓存,需要更改配置文件

Parameters:
NameTypeDescription
optionsListPageOptions

批量获取键值对的配置项

Returns:
Type: 
QueryList | Array.<ReturnValue>

(async) remove(key)

删除键值对

Parameters:
NameTypeDescription
keystring

需要删除的键

(async) drop()

删除表格
警告:删除之后无法恢复,请谨慎使用!!!

(async) createCache()

创建数据储存空间缓存
会缓存全部数据
对于有大量数据的数据库来说,不建议这么做,因为会消耗大量内存

(async) get(key) → {ReturnValue|undefined}

获取指定键对应的值
如果没有指定的键,返回undefined
注意:非Pro地图version将会返回空字符串

Parameters:
NameTypeDescription
keystring

指定的键

Returns:
Type: 
ReturnValue | undefined

(async) set(key, value)

传入指定键与值,无论该键是否存在,均将值设置到此键上。

Parameters:
NameTypeDescription
keystring

需要设置的键

valueJSONValue

需要设置的值

(async) update(key, handler)

使用传入的方法更新键值对

Parameters:
NameTypeDescription
keystring

需要更新的键

handlerdataStorageUpdateCallBack

处理更新的方法,接受一个参数,为当前键的值,返回一个更新后的值

(async) list(options) → {QueryList|Array.<ReturnValue>}

批量获取键值对
注意:该方法不会创建缓存和读取缓存,所以比get更慢 目前在完全缓存的情况下可以在此使用缓存,需要更改配置文件

Parameters:
NameTypeDescription
optionsListPageOptions

批量获取键值对的配置项

Returns:
Type: 
QueryList | Array.<ReturnValue>

(async) remove(key)

删除键值对

Parameters:
NameTypeDescription
keystring

需要删除的键

(async) drop()

删除表格
警告:删除之后无法恢复,请谨慎使用!!!

(async) createCache()

创建数据储存空间缓存
会缓存全部数据
对于有大量数据的数据库来说,不建议这么做,因为会消耗大量内存