diff options
Diffstat (limited to 'node_modules/filenamify/readme.md')
| -rw-r--r-- | node_modules/filenamify/readme.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/node_modules/filenamify/readme.md b/node_modules/filenamify/readme.md new file mode 100644 index 0000000..b0365e6 --- /dev/null +++ b/node_modules/filenamify/readme.md @@ -0,0 +1,69 @@ +# filenamify [](https://travis-ci.org/sindresorhus/filenamify) + +> Convert a string to a valid safe filename + +On Unix-like systems `/` is reserved and [`<>:"/\|?*`](http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29#naming_conventions) on Windows. + + +## Install + +``` +$ npm install filenamify +``` + + +## Usage + +```js +const filenamify = require('filenamify'); + +filenamify('<foo/bar>'); +//=> 'foo!bar' + +filenamify('foo:"bar"', {replacement: '🐴'}); +//=> 'foo🐴bar' +``` + + +## API + +### filenamify(input, [options]) + +Accepts a filename and returns a valid filename. + +### filenamify.path(input, [options]) + +Accepts a path and returns the path with a valid filename. + +#### input + +Type: `string` + +A string to convert to a valid filename. + +#### options + +Type: `Object` + +##### replacement + +Type: `string`<br> +Default: `'!'` + +String to use as replacement for reserved filename characters. + +Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*` + + +## Related + +- [filenamify-cli](https://github.com/sindresorhus/filenamify-cli) - CLI for this module +- [filenamify-url](https://github.com/sindresorhus/filenamify-url) - Convert a URL to a valid filename +- [valid-filename](https://github.com/sindresorhus/valid-filename) - Check if a string is a valid filename +- [unused-filename](https://github.com/sindresorhus/unused-filename) - Get a unused filename by appending a number if it exists +- [slugify](https://github.com/sindresorhus/slugify) - Slugify a string + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |