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<Brand.Branded<bigint, "Size">>>

Added in v1.0.0

withMaxBodySize

Signature

export declare const withMaxBodySize: any

Added in v1.0.0

models

IncomingMessage (interface)

Signature

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

Added in v1.0.0

schema

schemaBodyJson

Signature

export declare const schemaBodyJson: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => <E>(self: IncomingMessage<E>) => Effect.Effect<A, any, R>

Added in v1.0.0

schemaBodyJsonScoped

Signature

export declare const schemaBodyJsonScoped: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => <E, E2, R2>(
  effect: Effect.Effect<IncomingMessage<E>, E2, R2>
) => Effect.Effect<A, any, Exclude<R, Scope.Scope> | Exclude<R2, Scope.Scope>>

Added in v1.0.0

schemaBodyUrlParams

Signature

export declare const schemaBodyUrlParams: <R, I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => <E>(self: IncomingMessage<E>) => Effect.Effect<A, any, R>

Added in v1.0.0

schemaBodyUrlParamsScoped

Signature

export declare const schemaBodyUrlParamsScoped: <R, I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => <E, E2, R2>(
  effect: Effect.Effect<IncomingMessage<E>, E2, R2>
) => Effect.Effect<A, any, Exclude<R, Scope.Scope> | Exclude<R2, Scope.Scope>>

Added in v1.0.0

schemaHeaders

Signature

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

Added in v1.0.0

schemaHeadersScoped

Signature

export declare const schemaHeadersScoped: <R, I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => <E, E2, R2>(
  effect: Effect.Effect<IncomingMessage<E>, E2, R2>
) => Effect.Effect<A, any, Exclude<R, Scope.Scope> | Exclude<R2, Scope.Scope>>

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

utils

inspect

Signature

export declare const inspect: <E>(self: IncomingMessage<E>, that: object) => object

Added in v1.0.0