aboutsummaryrefslogtreecommitdiff
path: root/node_modules/filename-reserved-regex/readme.md
diff options
context:
space:
mode:
authorMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
committerMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
commitd25e11bee6ca5ca523884da132d18e1400e077b9 (patch)
tree8af39fde19f7ed640a60fb397c7edd647dff1c4c /node_modules/filename-reserved-regex/readme.md
downloadkartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.gz
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.bz2
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.zip
Initial commit
Diffstat (limited to 'node_modules/filename-reserved-regex/readme.md')
-rw-r--r--node_modules/filename-reserved-regex/readme.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/node_modules/filename-reserved-regex/readme.md b/node_modules/filename-reserved-regex/readme.md
new file mode 100644
index 0000000..91641b5
--- /dev/null
+++ b/node_modules/filename-reserved-regex/readme.md
@@ -0,0 +1,49 @@
+# filename-reserved-regex [![Build Status](https://travis-ci.org/sindresorhus/filename-reserved-regex.svg?branch=master)](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)