regex-username

2.0.0 • Public • Published

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-'); // => false
regex().test('-foo-bar'); // => false
regex().test('foo--bar'); // => false
regex().test('~derp@darp---++asdf'); // => false
regex().test('derp@mail.com'); // => 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

Package Sidebar

Install

npm i regex-username

Weekly Downloads

123

Version

2.0.0

License

MIT

Last publish

Collaborators

  • yoshuawuyts
  • jonschlinkert
  • doowb
  • vanchoy
  • tunnckocore