Popularity
3.5
Growing
Activity
2.7
Growing
335
8
24

Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Filesystem     String     Path     Filepath     Sanitize     File     Name     Convert     Dirname     Valid     Safe     Filename    
Latest version: v4.2.0

filenamify alternatives and similar modules

Based on the "Filesystem" category.
Alternatively, view filenamify alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of filenamify or a related project?

Add another 'Filesystem' Module

README

filenamify

Convert a string to a valid safe filename

On Unix-like systems, / is reserved. On Windows, <>:"/\|?* along with trailing periods are reserved.

Install

$ npm install filenamify

Usage

const filenamify = require('filenamify');

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

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

API

filenamify(string, options?)

Convert a string to a valid filename.

filenamify.path(path, options?)

Convert the filename in a path a valid filename and return the augmented path.

options

Type: object

replacement

Type: string\ Default: '!'

String to use as replacement for reserved filename characters.

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

maxLength

Type: number\ Default: 100

Truncate the filename to the given length.

Systems generally allow up to 255 characters, but we default to 100 for usability reasons.

Browser-only import

You can also import filenamify/browser, which only imports filenamify and not filenamify.path, which relies on path being available or polyfilled. Importing filenamify this way is therefore useful when it is shipped using webpack or similar tools, and if filenamify.path is not needed.

const filenamify = require('filenamify/browser');

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

Related