Class StatusCodeResult<TStatus>

Responds with a bare HTTP status code and no body. Created by ActionResult.status().

Type Parameters

TStatus extends number = number

Hierarchy (View Summary)

ActionResult
- StatusCodeResult

Index

Constructors

constructor

new StatusCodeResult<TStatus extends number = number>(
status: number | TStatus,
headers?: Record<string, string>,
): StatusCodeResult<TStatus>
Type Parameters
- TStatus extends number = number
Parameters
- status: number | TStatus
- Optionalheaders: Record<string, string>
Returns StatusCodeResult<TStatus>
Overrides ActionResult.constructor
- Defined in libs/server/src/ActionResult.ts:347

Properties

`Readonly`headers

headers: Record<string, string>

`Readonly`status

status: TStatus

Methods

executeAsync

executeAsync(
    _req: IncomingMessage,
    res: ServerResponse,
    _contentNegotiator: ContentNegotiator,
): Promise<void>
Parameters
- _req: IncomingMessage
- res: ServerResponse
- _contentNegotiator: ContentNegotiator
Returns Promise<void>
Overrides ActionResult.executeAsync
- Defined in libs/server/src/ActionResult.ts:353

`Static`accepted

accepted<T>(body: T, headers?: Record<string, string>): JsonResult<202, T>
202 Accepted — serializes value using content negotiation.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<202, T>
Inherited from ActionResult.accepted
- Defined in libs/server/src/ActionResult.ts:59

`Static`badRequest

badRequest<T>(body: T, headers?: Record<string, string>): JsonResult<400, T>
400 Bad Request — serializes value as JSON.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<400, T>
Inherited from ActionResult.badRequest
- Defined in libs/server/src/ActionResult.ts:72

`Static`conflict

conflict<T>(body: T, headers?: Record<string, string>): JsonResult<409, T>
409 Conflict — serializes value as JSON.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<409, T>
Inherited from ActionResult.conflict
- Defined in libs/server/src/ActionResult.ts:104

`Static`content

content(body: string, contentType: string, status?: number): ContentResult
Arbitrary string body with an explicit content type.
Parameters
- body: string
- contentType: string
- status: number = 200
Returns ContentResult
Inherited from ActionResult.content
- Defined in libs/server/src/ActionResult.ts:145

`Static`created

created<T>(
    body: T,
    location?: string,
    headers?: Record<string, string>,
): JsonResult<201, T>
201 Created — serializes value using content negotiation.
Type Parameters
- T
Parameters
- body: T
- Optionallocation: string
- Optionalheaders: Record<string, string>
Returns JsonResult<201, T>
Inherited from ActionResult.created
- Defined in libs/server/src/ActionResult.ts:48

`Static`file

file(
    content: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>,
    fileName: string,
    contentType?: string,
): FileResult
Send a file buffer as a download attachment.
Parameters
- content: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
- fileName: string
- contentType: string = 'application/octet-stream'
Returns FileResult
Inherited from ActionResult.file
- Defined in libs/server/src/ActionResult.ts:136

`Static`forbidden

forbidden<T>(body: T, headers?: Record<string, string>): JsonResult<403, T>
403 Forbidden — serializes value as JSON.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<403, T>
Inherited from ActionResult.forbidden
- Defined in libs/server/src/ActionResult.ts:88

`Static`json

json<T>(body: T): JsonResult<200, T>
Explicit JSON response with a specific status code. Use the named factories (ok, notFound, etc.) for common codes. This overload is an escape hatch for uncommon status codes.
Type Parameters
- T
Parameters
- body: T
Returns JsonResult<200, T>
Inherited from ActionResult.json
- Defined in libs/server/src/ActionResult.ts:121
json<S extends number, T>(
    body: T,
    status: S,
    headers?: Record<string, string>,
): JsonResult<S, T>
Explicit JSON response with a specific status code. Use the named factories (ok, notFound, etc.) for common codes. This overload is an escape hatch for uncommon status codes.
Type Parameters
- S extends number
- T
Parameters
- body: T
- status: S
- Optionalheaders: Record<string, string>
Returns JsonResult<S, T>
Inherited from ActionResult.json
- Defined in libs/server/src/ActionResult.ts:122

`Static`noContent

noContent(): NoContentResult
204 No Content.

Returns NoContentResult
Inherited from ActionResult.noContent
- Defined in libs/server/src/ActionResult.ts:67

`Static`notFound

notFound<T>(body: T, headers?: Record<string, string>): JsonResult<404, T>
404 Not Found — serializes value as JSON.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<404, T>
Inherited from ActionResult.notFound
- Defined in libs/server/src/ActionResult.ts:96

`Static`ok

ok<T>(body: T, headers?: Record<string, string>): JsonResult<200, T>
200 OK — serializes value using content negotiation.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<200, T>
Inherited from ActionResult.ok
- Defined in libs/server/src/ActionResult.ts:40

`Static`redirect

redirect(url: string, permanent?: boolean): RedirectResult
Temporary (302) or permanent (301) redirect.
Parameters
- url: string
- permanent: boolean = false
Returns RedirectResult
Inherited from ActionResult.redirect
- Defined in libs/server/src/ActionResult.ts:112

`Static`status

status<S extends number>(
status: S,
headers?: Record<string, string>,
): StatusCodeResult<S>
Bare status code with no body.
Type Parameters
- S extends number
Parameters
- status: S
- Optionalheaders: Record<string, string>
Returns StatusCodeResult<S>
Inherited from ActionResult.status
- Defined in libs/server/src/ActionResult.ts:163

`Static`stream

stream(readable: Readable, contentType: string, fileName?: string): StreamResult
Pipe a Readable stream to the response.
Parameters
- readable: Readable
- contentType: string
- OptionalfileName: string
Returns StreamResult
Inherited from ActionResult.stream
- Defined in libs/server/src/ActionResult.ts:154

`Static`unauthorized

unauthorized<T>(body: T, headers?: Record<string, string>): JsonResult<401, T>
401 Unauthorized — serializes value as JSON.
Type Parameters
- T
Parameters
- body: T
- Optionalheaders: Record<string, string>
Returns JsonResult<401, T>
Inherited from ActionResult.unauthorized
- Defined in libs/server/src/ActionResult.ts:80

Class StatusCodeResult<TStatus>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StatusCodeResult<TStatus>

Properties

Readonlyheaders

Readonlystatus

Methods

executeAsync

Parameters

Returns Promise<void>

Staticaccepted

Type Parameters

Parameters

Returns JsonResult<202, T>

StaticbadRequest

Type Parameters

Parameters

Returns JsonResult<400, T>

Staticconflict

Type Parameters

Parameters

Returns JsonResult<409, T>

Staticcontent

Parameters

Returns ContentResult

Staticcreated

Type Parameters

Parameters

Returns JsonResult<201, T>

Staticfile

Parameters

Returns FileResult

Staticforbidden

Type Parameters

Parameters

Returns JsonResult<403, T>

Staticjson

Type Parameters

Parameters

Returns JsonResult<200, T>

Type Parameters

Parameters

Returns JsonResult<S, T>

StaticnoContent

Returns NoContentResult

StaticnotFound

Type Parameters

Parameters

Returns JsonResult<404, T>

Staticok

Type Parameters

Parameters

Returns JsonResult<200, T>

Staticredirect

Parameters

Returns RedirectResult

Staticstatus

Type Parameters

Parameters

Returns StatusCodeResult<S>

Staticstream

Parameters

Returns StreamResult

Staticunauthorized

Type Parameters

Parameters

Returns JsonResult<401, T>

Settings

On This Page

`Readonly`headers

`Readonly`status

`Static`accepted

`Static`badRequest

`Static`conflict

`Static`content

`Static`created

`Static`file

`Static`forbidden

`Static`json

`Static`noContent

`Static`notFound

`Static`ok

`Static`redirect

`Static`status

`Static`stream

`Static`unauthorized