Improves error messages.

Author: unematiii

src/core/Capability.ts

@@ -1,6 +1,13 @@
 import { Capability as ICapability, Property as IProperty } from '../types';
 
-import { bytesToChunks, bytesToInt, hexToUint8Array, isEmptyObject, isObject } from '../utils';
+import {
+  bytesToChunks,
+  bytesToInt,
+  getArray,
+  hexToUint8Array,
+  isEmptyObject,
+  isObject,
+} from '../utils';
 
 import { InvalidCommandError, JSONError } from './Error';
 import { NamedEntity } from './NamedEntity';
@@ -95,9 +102,7 @@ export abstract class Capability extends Serializable implements NamedEntity {
       }
 
       for (const [name, components] of Object.entries(payload)) {
-        const componentsArray = (Array.isArray(components) ? components : [components]).filter(
-          (value) => value !== null,
-        );
+        const componentsArray = getArray(components).filter((value) => value !== null);
 
         if (componentsArray.length) {
           for (const components of componentsArray) {
@@ -119,21 +124,17 @@ export abstract class Capability extends Serializable implements NamedEntity {
   }
 
   public getProperty(name: string): Property | undefined {
-    const property = this.properties[name];
-    return Array.isArray(property) ? property[0] : property;
+    const [property] = getArray(this.properties[name]);
+    return property;
   }
 
   public getProperties(name: string) {
-    const property = this.properties[name] || [];
-    return Array.isArray(property) ? property : [property];
+    return getArray(this.properties[name] || []);
   }
 
   public getPropertiesArray() {
     return Object.values(this.properties).reduce<Property[]>(
-      (allProperties, properties) => [
-        ...allProperties,
-        ...(Array.isArray(properties) ? properties : [properties]),
-      ],
+      (allProperties, properties) => [...allProperties, ...getArray(properties)],
       [],
     );
   }
@@ -185,9 +186,7 @@ export abstract class Capability extends Serializable implements NamedEntity {
 
     const currentValue = this.properties[name];
     if (property.multiple && currentValue) {
-      (this.properties[name] = Array.isArray(currentValue) ? currentValue : [currentValue]).push(
-        property,
-      );
+      (this.properties[name] = getArray(currentValue)).push(property);
     } else {
       this.properties[name] = property;
     }

src/core/Command.ts

@@ -26,7 +26,7 @@ export class Command {
 
       const type = CommandType[capitalize(name) as keyof typeof CommandType];
       if (type === undefined) {
-        throw new Error(`Unknown command type: ${name}`);
+        throw new Error(`Unknown command type: ${name}.`);
       }
 
       return new Command(

src/factories/CapabilityFactory.ts

@@ -1,4 +1,5 @@
 import { ClassList } from '../capabilities/classes';
+
 export class CapabilityFactory {
   public static createFromIdentifier(msb: number, lsb: number) {
     const Capability = ClassList.find(

src/utils/misc.ts

@@ -1,5 +1,9 @@
 import { isFinite, isPlainObject } from 'lodash';
 
+export function getArray<T>(value: T | T[]): T[] {
+  return Array.isArray(value) ? value : [value];
+}
+
 export function isArrayOfNumbers(value: unknown): value is number[] {
   return Array.isArray(value) && value.every(isInteger);
 }

src/values/BytesValue.ts

@@ -19,7 +19,7 @@ export class BytesValue extends Value<number[]> {
     if (value && isArrayOfNumbers(value)) {
       this.setValue(value);
     } else {
-      throw new JSONError('Value must be array of numbers.');
+      throw new JSONError('Value must be an array of numbers.');
     }
 
     return this;

src/values/FloatValue.ts

@@ -23,7 +23,7 @@ export class FloatValue extends Value<number> {
     if (isNumber(value)) {
       this.setValue(value);
     } else {
-      throw new JSONError('Value must be number.');
+      throw new JSONError('Value must be a number.');
     }
 
     return this;

src/values/IntegerValue.ts

@@ -23,7 +23,7 @@ export class IntegerValue extends Value<number> {
     if (isInteger(value)) {
       this.setValue(value);
     } else {
-      throw new JSONError('Value must be integer.');
+      throw new JSONError('Value must be an integer.');
     }
 
     return this;

src/values/StringValue.ts

@@ -21,7 +21,7 @@ export class StringValue extends Value<string> {
     if (isString(value)) {
       this.setValue(value);
     } else {
-      throw new JSONError('Value must be string.');
+      throw new JSONError('Value must be a string.');
     }
 
     return this;

src/values/TimestampValue.ts

@@ -26,7 +26,7 @@ export class TimestampValue extends Value<Date> {
     if (isString(value)) {
       this.setValue(new Date(value));
     } else {
-      throw new JSONError('Value must be string in ISO date-time format.');
+      throw new JSONError('Value must be a string in ISO date-time format.');
     }
 
     return this;

src/values/UnitValue.ts

@@ -57,7 +57,7 @@ export class UnitValue extends Value<UnitValueData, UnitValueDataSetter> impleme
       if (isObject(value) && isNumber(value.value)) {
         this.setValue(value as UnitValueDataSetter);
       } else {
-        throw new Error('Value must be number.');
+        throw new Error('Value must be a number.');
       }
     } catch (e) {
       throw new JSONError(e);