Class HttpResult<T>

The result of a Workers endpoint.

Param: ok

True if status < 400

Param: status

The HTTP Status of a Workers request

Param: headers

All headers that the result is to be sent with or was received with

Param: data

JSON data yielded from a request, undefined if the request was not ok.

Param: message

An error text set if the request was not ok.

Remarks

If status is 204 data will always be undefined.

Type Parameters

T = unknown
The type of data returned on success.

Index

Constructors

Properties

data? headers mediaType? message? ok status

Methods

setMediaType toResponse fail ok

Constructors

constructor

new HttpResult<T = unknown>(
    ok: boolean,
    status: number,
    headers: Headers,
    data?: T,
    message?: string,
    mediaType?: MediaType,
): HttpResult<T>
Type Parameters
- T = unknown
  The type of data returned on success.
Parameters
- ok: boolean
- status: number
- headers: Headers
- Optionaldata: T
- Optionalmessage: string
- OptionalmediaType: MediaType
Returns HttpResult<T>
- Defined in src/ui/backend.ts:61

Properties

`Optional`data

data?: T

headers

headers: Headers

`Optional`mediaType

mediaType?: MediaType

`Optional`message

message?: string

ok

ok: boolean

status

status: number

Methods

setMediaType

setMediaType(mediaType: MediaType): this
Parameters
- mediaType: MediaType
Returns this
- Defined in src/ui/backend.ts:135

toResponse

toResponse(): Response
Returns Response
- Defined in src/ui/backend.ts:80

`Static`fail

fail(status: number, message?: string, init?: HeadersInit): HttpResult<never>
Parameters
- status: number
- Optionalmessage: string
- Optionalinit: HeadersInit
Returns HttpResult<never>
- Defined in src/ui/backend.ts:75

`Static`ok

ok<T>(status: number, data?: T, init?: HeadersInit): HttpResult<T>
Type Parameters
- T
Parameters
- status: number
- Optionaldata: T
- Optionalinit: HeadersInit
Returns HttpResult<T>
- Defined in src/ui/backend.ts:70