Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: improve JSDoc for parseModule function
Add comprehensive JSDoc documentation with parameter descriptions,
return type, and exception handling information.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
  • Loading branch information
synthable and claude committed Sep 23, 2025
commit e540d3714927333214b7bb12300016c2b72fc10e
10 changes: 9 additions & 1 deletion packages/ums-lib/src/core/module-loader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,15 @@ function isValidRawModuleData(data: unknown): data is RawModuleData {
}

/**
* Parses and validates a UMS v1.0 module from content string
* Parses and validates a UMS v1.0 module from a YAML content string.
*
* The input string must be valid YAML representing a UMS v1.0 module. The function will
* parse the YAML and validate the resulting object according to the UMS v1.0 specification.
* If the content is invalid YAML or fails validation, an error will be thrown.
*
* @param {string} content - The YAML string containing the UMS module definition.
* @returns {UMSModule} The validated UMS module object.
* @throws {Error} If the content is not valid YAML or fails UMS module validation.
*/
export function parseModule(content: string): UMSModule {
try {
Expand Down