Class Writer<T>

Type parameters

T

The type of the data to be written.

Hierarchy

Writer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Writer(uri: string, stream: string): Writer
new Writer(uri: string, stream: string, opts: WriterOptions): Writer
new Writer(client: Redis, stream: string): Writer
new Writer(client: Redis, stream: string, opts: WriterOptions): Writer

- Defined in Writer.ts:25
Creates a new Writer.

Parameters
- uri: string
  
  The uri of the redis server.
- stream: string
  
  The name of the stream to write to.
Returns Writer
- Defined in Writer.ts:33
Creates a new Writer.

Parameters
- uri: string
  
  The uri of the redis server.
- stream: string
  
  The name of the stream to write to.
- opts: WriterOptions
  
  The options for the writer.
Returns Writer
- Defined in Writer.ts:42
Creates a new Writer.

Parameters
- client: Redis
  
  An IORedis client instance.
- stream: string
  
  The name of the stream to write to.
Returns Writer
- Defined in Writer.ts:50
Creates a new Writer.

Parameters
- client: Redis
  
  An IORedis client instance.
- stream: string
  
  The name of the stream to write to.
- opts: WriterOptions
  
  The options for the writer.
Returns Writer

Properties

Private client

client: Redis

Private maxLength

maxLength: number

Private stream

stream: string

The name of the stream to write to.

Methods

disconnect

disconnect(): void

- Defined in Writer.ts:91
Disconnects from redis.

Returns void

on

on(eventName: string, callback: listener): void

- Defined in Writer.ts:84
Attaches an event handler to the wrapped redis client.

Parameters
- eventName: string
  
  The name of the event to attach a handler to.
- callback: listener
  
  The handler for the event.
Returns void

write

write(data: T): Promise<string>

- Defined in Writer.ts:72
Writes a serializable value to the stream.

Parameters
- data: T
  
  The data to write to the stream.
Returns Promise<string>

The id for the written data.

Generated using TypeDoc