键值存储的抽象基类。

层次结构 (查看全部)

构造函数

属性

enqueueOperation: any
nextKey: any
processBatchQueue: any
processingTask: any
queue: any
running: any
store: any

访问器

  • get isRunning(): boolean
  • 返回 boolean

方法

  • 删除一项。

    参数

    • namespace: string[]

      项目的层次路径。

    • key: string

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

    返回 Promise<void>

  • 检索单个项目。

    参数

    • namespace: string[]

      项目的层次路径。

    • key: string

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

    返回 Promise<null | Item>

    一个承诺,解析为检索到的项目,如果未找到则解析为 null。

  • 列出和过滤存储中的命名空间。

    参数

    • 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[][]>

    一个承诺,解析为一个命名空间数组列表,它们匹配这些条件。

  • 存储或更新一项。

    参数

    • namespace: string[]

      项目的层次路径。

    • key: string

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

    • value: Record<string, any>

      包含项目数据的对象。

    返回 Promise<void>

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

    参数

    • namespacePrefix: string[]

      要搜索的层次路径前缀。

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

      搜索选项。

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

    返回 Promise<Item[]>

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

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

    返回 void

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

    返回 Promise<void>