Namespace api

Index

Interfaces

APIResponse

Functions

Functions

error

error(thrownError: string | Error): APIResponse<void>

- Defined in src/http/response/api.ts:59
Formats an error message or Error instance as an API response.

Parameters
- thrownError: string | Error
Returns APIResponse<void>

APIResponse

many

many<T>(records: T[]): APIResponse<{ records: T[]; total: number }>

- Defined in src/http/response/api.ts:44
Formats an array of records as a successful API response.

Type parameters
- T
Parameters
- records: T[]
Returns APIResponse<{ records: T[]; total: number }>

APIResponse

message

message(displayMessage: string): APIResponse<void>

- Defined in src/http/response/api.ts:20
Formats a mesage as a successful API response.

Parameters
- displayMessage: string
Returns APIResponse<void>

APIResponse

one

one<T>(record: T): APIResponse<T>

- Defined in src/http/response/api.ts:32
Formats a single record as a successful API response.

Type parameters
- T
Parameters
- record: T
Returns APIResponse<T>

APIResponse

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.