diff options
Diffstat (limited to 'node_modules/filename-reserved-regex/readme.md')
| -rw-r--r-- | node_modules/filename-reserved-regex/readme.md | 49 |
1 files changed, 0 insertions, 49 deletions
diff --git a/node_modules/filename-reserved-regex/readme.md b/node_modules/filename-reserved-regex/readme.md deleted file mode 100644 index 91641b5..0000000 --- a/node_modules/filename-reserved-regex/readme.md +++ /dev/null @@ -1,49 +0,0 @@ -# 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) |