HttpResponse

Response wrapper returned by route handlers, adding one Bun-specific factory to the shared response class.

The addition is file(), which serves a path through Bun.file().

TIP

Every factory on HttpBaseResponse, including json(), html(), text(), image(), custom(), redirect(), and the named status helpers, is available here unchanged. That page is the reference for them; only the addition is documented below.

Importing

import { HttpResponse } from '@almighty-shogun/bun-server';

Usage

import { HttpResponse, HttpStatus } from '@almighty-shogun/bun-server';

const report = HttpResponse.file('./storage/report.pdf');
const download = HttpResponse.file('./storage/export.csv', {
    contentType: 'text/csv; charset=utf-8'
});
const partial = HttpResponse.file('./storage/report.pdf', {
    status: HttpStatus.PartialContent
});

const native = report.unwrap();

A string body is a path, and an existing Blob is used as-is. When no contentType is given, the content type comes from the file itself, which is how Bun.file() infers text/csv from a .csv extension.

import { defineRoute } from '@almighty-shogun/bun-server';

const route = defineRoute('/report', 'GET', (_, response) => {
    return response.file(Bun.file('./storage/report.pdf'));
});

Parameters

body?: NullableOrUndefinable<string | Blob>
File path resolved through Bun.file(), or an existing Blob.
Default: null

options?: NullableOrUndefinable<BaseOptions>
Response status, headers, and content type.
Default: null

Returns

An HttpResponse wrapper that can be returned by route handlers and unwrapped into a native Response.

Uses

Type signature

import {
    HttpBaseResponse,
    type CoreOptions
} from '@almighty-shogun/http-core';

declare class HttpResponse extends HttpBaseResponse {
    static file(
        body?: NullableOrUndefinable<string | Blob>,
        options?: NullableOrUndefinable<BaseOptions>
    ): HttpBaseResponse;
}

type BaseOptions = CoreOptions & {
    contentType?: Undefinable<string>;
};

HttpResponse ​

Importing ​

Usage ​