Add ResultRecord#doesNotHaveErrors and ResultRecord#getErrorMessageFor

Author: Mat Jones

src/view-models/result-record.test.ts

@@ -2,6 +2,10 @@ import { ResultRecord } from "./result-record";
 import { ErrorType } from "../enumerations/error-type";
 import { ResultErrorRecord } from "./result-error-record";
 import { ResultError } from "../interfaces/result-error";
+import {
+    ResultRecordFactory,
+    ResultErrorRecordFactory,
+} from "../tests/factories";
 
 describe("ResultRecord", () => {
     // -----------------------------------------------------------------------------------------
@@ -203,6 +207,82 @@ describe("ResultRecord", () => {
 
     // #endregion errorCount
 
+    // -----------------------------------------------------------------------------------------
+    // #region doesNotHaveErrors
+    // -----------------------------------------------------------------------------------------
+
+    describe("doesNotHaveErrors", () => {
+        test("when errors is null, returns true", () => {
+            expect(
+                ResultRecordFactory.build({
+                    errors: (null as unknown) as any[],
+                }).doesNotHaveErrors()
+            ).toBeTrue();
+        });
+
+        test("when errors is undefined, returns true", () => {
+            expect(
+                ResultRecordFactory.build({
+                    errors: undefined,
+                }).doesNotHaveErrors()
+            ).toBeTrue();
+        });
+
+        test("when errors is empty array, returns true", () => {
+            expect(
+                ResultRecordFactory.build({ errors: [] }).doesNotHaveErrors()
+            ).toBeTrue();
+        });
+
+        test("when errors is not empty, returns false", () => {
+            // Arrange
+            const errors = ResultErrorRecordFactory.buildList(1);
+
+            // Act & Assert
+            expect(
+                ResultRecordFactory.build({
+                    errors: errors,
+                }).doesNotHaveErrors()
+            ).toBeFalse();
+        });
+    }); // end doesNotHaveErrors
+
+    // -----------------------------------------------------------------------------------------
+    // #region getErrorMessageFor
+    // -----------------------------------------------------------------------------------------
+
+    describe("#getErrorMessageFor", () => {
+        it("When no error exists for given key, then returns undefined", () => {
+            // Arrange
+            const errorKey = "TEST_ERROR_KEY";
+            const resultRecord = ResultRecordFactory.build({
+                errors: [],
+            });
+
+            // Act
+            const result = resultRecord.getErrorMessageFor(errorKey);
+
+            // Assert
+            expect(result).toBeNil();
+        });
+
+        it("When an error exists for the given key, then returns the error message", () => {
+            // Arrange
+            const errorKey = "TEST_ERROR_KEY";
+            const resultRecord = ResultRecordFactory.build({
+                errors: ResultErrorRecordFactory.buildList(1, {
+                    key: errorKey,
+                }),
+            });
+
+            // Act
+            const result = resultRecord.getErrorMessageFor(errorKey);
+
+            // Assert
+            expect(result).not.toBeNil();
+        });
+    }); // end getErrorMessageFor
+
     // -----------------------------------------------------------------------------------------
     // #region hasErrorFor
     // -----------------------------------------------------------------------------------------

src/view-models/result-record.ts

@@ -60,6 +60,14 @@ class ResultRecord<T> extends Record(defaultValues) implements Result<T> {
         return this._addErrorByType(key, message, ErrorType.ValidationError);
     }
 
+    /**
+     * Evaluates whether there are any errors on the result
+     * @returns {boolean}
+     */
+    public doesNotHaveErrors(): boolean {
+        return !this.hasErrors();
+    }
+
     /**
      * Returns total number of errors
      */
@@ -71,6 +79,14 @@ class ResultRecord<T> extends Record(defaultValues) implements Result<T> {
         return CollectionUtils.hasValues(this.errors) ? this.errors.length : 0;
     }
 
+    /**
+     * Returns an error message for a given key
+     * @param key
+     */
+    public getErrorMessageFor(key: string): string | undefined {
+        return this.errors?.find((e) => e.key === key)?.message;
+    }
+
     /**
      * Determines if the result contains an error for the supplied key
      * @param key error key for which to search