Repository URL to install this package:
|
Version:
0.0.15 ▾
|
/**
* @file @see https://github.com/parshap/node-sanitize-filename/blob/master/index.js
*
* Replaces characters in strings that are illegal/unsafe for filenames.
* Unsafe characters are either removed or replaced by a substitute set
* in the optional `options` object.
*
* Illegal Characters on Various Operating Systems
* / ? < > \ : * | "
* https://kb.acronis.com/content/39790
*
* Unicode Control codes
* C0 0x00-0x1f & C1 (0x80-0x9f)
* http://en.wikipedia.org/wiki/C0_and_C1_control_codes
*
* Reserved filenames on Unix-based systems (".", "..")
* Reserved filenames in Windows ("CON", "PRN", "AUX", "NUL", "COM1",
* "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9",
* "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", and
* "LPT9") case-insesitively and with or without filename extensions.
*
* Capped at 255 characters in length.
* http://unix.stackexchange.com/questions/32795/what-is-the-maximum-allowed-filename-and-folder-size-with-ecryptfs
*
* @param {String} input Original filename
* @param {Object} options {replacement: String}
* @return {String} Sanitized filename
*/
import truncate from './fromStringToTruncatedUtf8';
declare function sanitize(input: string, replacement: any): any;
declare function fromStringToSanitizedFileName(input: string, options?: {
replacement: any;
}): any;
export { truncate };
export { sanitize };
export { fromStringToSanitizedFileName };