Class NextApiResponseBuilder

Readonly request

Readonly response

data

• get data(): Nullable<ApiResponseData>

• Gets the data to return.

  Returns Nullable<ApiResponseData>

  The data to return.

headers

• get headers(): OutgoingHttpHeaders

• Gets the current HTTP response headers to add to response.

  Returns OutgoingHttpHeaders

  The HTTP response headers.

messages

• get messages(): IApiResponseMessage[]

• Get the messages to return.

  Returns IApiResponseMessage[]

  The messages to return.

status

• get status(): number

• Gets the current status code.

  Returns number

  The status code.

success

• get success(): boolean

• Gets the value for the 'success' property of the response.

  Returns boolean

  The value of 'success' property of the response.

addMessage

• addMessage(message): this

• Adds a message.

  Parameters

  • message: string

    The message.

  Returns this

  That instance.
• addMessage(options): this

• Parameters

  • options: IAddApiResponseMessageOptions

  Returns this

create

• create(): IApiResponse

• Creates a new API response object.

  Returns IApiResponse

  The new object.

noSuccess

• noSuccess(): this

• Sets the value for 'success' result prop to '(false)'.

  Returns this

  That instance.

send

• send(): void

• Creates and sends an API response, based of the current object of that instance.

  Returns void

withData

• withData(data): this

• Sets the value for the data property.

  Parameters

  • data: Nilable<ApiResponseData>

    The new value.

  Returns this

  That instance.

withHeaders

• withHeaders(headers): this

• Sets additional HTTP response headers.

  Parameters

  • headers: OutgoingHttpHeaders

    Additional HTTP response headers.

  Returns this

  That instance.

withList

• withList(items): this

• Sets the value for the data property as list response.

  Parameters

  • items: List

  Returns this

  That instance.
• withList(options): this

• Parameters

  • options: IWithApiResponseListOptions<any>

  Returns this

withStatus

• withStatus(code): this

• Sets the response HTTP status code.

  Parameters

  • code: number

    The new value.

  Returns this

  That instance.

withSuccess

• withSuccess(value?): this

• Sets the value of the 'success' property.

  Parameters

  • Optional value: boolean

    The new value.

  Returns this

  That instance.