Convert a string to a valid safe filename
JavaScript
Clone or download
Latest commit b22fbd3 Jun 14, 2018
Permalink
Failed to load latest commit information.
.editorconfig Meta tweaks Apr 19, 2018
.gitattributes Require Node.js 6 Jun 14, 2018
.gitignore Meta tweaks Apr 19, 2018
.npmrc Meta tweaks Apr 19, 2018
.travis.yml Require Node.js 6 Jun 14, 2018
index.js Require Node.js 6 Jun 14, 2018
license Meta tweaks Apr 19, 2018
package.json Require Node.js 6 Jun 14, 2018
readme.md Meta tweaks Apr 19, 2018
test.js Meta tweaks Apr 19, 2018

readme.md

filenamify Build Status

Convert a string to a valid safe filename

On Unix-like systems / is reserved and <>:"/\|?* on Windows.

Install

$ npm install filenamify

Usage

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
Default: '!'

String to use as replacement for reserved filename characters.

Cannot contain: < > : " / \ | ? *

Related

License

MIT © Sindre Sorhus