Skip to content

HttpBody

31 exports Added in v1.0.0 Source

Constructors

empty

Added in v1.0.0 Source

Signature

declare const empty: Empty;

file

Added in v1.0.0 Source

Signature

declare const file: (
  path: string,
  options?: FileSystem.StreamOptions & {
    readonly contentType?: string;
  },
) => Effect.Effect<Stream, PlatformError.PlatformError, FileSystem.FileSystem>;

fileInfo

Added in v1.0.0 Source

Signature

declare const fileInfo: (
  path: string,
  info: FileSystem.File.Info,
  options?: FileSystem.StreamOptions & {
    readonly contentType?: string;
  },
) => Effect.Effect<Stream, PlatformError.PlatformError, FileSystem.FileSystem>;

fileWeb

Added in v1.0.0 Source

Signature

declare const fileWeb: (file: HttpBody.FileLike) => Stream;

json

Added in v1.0.0 Source

Signature

declare const json: (
  body: unknown,
  contentType?: string,
) => Effect.Effect<Uint8Array, HttpBodyError>;

jsonSchema

Added in v1.0.0 Source

Signature

declare const jsonSchema: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
) => (body: A, contentType?: string) => Effect.Effect<Uint8Array, HttpBodyError, R>;

raw

Added in v1.0.0 Source

Signature

declare const raw: (
  body: unknown,
  options?: {
    readonly contentLength?: number;
    readonly contentType?: string;
  },
) => Raw;

stream

Added in v1.0.0 Source

Signature

declare const stream: (
  body: Stream_.Stream<globalThis.Uint8Array, unknown>,
  contentType?: string,
  contentLength?: number,
) => Stream;

text

Added in v1.0.0 Source

Signature

declare const text: (body: string, contentType?: string) => Uint8Array;

uint8Array

Added in v1.0.0 Source

Signature

declare const uint8Array: (body: globalThis.Uint8Array, contentType?: string) => Uint8Array;

unsafeJson

Added in v1.0.0 Source

Signature

declare const unsafeJson: (body: unknown, contentType?: string) => Uint8Array;

urlParams

Added in v1.0.0 Source

Signature

declare const urlParams: (urlParams: UrlParams.UrlParams, contentType?: string) => Uint8Array;

Errors

ErrorReason type

Added in v1.0.0 Source

Signature

type ErrorReason =
  | {
      readonly _tag: "JsonError";
      readonly error: unknown;
    }
  | {
      readonly _tag: "SchemaError";
      readonly error: ParseResult.ParseError;
    };

Signature

declare const HttpBodyError: (reason: ErrorReason) => HttpBodyError;

HttpBodyError interface

Added in v1.0.0 Source

Signature

interface HttpBodyError {
  readonly _tag: "HttpBodyError";
  readonly [ErrorTypeId]: typeof ErrorTypeId;
  readonly reason: ErrorReason;
}

FormData

formData

Added in v1.0.0 Source

Signature

declare const formData: (body: globalThis.FormData) => FormData;

FormDataCoercible type

Added in v1.0.0 Source

Signature

type FormDataCoercible = string | number | boolean | File | Blob | null | undefined;

FormDataInput type

Added in v1.0.0 Source

Signature

type FormDataInput = Record<string, FormDataCoercible | ReadonlyArray<FormDataCoercible>>;

Signature

declare const formDataRecord: (entries: FormDataInput) => FormData;

Models

Empty interface

Added in v1.0.0 Source

Signature

interface Empty extends Proto {
  readonly _tag: "Empty";
}

FormData interface

Added in v1.0.0 Source

Signature

interface FormData extends Proto {
  readonly _tag: "FormData";
  readonly formData: FormData;
}

HttpBody type

Added in v1.0.0 Source

Signature

type HttpBody = Empty | Raw | Uint8Array | FormData | Stream;

Raw interface

Added in v1.0.0 Source

Signature

interface Raw extends Proto {
  readonly _tag: "Raw";
  readonly body: unknown;
}

Stream interface

Added in v1.0.0 Source

Signature

interface Stream extends Proto {
  readonly _tag: "Stream";
  readonly contentLength?: number;
  readonly contentType: string;
  readonly stream: Stream<Uint8Array<ArrayBufferLike>, unknown>;
}

Uint8Array interface

Added in v1.0.0 Source

Signature

interface Uint8Array extends Proto {
  readonly _tag: "Uint8Array";
  readonly body: Uint8Array;
  readonly contentLength: number;
  readonly contentType: string;
}

Other

HttpBody

Added in v1.0.0 Source

Refinements

isHttpBody

Added in v1.0.0 Source

Signature

declare function isHttpBody(u: unknown): u is HttpBody;

Type Ids

ErrorTypeId

Added in v1.0.0 Source

Signature

declare const ErrorTypeId: unique symbol;

ErrorTypeId type

Added in v1.0.0 Source

Signature

type ErrorTypeId = typeof ErrorTypeId;

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;