safename
Get safe file name from a given string.
Installation
Install with npm
$ npm install safename
Install with Bower
$ bower install safename
Example
var safename = require( 'safename' );
safename('my file name.txt');
safename('my file name.txt', '-');
safename.low('my file name.txt');
safename.middle('my file name.txt', '-');
safename API
safename( filename, space )
Get safe name for files
Parameters:
- filename String: string to transform
- space String: replace for spaces. Optional, low dash ('_') by default
- Return String: safe name
low( )
Safe name with low dash '_'
Same as safename('your file name.txt', '_');
middle( )
Safe name with middle dash '-'
Same as safename('your file name.txt', '-');
Tests
npm install && npm test
Build API docs
npm install && npm run build-docs
© 2014 jacoborus
Released under MIT License