You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

readme.md 1.3KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. # filename-reserved-regex [![Build Status](https://travis-ci.org/sindresorhus/filename-reserved-regex.svg?branch=master)](https://travis-ci.org/sindresorhus/filename-reserved-regex)
  2. > Regular expression for matching reserved filename characters
  3. 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.
  4. ## Install
  5. ```
  6. $ npm install --save filename-reserved-regex
  7. ```
  8. ## Usage
  9. ```js
  10. const filenameReservedRegex = require('filename-reserved-regex');
  11. filenameReservedRegex().test('foo/bar');
  12. //=> true
  13. filenameReservedRegex().test('foo-bar');
  14. //=> false
  15. 'foo/bar'.replace(filenameReservedRegex(), '!');
  16. //=> 'foo!bar'
  17. filenameReservedRegex.windowsNames().test('aux');
  18. //=> true
  19. ```
  20. ## API
  21. ### filenameReservedRegex()
  22. Returns a regex that matches all invalid characters.
  23. ### filenameReservedRegex.windowsNames()
  24. Returns a exact-match case-insensitive regex that matches invalid Windows
  25. filenames. These include `CON`, `PRN`, `AUX`, `NUL`, `COM1`, `COM2`, `COM3`, `COM4`, `COM5`,
  26. `COM6`, `COM7`, `COM8`, `COM9`, `LPT1`, `LPT2`, `LPT3`, `LPT4`, `LPT5`, `LPT6`, `LPT7`, `LPT8`
  27. and `LPT9`.
  28. ## License
  29. MIT © [Sindre Sorhus](https://sindresorhus.com)