Skip to content

@banana-universe/bananajs


@banana-universe/bananajs / ForbiddenResponse

Class: ForbiddenResponse

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:113

Extends

Constructors

Constructor

new ForbiddenResponse(message?): ForbiddenResponse

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:120

Constructs a new instance of ForbiddenResponse.

Parameters

message?

string = 'Forbidden'

A descriptive message accompanying the response. Defaults to 'Forbidden'.

Returns

ForbiddenResponse

Overrides

ApiResponse.constructor

Properties

message

protected message: string

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:35

A message providing additional information about the response.

Inherited from

ApiResponse.message


status

protected status: ResponseStatus

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:34

The HTTP response status associated with this response.

Inherited from

ApiResponse.status


statusCode

protected statusCode: StatusCode

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:33

The status code indicating the success or failure of the operation.

Inherited from

ApiResponse.statusCode

Methods

prepare()

protected prepare<T>(res, response, headers): Response

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:38

Type Parameters

T

T extends ApiResponse

Parameters

res

Response

response

T

headers

Returns

Response

Inherited from

ApiResponse.prepare


send()

send(res, headers?): Response

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:47

Parameters

res

Response

headers?

Returns

Response

Inherited from

ApiResponse.send

Released under the MIT License.