Class KinesisStore

constructor

• new KinesisStore(options?: KinesisStoreOptions): KinesisStore

  Parameters

  • options: KinesisStoreOptions = {}

  Returns KinesisStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): KinesisClientLike

  Returns the underlying KinesisClient (loosely typed) for anything not wrapped here.

  Returns KinesisClientLike

publish

• publish(
      stream: string,
      message: KinesisMessage,
      options?: PutRecordOptions,
  ): Promise<PutRecordResult>

  PutRecord — publish one message to stream. The message is encoded to bytes (string → UTF-8, Buffer → as-is, else JSON). Returns the shard id and sequence number assigned by Kinesis.

  Parameters

  • stream: string
  • message: KinesisMessage
  • options: PutRecordOptions = {}

  Returns Promise<PutRecordResult>

createStream

• createStream(name: string, options?: CreateStreamOptions): Promise<void>

  CreateStream — provision a new stream.

  Parameters

  • name: string
  • options: CreateStreamOptions = {}

  Returns Promise<void>

createTopic

• createTopic(name: string, options?: CreateStreamOptions): Promise<void>

  Alias for createStream(), matching the common store surface.

  Parameters

  • name: string
  • options: CreateStreamOptions = {}

  Returns Promise<void>

subscribe

• subscribe(
      stream: string,
      handler: (record: any) => void | Promise<void>,
      options?: KinesisSubscribeOptions,
  ): Promise<KinesisSubscription>

  Subscribe to stream: acquire a shard iterator (GetShardIterator) and poll GetRecords in a loop, invoking handler once per record. Returns a subscription whose stop() ends the loop; the subscription is also tracked so disconnect() stops it. The poll loop runs detached (not awaited); this method resolves once the initial iterator is acquired.

  Parameters

  • stream: string
  • handler: (record: any) => void | Promise<void>
  • options: KinesisSubscribeOptions = {}

  Returns Promise<KinesisSubscription>