two-slot-extended-mags/types/utils/HttpResponseUtil.d.ts

39 lines
1.7 KiB
TypeScript
Raw Normal View History

2024-08-05 20:33:00 +10:00
import { IGetBodyResponseData } from "@spt/models/eft/httpResponse/IGetBodyResponseData";
import { INullResponseData } from "@spt/models/eft/httpResponse/INullResponseData";
import { IItemEventRouterResponse } from "@spt/models/eft/itemEvent/IItemEventRouterResponse";
import { BackendErrorCodes } from "@spt/models/enums/BackendErrorCodes";
import { LocalisationService } from "@spt/services/LocalisationService";
import { JsonUtil } from "@spt/utils/JsonUtil";
2023-06-11 15:10:34 +10:00
export declare class HttpResponseUtil {
protected jsonUtil: JsonUtil;
protected localisationService: LocalisationService;
constructor(jsonUtil: JsonUtil, localisationService: LocalisationService);
protected clearString(s: string): any;
2023-10-09 20:21:00 +11:00
/**
* Return passed in data as JSON string
* @param data
* @returns
*/
2023-06-11 15:10:34 +10:00
noBody(data: any): any;
2024-04-03 20:15:11 +11:00
/**
* Game client needs server responses in a particular format
* @param data
* @param err
* @param errmsg
* @returns
*/
2024-08-05 20:33:00 +10:00
getBody<T>(data: T, err?: number, errmsg?: string, sanitize?: boolean): IGetBodyResponseData<T>;
getUnclearedBody(data: any, err?: number, errmsg?: string): string;
2023-06-11 15:10:34 +10:00
emptyResponse(): IGetBodyResponseData<string>;
nullResponse(): INullResponseData;
emptyArrayResponse(): IGetBodyResponseData<any[]>;
2024-04-03 20:15:11 +11:00
/**
* Add an error into the 'warnings' array of the client response message
* @param output IItemEventRouterResponse
* @param message Error message
* @param errorCode Error code
* @returns IItemEventRouterResponse
*/
2023-06-11 15:10:34 +10:00
appendErrorToOutput(output: IItemEventRouterResponse, message?: string, errorCode?: BackendErrorCodes): IItemEventRouterResponse;
}