From ab53fa089321c59943ac0d89356f8f9b13f22d25 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Wed, 1 Jul 2026 15:37:25 -0700 Subject: [PATCH] docs(8.0): add module JSDoc to typeValidation.ts (the one file missing a module block) --- src/utils/typeValidation.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/utils/typeValidation.ts b/src/utils/typeValidation.ts index 1ec95392..478fe643 100644 --- a/src/utils/typeValidation.ts +++ b/src/utils/typeValidation.ts @@ -1,3 +1,11 @@ +/** + * @module utils/typeValidation + * @description O(1) runtime validation for the {@link NounType} / {@link VerbType} + * enums. Precomputes a `Set` of each enum's values once at module load, then + * exposes type-guard predicates (`isValidNounType` / `isValidVerbType`) and their + * throwing counterparts used by the write-path parameter validators. Pure and + * side-effect-free apart from the two module-level lookup sets. + */ import { NounType, VerbType } from '../types/graphTypes.js' // Type sets for O(1) validation