Class ApiResponseBuilder

Util class for handling API responses.

Example

import createServer from '@egomobile/http-server'
import { ApiResponseBuilder } from '@egomobile/api-utils'

const app = createServer()

app.get('/', async (request, response) => {
  new ApiResponseBuilder({ request, response })
    .send()  // send a simple 200 message
})

app.listen()
  .catch(console.error)

Constructors

constructor

Properties

_data _executeEnd _headers _messages _status _success request response

Accessors

data headers messages status success

Methods

addMessage create noSuccess send withData withHeaders withList withStatus withSuccess

Constructors

constructor

Properties

Private _data

_data: Nullable<ApiResponseData> = null

Private Readonly _executeEnd

_executeEnd: boolean

Private _headers

_headers: OutgoingHttpHeaders = {}

Private Readonly _messages

_messages: IApiResponseMessage[] = []

Private _status

_status: number = 200

Private _success

_success: boolean = true

Readonly request

request: IHttpRequest<any>

The underlying request context.

Readonly response

response: IHttpResponse

The underlying response context.

Accessors

data

headers

messages

status

success

Methods

addMessage

create

noSuccess

send

withData

withHeaders

withList

withStatus

withSuccess

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc