legendary-doc-site/apps/core/assets/node_modules/filenamify
2020-07-03 21:41:01 -05:00
..
index.js chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
license chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
package.json chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
readme.md chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00

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: < > : " / \ | ? *

License

MIT © Sindre Sorhus