ConsumerRecord overview
Added in v0.1.0
Table of contents
constructors
make
Signature
export declare const make: (payload: {
readonly topic: string
readonly partition: number
readonly highWatermark: string
readonly key: Buffer | null
readonly value: Buffer | null
readonly timestamp: string
readonly attributes: number
readonly offset: string
readonly headers?: ConsumerRecord.Headers
readonly size?: number
readonly heartbeat: () => Effect.Effect<void>
readonly commit: () => Effect.Effect<void>
}) => ConsumerRecord
Added in v0.1.0
context
ConsumerRecord
Signature
export declare const ConsumerRecord: Context.Tag<ConsumerRecord, ConsumerRecord>
Added in v0.1.0
models
ConsumerRecord (interface)
Signature
export interface ConsumerRecord {
readonly [TypeId]: TypeId
readonly topic: string
readonly partition: number
readonly highWatermark: string
readonly key: Buffer | null
readonly value: Buffer | null
readonly timestamp: string
readonly attributes: number
readonly offset: string
readonly headers?: ConsumerRecord.Headers
readonly size?: number
// readonly resolveOffset: (offset: string) => void;
readonly heartbeat: () => Effect.Effect<void>
// readonly pause: () => () => void;
readonly commit: () => Effect.Effect<void>
}
Added in v0.1.0
type ids
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v0.1.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v0.1.0
utils
ConsumerRecord (namespace)
Added in v0.2.0
Headers (interface)
Signature
export interface Headers extends KafkaJS.IHeaders {}
Added in v0.2.0