first commit
This commit is contained in:
62
build/node_modules/filenamify/readme.md
generated
vendored
Normal file
62
build/node_modules/filenamify/readme.md
generated
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
# 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 --save 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`
|
||||
|
||||
#### options
|
||||
|
||||
##### replacement
|
||||
|
||||
Type: `string`<br>
|
||||
Default: `'!'`
|
||||
|
||||
String to use as replacement for reserved filename characters.
|
||||
|
||||
Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*`
|
||||
|
||||
|
||||
## Related
|
||||
|
||||
- [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
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
||||
Reference in New Issue
Block a user