soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

docs(8.0): add module JSDoc to typeValidation.ts (the one file missing a module block)

Browse source
This commit is contained in:
David Snelling 2026-07-01 15:37:25 -07:00
parent 1aad1f67de
commit ab53fa0893
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/utils/typeValidation.ts
View file

@ -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' import { NounType, VerbType } from '../types/graphTypes.js'
// Type sets for O(1) validation // Type sets for O(1) validation