@morojs/moro / MoroResponseMethods

Interface: MoroResponseMethods

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

Properties

locals

locals: Record<string, any>

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

Methods

append()

append(field, value): HttpResponse

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

Parameters

field

string

value

string | string[]

Returns

HttpResponse

appendHeader()

appendHeader(name, value): HttpResponse

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

Parameters

name

string

value

string | string[]

Returns

HttpResponse

attachment()

attachment(filename?): HttpResponse

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

Parameters

filename?

string

Returns

HttpResponse

badRequest()

badRequest(message?): void

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

Parameters

message?

string

Returns

void

canSetHeaders()

canSetHeaders(): boolean

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

Returns

boolean

clearCookie()

clearCookie(name, options?): HttpResponse

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

Parameters

name

string

options?

CookieOptions

Returns

HttpResponse

conflict()

conflict(message): void

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

Parameters

message

string

Returns

void

cookie()

cookie(name, value, options?): HttpResponse

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

Parameters

name

string

value

string

options?

CookieOptions

Returns

HttpResponse

created()

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

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

Type Parameters

T

T = any

Parameters

data

T

location?

string

Returns

void

download()

download(filePath, filename?): Promise<void>

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

Parameters

filePath

string

filename?

string

Returns

Promise<void>

error()

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

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

Parameters

error

string

code?

string

message?

string

Returns

void

forbidden()

forbidden(message?): void

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

Parameters

message?

string

Returns

void

format()

format(handlers): void

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

Parameters

handlers

Record<string, () => any | Promise<any>>

Returns

void

get()

get(field): string | number | string[] | undefined

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

Parameters

field

string

Returns

string | number | string[] | undefined

getResponseState()

getResponseState(): ResponseState

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

Returns

ResponseState

hasHeader()

hasHeader(name): boolean

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

Parameters

name

string

Returns

boolean

internalError()

internalError(message?): void

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

Parameters

message?

string

Returns

void

json()

json(data): void

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

Parameters

data

any

Returns

void

links()

links(links): HttpResponse

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

Parameters

links

Record<string, string>

Returns

HttpResponse

location()

location(url): HttpResponse

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

Parameters

url

string

Returns

HttpResponse

noContent()

noContent(): void

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

Returns

void

notFound()

notFound(resource?): void

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

Parameters

resource?

string

Returns

void

paginated()

paginated<T>(data, pagination): void

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

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:106

Parameters

retryAfter?

number

Returns

void

redirect()

redirect(url, status?): void

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

Parameters

url

string

status?

number

Returns

void

render()?

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

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

Parameters

template

string

data?

any

Returns

Promise<void>

send()

send(data): void

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

Parameters

data

string | Buffer<ArrayBufferLike>

Returns

void

sendFile()

sendFile(filePath): Promise<void>

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

Parameters

filePath

string

Returns

Promise<void>

sendStatus()

sendStatus(code): void

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

Parameters

code

number

Returns

void

set()

set(field, value?): HttpResponse

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

Parameters

field

string | Record<string, string | number | string[]>

value?

string | number | string[]

Returns

HttpResponse

setBulkHeaders()

setBulkHeaders(headers): HttpResponse

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

Parameters

headers

Record<string, string | number>

Returns

HttpResponse

status()

status(code): HttpResponse

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

Parameters

code

number

Returns

HttpResponse

success()

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

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

Type Parameters

T

T = any

Parameters

data

T

message?

string

Returns

void

type()

type(contentType): HttpResponse

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

Parameters

contentType

string

Returns

HttpResponse

unauthorized()

unauthorized(message?): void

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

Parameters

message?

string

Returns

void

validationError()

validationError(errors): void

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

Parameters

errors

object[]

Returns

void

vary()

vary(field): HttpResponse

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

Parameters

field

string | string[]

Returns

HttpResponse