Bakhtina Sofya b84cb877be 1st comm 2 weeks ago
..
index.js b84cb877be 1st comm 2 weeks ago
license b84cb877be 1st comm 2 weeks ago
package.json b84cb877be 1st comm 2 weeks ago
readme.md b84cb877be 1st comm 2 weeks ago

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