Add TypeScript definitions and non-throwing variants for validator#1345
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds non-throwing validator variants and TypeScript definitions to the rclnodejs validator module, addressing issue #1344.
Summary: The PR introduces boolean-returning validator functions (isValid*) that complement the existing throwing validators, along with complete TypeScript type definitions for all validator functions.
Key Changes:
- Added four new non-throwing validator functions:
isValidFullTopicName,isValidNodeName,isValidTopicName, andisValidNamespace - Created comprehensive TypeScript definitions in
types/validator.d.tswith detailed documentation - Updated JSDoc comments for existing validator functions to improve clarity and consistency
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| types/validator.d.ts | New file containing TypeScript definitions for all validator functions with comprehensive JSDoc documentation |
| types/base.d.ts | Added reference path to include the new validator type definitions |
| lib/validator.js | Implemented four new non-throwing validator functions and updated JSDoc comments for existing functions |
| test/test-validator.js | Added comprehensive test suites for all four new non-throwing validator functions covering valid, invalid, and edge cases |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mahmoud-ghalayini
merged commit 31aa851
into
RobotWebTools:develop
26 of 28 checks passed
minggangw
pushed a commit
that referenced
this pull request
Jan 6, 2026
…1345) - Add complete TypeScript definitions for all validator methods (types/validator.d.ts) - Add isValidFullTopicName(), isValidNodeName(), isValidTopicName(), isValidNamespace() methods that return boolean instead of throwing - Non-throwing variants enable simple conditional checks without try/catch blocks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Public API Changes
Added non-throwing validator variants to
rclnodejs.validator:isValidFullTopicName(topic: string): booleanisValidNodeName(name: string): booleanisValidTopicName(topic: string): booleanisValidNamespace(namespace: string): booleanAdded TypeScript definitions for all validator methods in
types/validator.d.ts.#1344