Monarch Database API - v1.0.0
    Preparing search index...

    Interface StreamOperations

    interface StreamOperations {
        xadd(
            key: string,
            id: string,
            fields: Record<string, any>,
        ): Promise<string>;
        xdel(key: string, ids: string[]): Promise<number>;
        xlen(key: string): Promise<number>;
        xrange(
            key: string,
            start: string,
            end: string,
            count?: number,
        ): Promise<StreamEntry[]>;
        xread(
            streams: Record<string, string>,
            count?: number,
            block?: number,
        ): Promise<Record<string, StreamEntry[]>>;
        xrevrange(
            key: string,
            end: string,
            start: string,
            count?: number,
        ): Promise<StreamEntry[]>;
        xtrim(
            key: string,
            strategy: "maxlen" | "minid",
            threshold: string | number,
        ): Promise<number>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • key: string
      • id: string
      • fields: Record<string, any>

      Returns Promise<string>

    • Parameters

      • key: string
      • ids: string[]

      Returns Promise<number>

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • key: string
      • start: string
      • end: string
      • Optionalcount: number

      Returns Promise<StreamEntry[]>

    • Parameters

      • streams: Record<string, string>
      • Optionalcount: number
      • Optionalblock: number

      Returns Promise<Record<string, StreamEntry[]>>

    • Parameters

      • key: string
      • end: string
      • start: string
      • Optionalcount: number

      Returns Promise<StreamEntry[]>

    • Parameters

      • key: string
      • strategy: "maxlen" | "minid"
      • threshold: string | number

      Returns Promise<number>