https://github.com/jonschlinkert/is-valid-path
Returns true if a windows file path does not contain any invalid characters.
https://github.com/jonschlinkert/is-valid-path
characters check file file-path filepath invalid invalid-characters javascript jonschlinkert node nodejs path test valid validate windows
Last synced: about 2 months ago
JSON representation
Returns true if a windows file path does not contain any invalid characters.
- Host: GitHub
- URL: https://github.com/jonschlinkert/is-valid-path
- Owner: jonschlinkert
- License: mit
- Created: 2015-05-06T10:58:04.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T15:21:30.000Z (over 2 years ago)
- Last Synced: 2025-04-06T05:05:13.941Z (2 months ago)
- Topics: characters, check, file, file-path, filepath, invalid, invalid-characters, javascript, jonschlinkert, node, nodejs, path, test, valid, validate, windows
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 97.7 KB
- Stars: 12
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# is-valid-path [](http://badge.fury.io/js/is-valid-path)
> Returns true if a file path does not contain any invalid characters.
Install with [npm](https://www.npmjs.com/)
```bash
npm i is-valid-path --save
```
## Usage
```js
var isValid = require('is-valid-path');
/**
* Valid
*/
isValid('abc.js');
//=> 'true'
isValid('abc/def/ghi.js');
//=> 'true'
isValid('foo.js');
//=> 'true'
/**
* Invalid
*/
isValid();
//=> 'valse'
isValid(null);
//=> 'valse'
isValid('!foo.js');
//=> 'false'
isValid('*.js');
//=> 'false'
isValid('**/abc.js');
//=> 'false'
isValid('abc/*.js');
//=> 'false'
isValid('abc/(aaa|bbb).js');
//=> 'false'
isValid('abc/[a-z].js');
//=> 'false'
isValid('abc/{a,b}.js');
//=> 'false'
isValid('abc/?.js');
//=> 'false'
```
## Related
* [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
* [is-invalid-path](https://github.com/jonschlinkert/is-invalid-path): Returns true if a file path has invalid characters.
* [is-git-url](https://github.com/jonschlinkert/is-git-url): Regex to validate that a URL is a git url.
* [micromatch](https://github.com/jonschlinkert/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… [more](https://github.com/jonschlinkert/micromatch)
* [parse-glob](https://github.com/jonschlinkert/parse-glob): Parse a glob pattern into an object of tokens.
## Run tests
Install dev dependencies:
```bash
npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-valid-path/issues)
## Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright (c) 2015 Jon Schlinkert
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 06, 2015._