UNPKG

reserved-subdomains

Version:

A list of names that should be reserved in multitenant apps.

github.com/jedireza/reserved-subdomains

jedireza/reserved-subdomains

63 lines (35 loc) • 1.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# reserved-subdomains A list of names that should be reserved in multitenant apps. ## Install ```bash $ npm install reserved-subdomains ``` ## API reference - [Properties](#properties) - [`names`](#names) - [`nameMap`](#namemap) - [`patterns`](#patterns) - [`patternsRegex`](#patternsregex) - [Methods](#methods) - [`isNotValid(name)`](#isnotvalidname) - [`isValid(name)`](#isvalidname) ### Properties #### `names` An array of strings. Ex: `['www', 'ftp', 'mail', ...]`. #### `nameMap` An object where keys are names. Ex: `{ www: true, ftp: true, mail: true, ...}`. #### `patterns` An array of regular expression strings. Ex: `['ww[a-z0-9-]+', 'ftp[0-9]+', 'mail[0-9]+', ...]`. #### `patternsRegex` An array of regular expression objects. Ex: `[/ww[a-z0-9-]+/, /ftp[0-9]+/, /mail[0-9]+/, ...]`. ### Methods #### `isNotValid(name)` Returns `true` if the name _is not_ valid where: - `name` - the name to test. #### `isValid(name)` Returns `true` if the name _is_ valid where: - `name` - the name to test. ## Inspired by https://github.com/nkkollaw/reserved-subdomains ## License MIT