TS comments for functions rangeToText and isValidValueType

packages/validation/src/utils/isValidValueType.ts

@@ -20,6 +20,14 @@
 import type { DataRecordValue, SchemaField } from 'dictionary';
 import { isBooleanArray, isInteger, isIntegerArray, isNumber, isNumberArray, isStringArray } from './typeUtils';
 
+/**
+ * Checks that a value matches the expected type for a given field, based on the value type specified in its field
+ * definition.
+ *
+ * @param value Value to check
+ * @param fieldDefinition Field definition that specifies the expected value type
+ * @returns `true` if value matches the expected type; `false` otherwise.
+ */
 export const isValidValueType = (value: DataRecordValue, fieldDefinition: SchemaField): boolean => {
 	switch (fieldDefinition.valueType) {
 		case 'boolean': {

packages/validation/src/utils/rangeToText.ts

@@ -19,6 +19,16 @@
 
 import { RestrictionRange } from 'dictionary';
 
+/**
+ * Convert a RestrictionRange object to a simple string representation.
+ *
+ * @example
+ * const range = { exclusiveMin: 0, max: 10 };
+ * rangeToText(range); // "> 0 and <= 10"
+ *
+ * @param range
+ * @returns
+ */
 export const rangeToText = (range: RestrictionRange): string => {
 	let minString = '';
 	let maxString = '';