在前端开发中，经常需要使用文件上传功能。然而，由于不同平台和操作系统对文件名的限制不同，一些特殊字符或长度超过特定限制的文件名可能会导致一系列问题，如程序崩溃或无法正确保存文件等。
sanitize-filename是一个npm包，可以帮助我们清理文件名并使其符合特定操作系统的要求。它支持Windows，Linux和MacOS等操作系统，并提供了一组默认选项，可以自定义规则进行更细粒度的控制。
安装
使用npm安装该包：
npm install sanitize-filename
使用方法
基本用法
const sanitize = require("sanitize-filename");
const filename = "my-file/with:invalid*characters?.txt";
const sanitizedFilename = sanitize(filename);
console.log(sanitizedFilename); // my-file_with_invalid_characters_.txt自定义规则
除了默认规则之外，您还可以使用自定义规则清理文件名。以下示例将演示如何删除所有下划线并将所有单词大写。
-- -------------------- ---- ------- ----- -------- - ----------------------------- ----- -------- - ------------------- ----- ------- - - ------------ ---- ---------- ------ ------------- ------------ ------------------ --- ----------------- ------ -- ------------------ ---- -- ----- ----------------- - ------------------ --------- ------------------------------- -- --------------
选项
sanitize-filename允许您使用以下选项进行自定义：
replacement: 用于替换无效字符的字符。默认为下划线。lowerCase: 是否将文件名转换为小写。默认为true。customExcess: 正则表达式，用于匹配要删除的字符。默认为/[<>:"/\\|?*\x00-\x1F]/g，即Windows操作系统中不允许的特殊字符。customReplacement: 用于替换自定义规则匹配到的字符的字符。customSanitizeFn: 自定义清理函数，按照该函数返回的值对文件名进行清理。
总结
sanitize-filename是一个非常有用的npm包，可以帮助我们处理文件上传时遇到的问题。通过简单易懂的接口和可自定义的选项，它可以使我们更轻松地实现文件名的清理和规范化，从而提高程序的稳定性和可靠性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/51722