Response

Class Response

Hierarchy

Response

↳ ServerErrorResponse

↳ SuccessfulResponse

↳ ClientErrorResponse

↳ InformationalResponse

↳ RedirectionResponse

Index

Constructors

• constructor

Properties

• ctx
• data
• headers
• message
• meta
• statusCode

Methods

• addHeaders
• appendHeader
• apply
• applyHeaders
• getStatusCode
• patchContext
• removeHeader
• setBody
• setHeader
• setHeaders
• setStatusCode

---

Constructors

Protected constructor

new Response(__namedParameters: object): Response

Defined in Library/Response/Response.ts:17

Parameters:

__namedParameters: object

Name	Type
data	any
message	string
meta	any
statusCode	HttpStatusCodes

Returns: Response

---

Properties

Protected ctx

ctx: ContextInterface

Defined in Library/Response/Response.ts:7

---

Protected data

data: any

Defined in Library/Response/Response.ts:15

---

Protected headers

headers: object

Defined in Library/Response/Response.ts:9

Type declaration

[header: string]: string | Array<string>

---

Protected message

message: string

Defined in Library/Response/Response.ts:17

---

Protected meta

meta: any

Defined in Library/Response/Response.ts:13

---

Protected statusCode

statusCode: HttpStatusCodes

Defined in Library/Response/Response.ts:11

---

Methods

addHeaders

addHeaders(headers: object): this

Defined in Library/Response/Response.ts:54

Parameters:

Name	Type
headers	object

Returns: this

---

appendHeader

appendHeader(header: string, value: * string | Array<string>*): void

Defined in Library/Response/Response.ts:66

Parameters:

Name	Type
header	string
value	string | Array<string>

Returns: void

---

Abstract apply

apply(): void

Defined in Library/Response/Response.ts:5

Returns: void

---

applyHeaders

applyHeaders(): this

Defined in Library/Response/Response.ts:76

Returns: this

---

getStatusCode

getStatusCode(): HttpStatusCodes

Defined in Library/Response/Response.ts:38

Returns: HttpStatusCodes

---

patchContext

patchContext(ctx: ContextInterface): void

Defined in Library/Response/Response.ts:26

Parameters:

Name	Type
ctx	ContextInterface

Returns: void

---

removeHeader

removeHeader(header: string): this

Defined in Library/Response/Response.ts:70

Parameters:

Name	Type
header	string

Returns: this

---

setBody

setBody(body: any): this

Defined in Library/Response/Response.ts:42

Parameters:

Name	Type
body	any

Returns: this

---

setHeader

setHeader(header: string, value: * string | Array<string>*): this

Defined in Library/Response/Response.ts:60

Parameters:

Name	Type
header	string
value	string | Array<string>

Returns: this

---

setHeaders

setHeaders(headers: object): this

Defined in Library/Response/Response.ts:48

Parameters:

Name	Type
headers	object

Returns: this

---

setStatusCode

setStatusCode(statusCode: HttpStatusCodes): this

Defined in Library/Response/Response.ts:32

Parameters:

Name	Type
statusCode	HttpStatusCodes

Returns: this

---