Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 872 Bytes

README.md

File metadata and controls

34 lines (24 loc) · 872 Bytes
Raw

sanitize-filename

Sanitize a string to be safe for use as a file name in Windows and Unix systems by stripping all control characters and restricted characters (\/:*?"<>|).

Example

// Some string that may be unsafe as a filesystem filename
var UNSAFE_FILENAME = "h*ello:/world?\u0000";

// Sanitize the unsafe filename to be safe for use as a filename
var sanitize = require("sanitize-filename"),
	filename = sanitize(UNSAFE_FILENAME);

// Create a file using the safe filename
require("fs").createWriteStream(filename).end();

API

sanitize(filename, [options])

Sanitize the input string, filename, and replace unsafe characters with optional replacement. The options.replacement can be a string to replace unsafe characters with.

Installation

npm install sanitize-filename