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

IncomingMessage overview

Added in v1.0.0


Table of contents


fiber refs

maxBodySize

Signature

export declare const maxBodySize: FiberRef.FiberRef<Option.Option<FileSystem.Size>>

Added in v1.0.0

withMaxBodySize

Signature

export declare const withMaxBodySize: ((
  size: Option.Option<FileSystem.SizeInput>
) => <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>) &
  (<R, E, A>(effect: Effect.Effect<R, E, A>, size: Option.Option<FileSystem.SizeInput>) => Effect.Effect<R, E, A>)

Added in v1.0.0

models

IncomingMessage (interface)

Signature

export interface IncomingMessage<E> {
  readonly [TypeId]: TypeId
  readonly headers: Headers.Headers
  readonly remoteAddress: Option.Option<string>
  readonly json: Effect.Effect<never, E, unknown>
  readonly text: Effect.Effect<never, E, string>
  readonly urlParamsBody: Effect.Effect<never, E, UrlParams.UrlParams>
  readonly arrayBuffer: Effect.Effect<never, E, ArrayBuffer>
  readonly stream: Stream.Stream<never, E, Uint8Array>
}

Added in v1.0.0

schema

schemaBodyJson

Signature

export declare const schemaBodyJson: <I, A>(
  schema: Schema.Schema<I, A>
) => <E>(self: IncomingMessage<E>) => Effect.Effect<never, ParseResult.ParseError | E, A>

Added in v1.0.0

schemaBodyUrlParams

Signature

export declare const schemaBodyUrlParams: <I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<I, A>
) => <E>(self: IncomingMessage<E>) => Effect.Effect<never, ParseResult.ParseError | E, A>

Added in v1.0.0

schemaExternalSpan

Signature

export declare const schemaExternalSpan: <E>(
  self: IncomingMessage<E>
) => Effect.Effect<never, ParseResult.ParseError, Tracer.ExternalSpan>

Added in v1.0.0

schemaHeaders

Signature

export declare const schemaHeaders: <I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<I, A>
) => <E>(self: IncomingMessage<E>) => Effect.Effect<never, ParseResult.ParseError, A>

Added in v1.0.0

type ids

TypeId

Signature

export declare const TypeId: typeof TypeId

Added in v1.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Added in v1.0.0