@morojs/moro / MoroResponseMethods

Interface: MoroResponseMethods

Defined in: src/types/http.ts:38

Methods

appendHeader()

appendHeader(name, value): HttpResponse

Defined in: src/types/http.ts:51

Parameters

name

string

value

string | string[]

Returns

HttpResponse

badRequest()

badRequest(message?): void

Defined in: src/types/http.ts:65

Parameters

message?

string

Returns

void

canSetHeaders()

canSetHeaders(): boolean

Defined in: src/types/http.ts:54

Returns

boolean

clearCookie()

clearCookie(name, options?): HttpResponse

Defined in: src/types/http.ts:43

Parameters

name

string

options?

CookieOptions

Returns

HttpResponse

conflict()

conflict(message): void

Defined in: src/types/http.ts:66

Parameters

message

string

Returns

void

cookie()

cookie(name, value, options?): HttpResponse

Defined in: src/types/http.ts:42

Parameters

name

string

value

string

options?

CookieOptions

Returns

HttpResponse

created()

created<T>(data, location?): void

Defined in: src/types/http.ts:72

Type Parameters

T

T = any

Parameters

data

T

location?

string

Returns

void

error()

error(error, code?, message?): void

Defined in: src/types/http.ts:59

Parameters

error

string

code?

string

message?

string

Returns

void

forbidden()

forbidden(message?): void

Defined in: src/types/http.ts:63

Parameters

message?

string

Returns

void

getResponseState()

getResponseState(): ResponseState

Defined in: src/types/http.ts:55

Returns

ResponseState

hasHeader()

hasHeader(name): boolean

Defined in: src/types/http.ts:49

Parameters

name

string

Returns

boolean

internalError()

internalError(message?): void

Defined in: src/types/http.ts:67

Parameters

message?

string

Returns

void

json()

json(data): void

Defined in: src/types/http.ts:39

Parameters

data

any

Returns

void

noContent()

noContent(): void

Defined in: src/types/http.ts:73

Returns

void

notFound()

notFound(resource?): void

Defined in: src/types/http.ts:64

Parameters

resource?

string

Returns

void

paginated()

paginated<T>(data, pagination): void

Defined in: src/types/http.ts:74

Type Parameters

T

T = any

Parameters

data

T[]

pagination

limit

number

page

number

total

number

Returns

void

rateLimited()

rateLimited(retryAfter?): void

Defined in: src/types/http.ts:69

Parameters

retryAfter?

number

Returns

void

redirect()

redirect(url, status?): void

Defined in: src/types/http.ts:44

Parameters

url

string

status?

number

Returns

void

render()?

optional render(template, data?): Promise<void>

Defined in: src/types/http.ts:46

Parameters

template

string

data?

any

Returns

Promise<void>

send()

send(data): void

Defined in: src/types/http.ts:41

Parameters

data

string | Buffer<ArrayBufferLike>

Returns

void

sendFile()

sendFile(filePath): Promise<void>

Defined in: src/types/http.ts:45

Parameters

filePath

string

Returns

Promise<void>

setBulkHeaders()

setBulkHeaders(headers): HttpResponse

Defined in: src/types/http.ts:50

Parameters

headers

Record<string, string | number>

Returns

HttpResponse

status()

status(code): HttpResponse

Defined in: src/types/http.ts:40

Parameters

code

number

Returns

HttpResponse

success()

success<T>(data, message?): void

Defined in: src/types/http.ts:58

Type Parameters

T

T = any

Parameters

data

T

message?

string

Returns

void

unauthorized()

unauthorized(message?): void

Defined in: src/types/http.ts:62

Parameters

message?

string

Returns

void

validationError()

validationError(errors): void

Defined in: src/types/http.ts:68

Parameters

errors

object[]

Returns

void