@morojs/moro / ResponseBuilder

Class: ResponseBuilder<T>

Defined in: src/core/utilities/response-helpers.ts:361

Type-safe response builder for complex scenarios

Example

import { ResponseBuilder } from '@morojs/moro';

app.get('/users', async (req, res) => {
  const users = await getUsers();
  return ResponseBuilder.success(users)
    .message('Successfully retrieved users')
    .build();
});

Type Parameters

T

T = any

Methods

build()

build(): ApiResponse<T>

Defined in: src/core/utilities/response-helpers.ts:418

Build and return the final response

Returns

ApiResponse<T>

code()

code(code): this

Defined in: src/core/utilities/response-helpers.ts:410

Add a code to error response

Parameters

code

string

Returns

this

details()

details(details): this

Defined in: src/core/utilities/response-helpers.ts:402

Add details to the response

Parameters

details

any

Returns

this

message()

message(msg): this

Defined in: src/core/utilities/response-helpers.ts:394

Add a message to the response

Parameters

msg

string

Returns

this

error()

static error(errorMessage, code?): ResponseBuilder<never>

Defined in: src/core/utilities/response-helpers.ts:381

Start building an error response

Parameters

errorMessage

string

code?

string

Returns

ResponseBuilder<never>

success()

static success<T>(data): ResponseBuilder<T>

Defined in: src/core/utilities/response-helpers.ts:369

Start building a success response

Type Parameters

T

T

Parameters

data

T

Returns

ResponseBuilder<T>