CResponse

The CResponse class represents an HTTP response with automatic body serialization, cookie handling, and header management. It provides static helpers for common response patterns like redirects, file streaming, and Server-Sent Events.

Usage
Constructor Parameters
Properties
Static Methods
Body Serialization
Status Enum

Usage

Basic response

import { C } from "@ozanarslan/corpus";

new C.Route("/hello", () => {
	return new C.Response("Hello World");
});

With status and headers

new C.Route("/created", () => {
	return new C.Response(
		{ id: 1 },
		{
			status: C.Status.CREATED,
			headers: { [C.CommonHeaders.Location]: "/items/1" },
		},
	);
});

Setting cookies

The following is the recommended pattern because CResponse init can also receive another CResponse instance and typescript doesn't do a great job differentiating an object with a class.

new C.Route("/login", (c) => {
	c.res.cookies.set({
		name: "session",
		value: "abc123",
		httpOnly: true,
		secure: true,
	});

	return { success: true };
});

Accessing the native response

const cres = new C.Response("data");
cres.response; // Returns native Web API Response

Constructor Parameters

data (optional)

CResponseBody<R>

The response body. Automatically serialized based on type. See Body Serialization.

init (optional)

CResponseInit | CResponse

Response options or another CResponse to copy from.

type CResponseInit = {
	cookies?: CookiesInit;
	headers?: CHeadersInit;
	status?: Status;
	statusText?: string;
};

Properties

Property	Type	Description
body	`BodyInit`	Resolved and serialized body
headers	`CHeaders`	Response headers
status	`Status`	HTTP status code
statusText	`string`	HTTP status text
cookies	`Cookies`	Response cookies
response	`Response`	Getter returning native Web API Response

Static Methods

redirect

static redirect(url: string | URL, init?: CResponseInit): CResponse

Creates a redirect response. Defaults to 302 Found.

return C.Response.redirect("/new-path");
return C.Response.redirect("/new-path", {
	status: C.Status.MOVED_PERMANENTLY,
});

permanentRedirect

static permanentRedirect(url: string | URL, init?: Omit<CResponseInit, "status">): CResponse

301 Moved Permanently redirect.

temporaryRedirect

static temporaryRedirect(url: string | URL, init?: Omit<CResponseInit, "status">): CResponse

307 Temporary Redirect.

seeOther

static seeOther(url: string | URL, init?: Omit<CResponseInit, "status">): CResponse

303 See Other (redirect with GET).

sse

static sse(source: SseSource, init?: Omit<CResponseInit, "status">, retry?: number): CResponse

Server-Sent Events stream.

return C.Response.sse((send) => {
	const interval = setInterval(() => {
		send({ data: { time: Date.now() }, event: "tick" });
	}, 1000);

	return () => clearInterval(interval); // cleanup
});

ndjson

static ndjson(source: NdjsonSource, init?: Omit<CResponseInit, "status">): CResponse

Newline-delimited JSON stream.

return C.Response.ndjson((send) => {
	for (const item of largeDataset) {
		send(item);
	}
});

streamFile

static async streamFile(filePath: string, disposition?: "attachment" | "inline", init?: Omit<CResponseInit, "status">): Promise<CResponse<ReadableStream>>

Stream a file from disk. Uses Content-Type from file extension. Defaults to attachment disposition.

return await C.Response.streamFile("assets/video.mp4", "inline");

Throws CError with 404 if file not found.

file

static async file(filePath: string, init?: CResponseInit): Promise<CResponse<string>>

Read entire file into memory as string. Sets Content-Length header.

return await C.Response.file("assets/doc.txt");