-
Notifications
You must be signed in to change notification settings - Fork 8
/
OnmsResult.ts
54 lines (45 loc) · 1.47 KB
/
OnmsResult.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import {OnmsError} from './OnmsError';
/**
* An [[IOnmsHTTP]] query result.
* @module OnmsResult
*/
export class OnmsResult<T> {
/** Create a new error result. */
public static error(message: string, code?: number) {
return new OnmsResult(undefined, message, code);
}
/** Create a new success result. */
public static ok(response: any, message?: string, code?: number, type?: string) {
return new OnmsResult(response, message || 'OK', code || 200, type);
}
/** Create a new "No Content" result. */
public static noContent() {
// Use a null string for the data
return new OnmsResult(null, 'No Content', 204);
}
/** The data, if any. */
public data: T;
/** The request type, if any. */
public type: string;
/** The status message associated with this result. */
public message: string;
/** The response code associated with this result. */
public code: number;
/**
* Construct a new result.
* @param data The payload of the response.
* @param message The status message associated with the result.
* @param code The response code of the response.
* @param type The request type of the response.
*/
constructor(data: T, message?: string, code?: number, type?: string) {
this.data = data;
this.message = message;
this.code = code;
this.type = type;
}
/** Whether this result is considered successful. */
public isSuccess() {
return this.code === 200 || this.code === 202 || this.code === 204;
}
}