Initial release for SPT 3.9
This commit is contained in:
38
types/utils/HttpResponseUtil.d.ts
vendored
Normal file
38
types/utils/HttpResponseUtil.d.ts
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
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";
|
||||
export declare class HttpResponseUtil {
|
||||
protected jsonUtil: JsonUtil;
|
||||
protected localisationService: LocalisationService;
|
||||
constructor(jsonUtil: JsonUtil, localisationService: LocalisationService);
|
||||
protected clearString(s: string): any;
|
||||
/**
|
||||
* Return passed in data as JSON string
|
||||
* @param data
|
||||
* @returns
|
||||
*/
|
||||
noBody(data: any): any;
|
||||
/**
|
||||
* Game client needs server responses in a particular format
|
||||
* @param data
|
||||
* @param err
|
||||
* @param errmsg
|
||||
* @returns
|
||||
*/
|
||||
getBody<T>(data: T, err?: number, errmsg?: string, sanitize?: boolean): IGetBodyResponseData<T>;
|
||||
getUnclearedBody(data: any, err?: number, errmsg?: string): string;
|
||||
emptyResponse(): IGetBodyResponseData<string>;
|
||||
nullResponse(): INullResponseData;
|
||||
emptyArrayResponse(): IGetBodyResponseData<any[]>;
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
appendErrorToOutput(output: IItemEventRouterResponse, message?: string, errorCode?: BackendErrorCodes): IItemEventRouterResponse;
|
||||
}
|
||||
Reference in New Issue
Block a user