History

Kate Temkin c893a86e54 initial commit of template		2024-04-26 22:49:34 -06:00
..
index.js	initial commit of template	2024-04-26 22:49:34 -06:00
license	initial commit of template	2024-04-26 22:49:34 -06:00
package.json	initial commit of template	2024-04-26 22:49:34 -06:00
readme.md	initial commit of template	2024-04-26 22:49:34 -06:00

filenamify

Convert a string to a valid safe filename

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

Install

$ npm install filenamify

const filenamify = require('filenamify');

filenamify('<foo/bar>');
//=> 'foo!bar'

filenamify('foo:"bar"', {replacement: '🐴'});
//=> 'foo🐴bar'

Accepts a filename and returns a valid filename.

Accepts a path and returns the path with a valid filename.

Type: string

Type: string
Default: '!'

String to use as replacement for reserved filename characters.

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