alepha/server/multipart.d.ts

Alepha is a convention-driven TypeScript framework for building robust, end-to-end type-safe applications, from serverless APIs to full-stack React apps.

import * as _alepha_core0 from "alepha";
import { Alepha, FileLike, HookDescriptor } from "alepha";
import { ServerRoute } from "alepha/server";
import { IncomingMessage } from "node:http";
import { BusboyConfig } from "@fastify/busboy";

//#region src/providers/ServerMultipartProvider.d.ts
declare class ServerMultipartProvider {
  protected readonly alepha: Alepha;
  readonly onRequest: HookDescriptor<"server:onRequest">;
  readonly onSend: HookDescriptor<"server:onResponse">;
  handleMultipartBodyFromNode(route: ServerRoute, stream: IncomingMessage): Promise<{
    body: Record<string, unknown>;
    cleanup: () => Promise<void>;
  }>;
  parseMultipart(req: IncomingMessage, config?: Omit<BusboyConfig, "headers">): Promise<MultipartResult>;
}
interface MultipartResult {
  fields: Record<string, string | string[]>;
  files: Record<string, HybridFile>;
}
interface HybridFile extends FileLike {
  cleanup(): Promise<void>;
  _state: {
    cleanup: boolean;
    size: number;
    tmpPath: string;
  };
}
//#endregion
//#region src/index.d.ts
/**
 * This module provides support for handling multipart/form-data requests.
 * It allows to parse body data containing t.file().
 *
 * @see {@link ServerMultipartProvider}
 * @module alepha.server.multipart
 */
declare const AlephaServerMultipart: _alepha_core0.Service<_alepha_core0.Module<{}>>;
//#endregion
export { AlephaServerMultipart, ServerMultipartProvider };
//# sourceMappingURL=index.d.ts.map