HttpBody
Constructors
Signature
declare const empty: Empty;Signature
declare const file: (
path: string,
options?: FileSystem.StreamOptions & {
readonly contentType?: string;
},
) => Effect.Effect<Stream, PlatformError.PlatformError, FileSystem.FileSystem>;Signature
declare const fileInfo: (
path: string,
info: FileSystem.File.Info,
options?: FileSystem.StreamOptions & {
readonly contentType?: string;
},
) => Effect.Effect<Stream, PlatformError.PlatformError, FileSystem.FileSystem>;Signature
declare const fileWeb: (file: HttpBody.FileLike) => Stream;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>;Signature
declare const raw: (
body: unknown,
options?: {
readonly contentLength?: number;
readonly contentType?: string;
},
) => Raw;Signature
declare const stream: (
body: Stream_.Stream<globalThis.Uint8Array, unknown>,
contentType?: string,
contentLength?: number,
) => Stream;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;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;
};HttpBodyError
Added in v1.0.0
Source
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
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>>;formDataRecord
Added in v1.0.0
Source
Signature
declare const formDataRecord: (entries: FormDataInput) => FormData;Models
Signature
interface Empty extends Proto {
readonly _tag: "Empty";
}Signature
interface FormData extends Proto {
readonly _tag: "FormData";
readonly formData: FormData;
}Signature
type HttpBody = Empty | Raw | Uint8Array | FormData | Stream;Signature
interface Raw extends Proto {
readonly _tag: "Raw";
readonly body: unknown;
}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
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;Signature
declare const TypeId: unique symbol;Signature
type TypeId = typeof TypeId;