Skip to main content Link Search Menu Expand Document (external link)

ConsumerRecord overview

Added in v0.1.0


Table of contents


constructors

empty

Signature

export declare const empty: ConsumerRecord

Added in v0.6.0

make

Signature

export declare const make: (payload: internal.ConsumerRecordConstructorProps) => 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 extends internal.ConsumerRecordConstructorProps {
  readonly [TypeId]: TypeId
}

Added in v0.1.0

schema

schemaHeaders

Signature

export declare const schemaHeaders: <A, I extends Readonly<Record<string, string | undefined>>, R>(
  schema: Schema.Schema<A, I, R>,
  options?: SchemaAST.ParseOptions | undefined
) => Effect.Effect<A, ParseResult.ParseError, ConsumerRecord | R>

Added in v0.9.0

schemaValueJson

Signature

export declare const schemaValueJson: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
  options?: SchemaAST.ParseOptions | undefined
) => Effect.Effect<A, ParseResult.ParseError, ConsumerRecord | R>

Added in v0.9.0

schemaValueRaw

Signature

export declare const schemaValueRaw: <A, R>(
  schema: Schema.Schema<A, Uint8Array, R>,
  options?: SchemaAST.ParseOptions | undefined
) => Effect.Effect<A, ParseResult.ParseError, ConsumerRecord | R>

Added in v0.9.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 {
  [key: string]: Buffer | string | (Buffer | string)[] | undefined
}

Added in v0.2.0