Class RedisStreamsIO

constructor

• new RedisStreamsIO(options?: RedisStreamsOptions): RedisStreamsIO

  Parameters

  • options: RedisStreamsOptions = {}

  Returns RedisStreamsIO

capabilities

name

destroy

• destroy(): void

  Clean up resources used by the IO adapter

  Returns void

getAllEntries

• getAllEntries(): Promise<[string, string[]][]>

  Get all entries in the stream (for debugging purposes)

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

getConsumerGroup

• getConsumerGroup(): string

  Get the consumer group name used by this adapter

  Returns string

getConsumerName

• getConsumerName(): string

  Get the consumer name used by this adapter

  Returns string

getSessionId

• getSessionId(): string

  Get the session ID for this adapter

  Returns string

getStream

• getStream(): string

  Get the stream name used by this adapter

  Returns string

getStreamInfo

• getStreamInfo(): Promise<
      { groups: number; lastEntry: null
      | string; length: number },
  >

  Get stream information (length, groups, etc.)

  Returns Promise<{ groups: number; lastEntry: null | string; length: number }>

read

• read(): Promise<null | string>

  Returns Promise<null | string>

signalDestroy

• signalDestroy(): Promise<void>

  Signal that the IO adapter should prepare for destruction

  Returns Promise<void>

trimStream

• trimStream(maxLen: number): Promise<void>

  Trim the stream to keep only the last N entries

  Parameters

  • maxLen: number

  Returns Promise<void>

write

• write(message: string | IoMessage): Promise<void>

  Parameters

  • message: string | IoMessage

  Returns Promise<void>