README

is-invalid-path

Returns true if a windows file path has invalid characters.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save is-invalid-path

Usage

const isInvalid = require('is-invalid-path');

// true if the path is not a string or has invalid characters
console.log(isInvalid());       //=> true
console.log(isInvalid('<abc')); //=> true
console.log(isInvalid('>abc')); //=> true
console.log(isInvalid(':abc')); //=> true
console.log(isInvalid('"abc')); //=> true
console.log(isInvalid('|abc')); //=> true
console.log(isInvalid('?abc')); //=> true
console.log(isInvalid('*abc')); //=> true

// true if the path has slashes and options.file is true,
// as slashes and backslashes are invalid in file names
console.log(isInvalid('foo/abc', { file: true })); //=> true
console.log(isInvalid('foo\\abc', { file: true })); //=> true

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern… more | homepage
is-windows: Returns true if the platform is windows. UMD module, works with node.js, commonjs, browser, AMD… more | homepage

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.6.0, on April 19, 2018.

Usage no npm install needed!