Skip to content

refactor: add missing JSDoc documentation #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
melihbirim merged 2 commits into from
Dec 27, 2025
Merged

refactor: add missing JSDoc documentation #41

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5435d53
refactor: add missing JSDoc comments for isRgbColor and isHashtag
melihbirim Dec 27, 2025
c9e491e
refactor: add missing JSDoc comment for isRgbColor function
melihbirim Dec 27, 2025
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
16 changes: 16 additions & 0 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,9 +719,17 @@ function isMACAddress(value) {
function isHexColor(value) {
return PATTERNS.HEX_COLOR.test(value);
}

/**
* Checks if a given value is a valid RGB or RGBA color
* Supports formats like rgb(255, 0, 0) and rgba(0, 255, 0, 0.5)
* @param {string} value - The value to check
* @returns {boolean} True if the value is a valid RGB/RGBA color, false otherwise
*/
function isRgbColor(value) {
return PATTERNS.RGB_COLOR.test(value);
}

/**
* Checks if a given value is a percentage
* @param {string} value - The value to check
Expand Down Expand Up @@ -750,6 +758,14 @@ function isISBN(value) {
return PATTERNS.ISBN.test(value);
}

/**
* Checks if a given value is a valid hashtag (e.g., #hello, #OpenSource)
* Handles disambiguation from 3-character hex colors when option is enabled
* @param {string} value - The value to check
* @param {Object} [options={}] - Options object
* @param {boolean} [options.preferHashtagOver3CharHex=false] - If true, prefer hashtag interpretation for 4-char strings starting with #
* @returns {boolean} True if the value is a valid hashtag, false otherwise
*/
function isHashtag(value, options = {}) {
if (!value.startsWith('#')) return false;

Expand Down