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
|
# filename-reserved-regex [](https://travis-ci.org/sindresorhus/filename-reserved-regex)
> Regular expression for matching reserved filename characters
On Unix-like systems `/` is reserved and [`<>:"/\|?*`](http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29#naming_conventions) as well as non-printable characters `\x00-\x1F` on Windows.
## Install
```
$ npm install --save filename-reserved-regex
```
## Usage
```js
const filenameReservedRegex = require('filename-reserved-regex');
filenameReservedRegex().test('foo/bar');
//=> true
filenameReservedRegex().test('foo-bar');
//=> false
'foo/bar'.replace(filenameReservedRegex(), '!');
//=> 'foo!bar'
filenameReservedRegex.windowsNames().test('aux');
//=> true
```
## API
### filenameReservedRegex()
Returns a regex that matches all invalid characters.
### filenameReservedRegex.windowsNames()
Returns a exact-match case-insensitive regex that matches invalid Windows
filenames. These include `CON`, `PRN`, `AUX`, `NUL`, `COM1`, `COM2`, `COM3`, `COM4`, `COM5`,
`COM6`, `COM7`, `COM8`, `COM9`, `LPT1`, `LPT2`, `LPT3`, `LPT4`, `LPT5`, `LPT6`, `LPT7`, `LPT8`
and `LPT9`.
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
