|
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- # filenamify [![Build Status](https://travis-ci.org/sindresorhus/filenamify.svg?branch=master)](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`
-
- #### 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
- - [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)
|