filename-reserved-regex
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/filename-reserved-regex package

3.0.0 • Public • Published

filename-reserved-regex

Regular expression for matching reserved filename characters

On Unix-like systems / is reserved and <>:"/\|?* as well as non-printable characters \u0000-\u001F on Windows.

Install

$ npm install filename-reserved-regex

Usage

import filenameReservedRegex, {windowsReservedNameRegex} from 'filename-reserved-regex';

filenameReservedRegex().test('foo/bar');
//=> true

filenameReservedRegex().test('foo-bar');
//=> false

'foo/bar'.replace(filenameReservedRegex(), '!');
//=> 'foo!bar'

windowsReservedNameRegex().test('aux');
//=> true

API

filenameReservedRegex()

Returns a regex that matches all invalid characters.

windowsReservedNameRegex()

Returns an 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.

Dependencies (0)

    Dev Dependencies (2)

    Package Sidebar

    Install

    npm i filename-reserved-regex

    Weekly Downloads

    2,964,578

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    3.13 kB

    Total Files

    4

    Last publish

    Collaborators

    • sindresorhus