filenamify
Advanced tools
Package description
The filenamify npm package is used to convert a string into a valid and safe filename by removing or replacing invalid characters that are not allowed in filenames on certain file systems. It can be used to sanitize user input for filenames, ensuring that the resulting string can be safely used as a filename on most platforms.
Sanitize a string to be safe as a filename
This feature allows you to take any string and convert it into a string that is safe to use as a filename by replacing or removing invalid characters.
const filenamify = require('filenamify');
console.log(filenamify('foo/bar')); // 'foo!bar'Customize replacement character
This feature allows you to specify a custom replacement character for invalid filename characters, giving you control over how the sanitized filename looks.
const filenamify = require('filenamify');
console.log(filenamify('foo:bar', {replacement: '-'})); // 'foo-bar'Limit filename length
This feature allows you to limit the length of the resulting filename, which can be useful for file systems with length restrictions on filenames.
const filenamify = require('filenamify');
console.log(filenamify('a very long filename that will be truncated', {maxLength: 10})); // 'a very lon'The sanitize-filename package is similar to filenamify in that it sanitizes input to be safe for use as a filename. It removes or replaces invalid characters and is a straightforward alternative to filenamify.
While slugify is primarily used for creating URL slugs from strings, it can also be used to generate safe filenames. It converts strings into a URL-friendly format, which is also generally safe for filenames, though its primary use case is not for sanitizing filenames like filenamify.
Readme
Convert a string to a valid safe filename
On Unix-like systems / is reserved and <>:"/\|?* on Windows.
$ npm install --save 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: < > : " / \ | ? *
MIT © Sindre Sorhus
FAQs
Convert a string to a valid safe filename
The npm package filenamify receives a total of 3,312,073 weekly downloads. As such, filenamify popularity was classified as popular.
We found that filenamify demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.