Fix #519: TypeGuardError.description.
#1649
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds an optional description field to the TypeGuardError class to provide human-readable descriptions of type guard errors. The primary purpose is to support specialized AI agent libraries and custom validation scenarios that need additional context beyond the standard technical type information.
- Adds an optional
descriptionproperty toTypeGuardErrorclass and itsIPropsinterface - Implements logic to auto-populate description for
undefinedvalues with helpful guidance - Includes comprehensive documentation explaining the field's intended use cases
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
| @@ -124,6 +135,14 @@ export class TypeGuardError<T = any> extends Error { | |||
| this.path = props.path; | |||
| this.expected = props.expected; | |||
| this.value = props.value; | |||
| if (props.description || props.value === undefined) | |||
There was a problem hiding this comment.
The condition logic is incorrect. When props.description is truthy, the description will be set even when the value is not undefined, which contradicts the auto-population intent. The condition should be if (props.description !== undefined || props.value === undefined) to properly handle explicit empty string descriptions.
| if (props.description || props.value === undefined) | |
| if (props.description !== undefined || props.value === undefined) |
Copilot uses AI. Check for mistakes.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
commit: |
This pull request updates the
pnpm-lock.yamlfile with a number of dependency upgrades, removals, and additions, primarily affecting packages related tojsdomand its ecosystem. The main focus is on upgrading to newer versions that require Node.js 18 or higher, removing deprecated or obsolete packages, and introducing some new dependencies.Dependency upgrades and ecosystem modernization:
jsdomand its related dependencies (such ascssstyle,data-urls,domexception,html-encoding-sniffer,http-proxy-agent,https-proxy-agent,w3c-xmlserializer,whatwg-encoding,whatwg-mimetype,whatwg-url,tough-cookie,tr46, andagent-base) to versions compatible with Node.js 18+, improving compatibility and security. [1] [2] [3] [4] [5] F5d6a7f6L2132R2143, [6] [7] [8] [9] [10]Package removals and cleanup:
abab,acorn-globals,@tootallnate/once,data-urls@4.0.0,domexception@4.0.0,escodegen,psl,querystringify,requires-port,universalify, andurl-parse. This reduces bloat and potential maintenance issues. [1] [2] [3] [4] [5] [6] [7] [8]New dependency additions:
@asamuzakjp/css-color, several@csstools/*packages, andtldts/tldts-core, which may be required for new features or improved CSS and domain parsing support. [1] [2] [3]Peer dependency and engine updates:
These changes collectively modernize the dependency tree, improve security and maintainability, and prepare the codebase for future development on newer Node.js versions.