opennms/src/api/OnmsResult.ts

Client API for the OpenNMS network monitoring platform

/**
 * An [[IOnmsHTTP]] query result.
 * @category Rest
 */
export class OnmsResult<T> {
  /** 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 readonly data: T;

  /** The request type, if any. */
  public readonly type?: string;

  /** The status message associated with this result. */
  public readonly message?: string;

  /** The response code associated with this result. */
  public readonly 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;
  }
}