github-username-regex
A regular expression that only matches a valid Github username
; githubUsernameRegex; //=> truegithubUsernameRegex; //=> truegithubUsernameRegex; //=> false
According to the form validation messages on Join Github page,
- Github username may only contain alphanumeric characters or hyphens.
- Github username cannot have multiple consecutive hyphens.
- Github username cannot begin or end with a hyphen.
- Maximum is 39 characters.
Installation
npm
npm install github-username-regex
bower
bower install github-username-regex
API
;
githubUsernameRegex
Type: RegExp
(/^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i
)
// Returns `true`githubUsernameRegex;githubUsernameRegex;githubUsernameRegex;githubUsernameRegex;githubUsernameRegex; // Returns `false`githubUsernameRegex;githubUsernameRegex;githubUsernameRegex;githubUsernameRegex;githubUsernameRegex;githubUsernameRegex;
Note that this module doesn't take reserved usernames into consideration. For example it matches help
, about
and pricing
, though they are reserved words and cannot be used as Github usernames.