npm-user-validate

What is npm-user-validate?

The npm-user-validate package is used to validate npm usernames. It ensures that usernames conform to the rules and guidelines set by npm, such as length and character restrictions.

What are npm-user-validate's main functionalities?

Username Validation

This feature allows you to validate a given npm username to check if it meets the npm username requirements. The function returns a boolean indicating whether the username is valid.

const validate = require('npm-user-validate');

const username = 'valid-username';
const isValid = validate(username);
console.log(isValid); // true or false

Custom Validation Messages

This feature provides detailed error messages when a username does not meet the validation criteria. The `validate.errors` array contains specific reasons why the username is invalid.

const validate = require('npm-user-validate');

const username = 'invalid username';
const isValid = validate(username);
if (!isValid) {
  console.log(validate.errors); // Array of error messages
}

Other packages similar to npm-user-validate

validator

The 'validator' package provides a comprehensive set of string validation and sanitization utilities. It includes functions for validating usernames, emails, URLs, and more. Compared to npm-user-validate, it offers a broader range of validation functions but may require more configuration for npm-specific username validation.

README

npm-user-validate

Validation for the npm client and npm-www (and probably other npm projects)

Changelog

3.0.0 (2024-09-03)

⚠️ BREAKING CHANGES

• npm-user-validate now supports node ^18.17.0 || >=20.5.0

Bug Fixes

• 5495eff #77 align to npm 10 node engine range (@hashtagchris)

Chores

• 4ad3de2 #77 run template-oss-apply (@hashtagchris)
• 4ef1235 #75 bump @npmcli/eslint-config from 4.0.5 to 5.0.0 (@dependabot[bot])
• c114753 #76 postinstall for dependabot template-oss PR (@hashtagchris)
• b92eb6b #76 bump @npmcli/template-oss from 4.23.1 to 4.23.3 (@dependabot[bot])