Skip to main content

Class: HttpResultsStatic

A static class for creating HTTP results.

Constructors​

Constructor​

new HttpResultsStatic(): HttpResultsStatic

Returns​

HttpResultsStatic

Methods​

Accepted()​

Accepted(value): BodyHttpResult<unknown>

Parameters​

value​

unknown

Returns​

BodyHttpResult<unknown>

BadRequest()​

BadRequest(value, options?): ErrorHttpResult

Parameters​

value​

string

options?​
cause?​

unknown

description?​

string

Returns​

ErrorHttpResult

Created()​

Created(value, location?): BodyHttpResult<unknown>

Parameters​

value​

unknown

location?​

string

Returns​

BodyHttpResult<unknown>

Download()​

Download(filePath, filename, contentType?): FileHttpResult

Parameters​

filePath​

string

filename​

string

contentType?​

string

Returns​

FileHttpResult

Error()​

Error(error): ErrorHttpResult

Parameters​

error​

HttpError

Returns​

ErrorHttpResult

File()​

File(filePath, contentType?): FileHttpResult

Parameters​

filePath​

string

contentType?​

string

Returns​

FileHttpResult

Forbidden()​

Forbidden(value, options?): ErrorHttpResult

Parameters​

value​

string

options?​
cause?​

unknown

description?​

string

Returns​

ErrorHttpResult

InternalServerError()​

InternalServerError(value, options?): ErrorHttpResult

Parameters​

value​

string

options?​
cause?​

unknown

description?​

string

Returns​

ErrorHttpResult

NoContent()​

NoContent(): BodyHttpResult<undefined>

Returns​

BodyHttpResult<undefined>

NotFound()​

NotFound(value, options?): ErrorHttpResult

Parameters​

value​

string

options?​
cause?​

unknown

description?​

string

Returns​

ErrorHttpResult

Ok()​

Ok(value): BodyHttpResult<unknown>

Parameters​

value​

unknown

Returns​

BodyHttpResult<unknown>

PermanentRedirect()​

PermanentRedirect(location): RedirectHttpResult

Parameters​

location​

string

Returns​

RedirectHttpResult

Redirect()​

Redirect(location): RedirectHttpResult

Parameters​

location​

string

Returns​

RedirectHttpResult

Stream()​

Stream(stream, filename?, contentType?): StreamHttpResult

Parameters​

stream​

ReadableStream

filename?​

string

contentType?​

string

Returns​

StreamHttpResult

Unauthorized()​

Unauthorized(value, options?): ErrorHttpResult

Parameters​

value​

string

options?​
cause?​

unknown

description?​

string

Returns​

ErrorHttpResult