神岛 API 文档 - ArenaPro版
    Preparing search index...

    Class GameDataStorage<T>

    Type Parameters

    • T

    Implements

    • GameDataStorage
    Index

    Properties

    destroy: () => Promise<void>

    销毁数据存储空间

    get: (key: string) => Promise<ReturnValue<T>>

    获取数据

    Type declaration

    increment: (key: string, value?: number) => Promise<number>

    原子方式递增给定键的值,当对应键不存在时视作设置值,对应值不为数字时报错。

    • 通过此方式修改值时不会触发数据锁定。

    Type declaration

      • (key: string, value?: number): Promise<number>
      • Parameters

        • key: string

          需要递增的键

        • Optionalvalue: number

          递增量,默认为 1

        Returns Promise<number>

        返回累加后的数值

    key: string

    数据存储空间名称

    list: (options: ListPageOptions) => Promise<QueryList<T>>

    获取数据列表

    Type declaration

    remove: (key: string) => Promise<ReturnValue<T>>

    删除数据

    Type declaration

    set: (key: string, value: T) => Promise<void>

    设置数据

    Type declaration

      • (key: string, value: T): Promise<void>
      • Parameters

        • key: string

          数据键名

        • value: T

          数据值

        Returns Promise<void>

    update: (
        key: string,
        handler: (prevValue: ReturnValue<T>) => T,
    ) => Promise<void>

    更新数据

    Type declaration

      • (key: string, handler: (prevValue: ReturnValue<T>) => T): Promise<void>
      • Parameters

        • key: string

          数据键名

        • handler: (prevValue: ReturnValue<T>) => T

          数据更新处理器

        Returns Promise<void>

        返回更新后的数据