miguelmota / is-valid-domain

Validate domain name in JavaScript

is-valid-domain

Validate domain name in JavaScript

Demo

https://lab.miguelmota.com/is-valid-domain

Install

npm install is-valid-domain

Usage

const isValidDomain = require('is-valid-domain')

isValidDomain('example.com') // true
isValidDomain('foo.example.com') // true
isValidDomain('bar.foo.example.com') // true
isValidDomain('exa-mple.co.uk') // true
isValidDomain('xn--80ak6aa92e.com') // true
isValidDomain('_dnslink.ipfs.io') // true
isValidDomain('exa_mple.com') // false
isValidDomain('-example.co.uk') // false
isValidDomain('example') // false
isValidDomain('ex*mple.com') // false
isValidDomain('*.example.com') // false
isValidDomain('*.com') // false
isValidDomain(3434) // false

isValidDomain('foo.example.com', {subdomain: true}) // true
isValidDomain('foo.example.com', {subdomain: false}) // false
isValidDomain('*.example.com', {wildcard: false}) // false
isValidDomain('*.example.com', {wildcard: true}) // true
isValidDomain('*.example.com', {subdomain: false, wildcard: true}) // false
isValidDomain('はじめよう.みんな') // false
isValidDomain('はじめよう.みんな', {allowUnicode: true}) // true
isValidDomain('ai.') // false
isValidDomain('ai.', {topLevel: true}) // true

view more examples

Test

npm test

Contributing

Adding new domains:

• Add second level domain to data/second_level_domains.csv
• Run npm run generate to generate JSON map file
• Run npm test

FAQ

• Q: Why is trailing dot . in domain names verified as true?

  • A: Fully qualified domain names allow the trailing dot which represents the root zone. More info here and here.

License

MIT

is-valid-domain's Issues

Underscore in domain name

Hello,
it seems to be valid to have underscores in subdomain name like _underscore.hello.com
https://ubuntu101.co.za/dns-and-bind/underscores-domain-names-do-they-work/
But this library returns false.

I have domain xn--_eamop-.donata.com (name has been anonymized), that https://who.is/dns/{original name} returns valid data, so domain is valid too

Domain should be invalid when starting with hyphen

Hi, the regex should be changed so that a domain or subdomain starting with hyphen will be invalid.
e.g. -example.domain.com or example.-domain.com

Cheers

Support Typescript import

Hey,

Love this package and was using the 0.0.17 version in my typescript project.
But since 0.1.6, i'm not able to import it correctly (no matters the way, default or single).

Do you plan to support it again ?
Thanks!

"site.com." is not valid

Invalid because the terminating character is a dot

subdomain ending in dash

i thought a sub domain can't start or end in a -
but it seems to allow it when at the end of the subdomain

punnycode with hypen

Hello!

Thank you for this library.

I found a small bug - this should be a valid domain name:
привет-мир.рф -> xn----ctbjkdxqigq.xn--p1ai

> isValidDomain('xn----ctbjkdxqigq.xn--p1ai')
false

Allow protocols http:// and https:// ftp:// etc

Maybe add in the possibility to allow protocols with a list like:

isValidDomain('https://domain.tld', { allowedProtocols: ['https'] })

What do you think?

".みんな" domain is determined to be invalid

Some new gTLDs use Japanese or Chinese.
".みんな" domain is one of the examples (you can get more information at http://xn--p8j9a0d9c9a.xn--q9jyb4c )

However, it seems with this library these are determined to be invalid.
(I checked with this site https://lab.miguelmota.com/is-valid-domain/example/ )

"isValidDomain('www.example.com', {wildcard: true})" should be false

In my opinion, domain must has wildcard when wildcard set to true, but the result is not that, as follow code.

isValidDomain('www.example.com', {wildcard: true}); // the result is true

"isValidDomain('dfgdfg.dfgdf33.e', {subdomain: true})" should be false

It returns true - see below

The below must also return false

does not validate correct for country tlds (com.au)

if i were to test

google.com"\'\"\""\\"\\'test test

it comes back as invalid

it i test:

google.com.au'"\'\"\""\\"\\'test

it comes back as valid

Subdomain that ends with a dot is valid

When a domain ends with a dot, and subdomain flag is set to false, it still returns as valid:

isValidDomain('example.com.', { subdomain: false } // returns true

Is this the correct behavior?

Doesn't handle punycode/i18nal domains

Domains such as xn--ber-goa.com (über.com) and xn--6qq79v.xn--fiqz9s (你好.中國) seem to throw this off after punyfication 😢

Wildcard option with TLDs

It looks like the wildcard option cannot be used together with the topLevel option.

const isValidDomain = require('is-valid-domain')

isValidDomain('ch', {topLevel: true, subdomain: true})  // -> true
isValidDomain('*.ch', {topLevel: true, wildcard: true, subdomain: true})  // -> false

// one from sldMap.json has the same problem:
isValidDomain('gov.sg', {topLevel: true, subdomain: true})  // -> true
isValidDomain('*.gov.sg', {topLevel: true, wildcard: true, subdomain: true})  // -> false

Is this a bug or something that can be supported in the future? Either with those options or a new specific one (e.g. secondLevelWildcard)?
Thank you already for your feedback!

Allow domain containing double hyphens

Hey! Thanks for creating this package.

We have an example of a valid ASCII domain containing 2 dashes but this package is considering it as invalid.

isValidDomain('abcd--def.example.com')

"Failed to compile."

With the latest version, my NextJS build (using Webpack 5) fails. Here's the error:

Failed to compile.

ModuleNotFoundError: Module not found: Error: Can't resolve 'punycode' in '/Users/msc/Code/@sitearcade/words/node_modules/is-valid-domain'
BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.
This is no longer the case. Verify if you need this module and configure a polyfill for it.

If you want to include a polyfill, you need to:
	- add a fallback 'resolve.fallback: { "punycode": require.resolve("punycode/") }'
	- install 'punycode'
If you don't want to include a polyfill, you can use an empty module like this:
	resolve.fallback: { "punycode": false }


> Build error occurred
Error: > Build failed because of webpack errors
    at /PROJECT/node_modules/next/dist/build/index.js:15:924
    at async Span.traceAsyncFn (/PROJECT/node_modules/next/dist/telemetry/trace/trace.js:6:584)

TLDs not supported

This library doesn't appear to detect a TLD as a valid domain, even though they are -- it would be great if this was supported, either by default or with a flag.

Currently:

const isValidDomain = require('is-valid-domain')

console.log(isValidDomain('test.ai.')) // true
console.log(isValidDomain('ai.')) // false

But http://ai./ is valid.

Domain started with number are not valid

Domains like 1tv.ru are existing, but lib says it's not valid
Seems like any domain started with number considered as not valid

Validation without subdomain should validate .co.uk domains

When I try to validate a domain name without subdomain is work for most of domains but fail with composed TLD (co.uk ...)

For example:

isValidDomain('www.domain.com', {
  subdomain: false,
}); // false

isValidDomain('domain.co.uk', {
  subdomain: false,
}); // false

The second case should be true instead of false.