From c3f27796500a37d081eef5be4d82f18fe98475e1 Mon Sep 17 00:00:00 2001 From: garrettmills Date: Tue, 19 Oct 2021 13:00:14 -0500 Subject: [PATCH] Add generic to APIResponse --- src/http/response/api.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/http/response/api.ts b/src/http/response/api.ts index 46cc7ea..41e83d6 100644 --- a/src/http/response/api.ts +++ b/src/http/response/api.ts @@ -1,10 +1,10 @@ /** * Base type for an API response format. */ -export interface APIResponse { +export interface APIResponse { success: boolean, message?: string, - data?: any, + data?: T, error?: { name: string, message: string, @@ -17,7 +17,7 @@ export interface APIResponse { * @param {string} displayMessage * @return APIResponse */ -export function message(displayMessage: string): APIResponse { +export function message(displayMessage: string): APIResponse { return { success: true, message: displayMessage, @@ -29,7 +29,7 @@ export function message(displayMessage: string): APIResponse { * @param record * @return APIResponse */ -export function one(record: unknown): APIResponse { +export function one(record: T): APIResponse { return { success: true, data: record, @@ -41,7 +41,7 @@ export function one(record: unknown): APIResponse { * @param {array} records * @return APIResponse */ -export function many(records: any[]): APIResponse { +export function many(records: T[]): APIResponse<{records: T[], total: number}> { return { success: true, data: { @@ -56,7 +56,7 @@ export function many(records: any[]): APIResponse { * @return APIResponse * @param thrownError */ -export function error(thrownError: string | Error): APIResponse { +export function error(thrownError: string | Error): APIResponse { if ( typeof thrownError === 'string' ) { return { success: false,