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

ServerRequest overview

Added in v1.0.0


Table of contents


accessors

persistedMultipart

Signature

export declare const persistedMultipart: Effect.Effect<unknown, Multipart.MultipartError, any>

Added in v1.0.0

upgrade

Signature

export declare const upgrade: Effect.Effect<Socket.Socket, Error.RequestError, ServerRequest>

Added in v1.0.0

upgradeChannel

Signature

export declare const upgradeChannel: <IE = never>() => Channel<
  Chunk<Uint8Array>,
  Chunk<string | Uint8Array | Socket.CloseEvent>,
  Socket.SocketError | Error.RequestError | IE,
  IE,
  void,
  unknown,
  ServerRequest
>

Added in v1.0.0

context

ServerRequest

Signature

export declare const ServerRequest: Context.Tag<ServerRequest, ServerRequest>

Added in v1.0.0

conversions

fromWeb

Signature

export declare const fromWeb: (request: Request) => ServerRequest

Added in v1.0.0

fiber refs

maxBodySize

Signature

export declare const maxBodySize: FiberRef.FiberRef<Option.Option<Brand.Branded<bigint, "Size">>>

Added in v1.0.0

models

ServerRequest (interface)

Signature

export interface ServerRequest extends IncomingMessage.IncomingMessage<Error.RequestError> {
  readonly [TypeId]: TypeId
  readonly source: unknown
  readonly url: string
  readonly originalUrl: string
  readonly method: Method
  readonly cookies: ReadonlyRecord<string, string>

  readonly multipart: Effect.Effect<
    Multipart.Persisted,
    Multipart.MultipartError,
    Scope.Scope | FileSystem.FileSystem | Path.Path
  >
  readonly multipartStream: Stream.Stream<Multipart.Part, Multipart.MultipartError>

  readonly upgrade: Effect.Effect<Socket.Socket, Error.RequestError>

  readonly modify: (options: {
    readonly url?: string
    readonly headers?: Headers.Headers
    readonly remoteAddress?: string
  }) => ServerRequest
}

Added in v1.0.0

schema

schemaBodyForm

Signature

export declare const schemaBodyForm: <R, I extends Partial<Multipart.Persisted>, A>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => Effect.Effect<A, any, any>

Added in v1.0.0

schemaBodyFormJson

Signature

export declare const schemaBodyFormJson: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => (field: string) => Effect.Effect<A, any, any>

Added in v1.0.0

schemaBodyJson

Signature

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

Added in v1.0.0

schemaBodyMultipart

Signature

export declare const schemaBodyMultipart: <R, I extends Partial<Multipart.Persisted>, A>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => Effect.Effect<A, any, any>

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
) => Effect.Effect<A, any, ServerRequest | R>

Added in v1.0.0

schemaCookies

Signature

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

Added in v1.0.0

schemaHeaders

Signature

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

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