All Projects → regexhq → regex-username

regexhq / regex-username

Licence: MIT License
Regular expression for usernames

Programming Languages

javascript
184084 projects - #8 most used programming language
Makefile
30231 projects

regex-username

NPM version build status Test coverage Downloads

Regular expression for usernames - it follows the same rules that GitHub uses.

Installation

npm install regex-username

Usage

var regex = require('regex-username');

regex().test('foo-bar'); // => true
regex().test('foobar'); // => true
regex().test('3foobar'); // => true
regex().test('3foo-bar'); // => true
regex().test('foo-bar-baz'); // => true
regex().test('f'); // => true
regex().test('foo-bar-'); // => false
regex().test('-foo-bar'); // => false
regex().test('foo--bar'); // => false
regex().test('~derp@darp---++asdf'); // => false
regex().test('[email protected]'); // => false
regex().test('foo_bar'); // => false

Why?

Which usernames to allow typically varies between applications. For prototypes however it's nice to have an off the shelf solution. This module is that solution. It follows the same rules GitHub uses:

Username may only contain alphanumeric characters or single hyphens, and cannot begin or end with a hyphen.

See Also

License

MIT

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].