Class: ApiResponse<Request>

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:11

Since

1.0.0

Extends

• ServerResponse<Request>

Type Parameters

Type Parameter	Default type
Request extends IncomingMessage	IncomingMessage

Constructors

Constructor

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

Defined in: node_modules/@types/node/http.d.ts:802

Parameters

Parameter	Type
req	Request

Returns

ApiResponse<Request>

Inherited from

ServerResponse<Request>.constructor

Properties

cookies

cookies: CookieStore

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:15

Since

1.0.0

Methods

badRequest()

badRequest(data?: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:44

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

---

conflict()

conflict(data?: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:79

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

---

created()

created(data: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:28

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

---

error()

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

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:86

Parameters

Parameter	Type
error	string | number
data?	unknown

Returns

void

Since

1.0.0

---

forbidden()

forbidden(data?: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:58

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

---

html()

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

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:143

Parameters

Parameter	Type
code	number
data	string

Returns

void

Since

5.1.0

---

image()

image(type: "image/svg+xml" | "image/avif" | "image/bmp" | "image/gif" | "image/jpeg" | "image/png" | "image/tiff" | "image/webp" | "image/aces" | "image/apng" | "image/avci" | "image/avcs" | "image/cgm" | "image/dicom-rle" | "image/dpx" | "image/emf" | "image/example" | "image/fits" | "image/g3fax" | "image/heic" | "image/heic-sequence" | "image/heif" | "image/heif-sequence" | "image/hej2k" | "image/hsj2" | "image/ief" | "image/j2c" | "image/jaii" | "image/jais" | "image/jls" | "image/jp2" | "image/jph" | "image/jphc" | "image/jpm" | "image/jpx" | "image/jxl" | "image/jxr" | "image/jxrA" | "image/jxrS" | "image/jxs" | "image/jxsc" | "image/jxsi" | "image/jxss" | "image/ktx" | "image/ktx2" | "image/naplps" | "image/prs.btif" | "image/prs.pti" | "image/pwg-raster" | "image/t38" | "image/tiff-fx" | "image/vnd.adobe.photoshop" | "image/vnd.airzip.accelerator.azv" | "image/vnd.blockfact.facti" | "image/vnd.clip" | "image/vnd.cns.inf2" | "image/vnd.dece.graphic" | "image/vnd.djvu" | "image/vnd.dwg" | "image/vnd.dxf" | "image/vnd.dvb.subtitle" | "image/vnd.fastbidsheet" | "image/vnd.fpx" | "image/vnd.fst" | "image/vnd.fujixerox.edmics-mmr" | "image/vnd.fujixerox.edmics-rlc" | "image/vnd.globalgraphics.pgb" | "image/vnd.microsoft.icon" | "image/vnd.mix" | "image/vnd.ms-modi" | "image/vnd.mozilla.apng" | "image/vnd.net-fpx" | "image/vnd.pco.b16" | "image/vnd.radiance" | "image/vnd.sealed.png" | "image/vnd.sealedmedia.softseal.gif" | "image/vnd.sealedmedia.softseal.jpg" | "image/vnd.svf" | "image/vnd.tencent.tap" | "image/vnd.valve.source.texture" | "image/vnd.wap.wbmp" | "image/vnd.xiff" | "image/vnd.zbrush.pcx" | "image/wmf", data: string | Uint8Array | Readable | Buffer): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:131

Parameters

Parameter	Type	Description
type	"image/svg+xml" | "image/avif" | "image/bmp" | "image/gif" | "image/jpeg" | "image/png" | "image/tiff" | "image/webp" | "image/aces" | "image/apng" | "image/avci" | "image/avcs" | "image/cgm" | "image/dicom-rle" | "image/dpx" | "image/emf" | "image/example" | "image/fits" | "image/g3fax" | "image/heic" | "image/heic-sequence" | "image/heif" | "image/heif-sequence" | "image/hej2k" | "image/hsj2" | "image/ief" | "image/j2c" | "image/jaii" | "image/jais" | "image/jls" | "image/jp2" | "image/jph" | "image/jphc" | "image/jpm" | "image/jpx" | "image/jxl" | "image/jxr" | "image/jxrA" | "image/jxrS" | "image/jxs" | "image/jxsc" | "image/jxsi" | "image/jxss" | "image/ktx" | "image/ktx2" | "image/naplps" | "image/prs.btif" | "image/prs.pti" | "image/pwg-raster" | "image/t38" | "image/tiff-fx" | "image/vnd.adobe.photoshop" | "image/vnd.airzip.accelerator.azv" | "image/vnd.blockfact.facti" | "image/vnd.clip" | "image/vnd.cns.inf2" | "image/vnd.dece.graphic" | "image/vnd.djvu" | "image/vnd.dwg" | "image/vnd.dxf" | "image/vnd.dvb.subtitle" | "image/vnd.fastbidsheet" | "image/vnd.fpx" | "image/vnd.fst" | "image/vnd.fujixerox.edmics-mmr" | "image/vnd.fujixerox.edmics-rlc" | "image/vnd.globalgraphics.pgb" | "image/vnd.microsoft.icon" | "image/vnd.mix" | "image/vnd.ms-modi" | "image/vnd.mozilla.apng" | "image/vnd.net-fpx" | "image/vnd.pco.b16" | "image/vnd.radiance" | "image/vnd.sealed.png" | "image/vnd.sealedmedia.softseal.gif" | "image/vnd.sealedmedia.softseal.jpg" | "image/vnd.svf" | "image/vnd.tencent.tap" | "image/vnd.valve.source.texture" | "image/vnd.wap.wbmp" | "image/vnd.xiff" | "image/vnd.zbrush.pcx" | "image/wmf"	The MIME type of the image (e.g., 'image/png').
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.

---

json()

json(data: any): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:112

Parameters

Parameter	Type
data	any

Returns

void

Since

1.0.0

---

methodNotAllowed()

methodNotAllowed(data?: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:72

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

7.0.0

---

noContent()

noContent(data: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:36

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

---

notFound()

notFound(data?: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:65

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0

---

ok()

ok(data: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:20

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

---

respond()

respond(data: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:97

Parameters

Parameter	Type
data	unknown

Returns

void

Since

1.0.0

---

setContentType()

setContentType(contentType: MimeType): this

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:150

Parameters

Parameter	Type
contentType	MimeType

Returns

this

Since

1.0.0

---

status()

status(code: number): this

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:104

Parameters

Parameter	Type
code	number

Returns

this

Since

1.0.0

---

text()

text(data: string): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:119

Parameters

Parameter	Type
data	string

Returns

void

Since

1.0.0

---

unauthorized()

unauthorized(data?: unknown): void

Defined in: packages/api/src/lib/structures/api/ApiResponse.ts:51

Parameters

Parameter	Type
data?	unknown

Returns

void

Since

1.0.0