Class: ApiResponse<Request>

Since

1.0.0

Extends

• ServerResponse<Request>

Type Parameters

Type Parameter	Default type
Request extends IncomingMessage	IncomingMessage

Constructors

new ApiResponse()

new ApiResponse<Request>(req: Request): ApiResponse<Request>

Parameters

Parameter	Type
req	Request

Returns

ApiResponse<Request>

Inherited from

ServerResponse<Request>.constructor

Defined in

node_modules/@types/node/http.d.ts:740

Properties

cookies

cookies: CookieStore

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:15

Methods

badRequest()

badRequest(data?: unknown): void

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:44

---

conflict()

conflict(data?: unknown): void

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:79

---

created()

created(data: unknown): void

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:28

---

error()

error(error: string | number, data?: unknown): void

Parameters

Parameter	Type
error	string | number
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:86

---

forbidden()

forbidden(data?: unknown): void

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:58

---

html()

html(code: number, data: string): void

Parameters

Parameter	Type
code	number
data	string

Returns

void

Since

5.1.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:146

---

image()

image(type: ImageGif | ImageJpg | ImagePng | ImageWebp | ImageXIcon, data: string | Uint8Array | Readable | Buffer): void

Parameters

Parameter	Type	Description
type	ImageGif | ImageJpg | ImagePng | ImageWebp | ImageXIcon	The MIME type of the image (e.g., MimeTypes.ImagePng).
data	string | Uint8Array | Readable | Buffer	The image data as a string, Buffer, Uint8Array, or ReadableStream.

Returns

void

Since

6.1.0

Sets the image content type and sends the image data in the response.

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:131

---

json()

json(data: any): void

Parameters

Parameter	Type
data	any

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:112

---

methodNotAllowed()

methodNotAllowed(data?: unknown): void

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

7.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:72

---

noContent()

noContent(data: unknown): void

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:36

---

notFound()

notFound(data?: unknown): void

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:65

---

ok()

ok(data: unknown): void

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:20

---

respond()

respond(data: unknown): void

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:97

---

setContentType()

setContentType(contentType: MimeTypes): this

Parameters

Parameter	Type
contentType	MimeTypes

Returns

this

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:153

---

status()

status(code: number): this

Parameters

Parameter	Type
code	number

Returns

this

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:104

---

text()

text(data: string): void

Parameters

Parameter	Type
data	string

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:119

---

unauthorized()

unauthorized(data?: unknown): void

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:51