Skip to content

HttpIncomingMessage

9 exports Added in v1.0.0 Source

Fiber Refs

MaxBodySize

Added in v1.0.0 Source

Signature

declare class MaxBodySize extends any {
  constructor();
}

Signature

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

Models

HttpIncomingMessage interface

Added in v1.0.0 Source

Signature

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

Other

inspect

Added in v1.0.0 Source

Signature

declare function inspect<E>(self: HttpIncomingMessage<E>, that: object): object;

Schema

Signature

declare function schemaBodyJson<A, I, R>(
  schema: any,
  options?: ParseOptions,
): <E>(self: HttpIncomingMessage<E>) => Effect<A, any, R>;

Signature

declare function schemaBodyUrlParams<A, I extends Readonly<Record<string, string | readonly Array<string> | undefined>>, R>(schema: any, options?: ParseOptions): <E>(self: HttpIncomingMessage<E>) => Effect<A, any, R>

Signature

declare function schemaHeaders<A, I extends Readonly<Record<string, string | undefined>>, R>(
  schema: any,
  options?: ParseOptions,
): <E>(self: HttpIncomingMessage<E>) => Effect<A, ParseError, R>;

Type Ids

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol;

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId;