类 BaseStore抽象

键值存储的抽象基类。

继承关系 (查看完整继承关系)

构造函数

构造函数

方法

batch delete get listNamespaces put search start stop

构造函数

constructor

方法

抽象 batch

  • batch<Op>(_operations): Promise<OperationResults<Op>>

  • 执行一批操作。

    类型参数

    参数

    • _operations: Op

      要执行的操作数组。

    返回 Promise<OperationResults<Op>>

    一个解析为操作结果的 Promise。

delete

  • delete(namespace, key): Promise<void>

  • 删除一个项目。

    参数

    • namespace: string[]

      项目的层次路径。

    • key: string

      命名空间内的唯一标识符。

    返回 Promise<void>

get

  • get(namespace, key): Promise<null | Item>

  • 检索单个项目。

    参数

    • namespace: string[]

      项目的层次路径。

    • key: string

      命名空间内的唯一标识符。

    返回 Promise<null | Item>

    一个解析为检索到的项目或 null（如果未找到）的 Promise。

listNamespaces

  • listNamespaces(options): Promise<string[][]>

  • 列出并筛选存储中的命名空间。

    参数

    • options: {
          limit?: number;
          maxDepth?: number;
          offset?: number;
          prefix?: string[];
          suffix?: string[];
      }

      列出命名空间的选项。

      • 可选 limit?: number

        要返回的最大命名空间数（默认 100）。

      • 可选 maxDepth?: number

        返回层次结构中深度不超过此深度的命名空间。

      • 可选 offset?: number

        要跳过的命名空间数，用于分页（默认 0）。

      • 可选 prefix?: string[]

        筛选以此路径开头的命名空间。

      • 可选 suffix?: string[]

        筛选以此路径结尾的命名空间。

    返回 Promise<string[][]>

    一个解析为匹配条件的命名空间数组列表的 Promise。

put

  • put(namespace, key, value): Promise<void>

  • 存储或更新一个项目。

    参数

    • namespace: string[]

      项目的层次路径。

    • key: string

      命名空间内的唯一标识符。

    • value: Record<string, any>

      包含项目数据的对象。

    返回 Promise<void>

search

  • search(namespacePrefix, options?): Promise<Item[]>

  • 搜索命名空间前缀内的项目。

    参数

    • namespacePrefix: string[]

      要搜索的层次路径前缀。

    • 可选 options: {
          filter?: Record<string, any>;
          limit?: number;
          offset?: number;
      }

      搜索选项。

      • 可选 filter?: Record<string, any>

        要筛选结果的键值对。

      • 可选 limit?: number

        要返回的最大项目数（默认：10）。

      • 可选 offset?: number

        在返回结果之前要跳过的项目数（默认：0）。

    返回 Promise<Item[]>

    一个解析为匹配搜索条件的项目列表的 Promise。

start

  • start(): void

  • 启动存储。如果未实现则为无操作。

    返回 void

stop

  • stop(): void

  • 停止存储。如果未实现，则为无操作。

    返回 void

设置

成员可见性

主题

本页内容

constructorbatchdeletegetlistNamespacesputsearchstartstop