blob: cc17d11d25612c6aee44fe57f1698c081cb5b192 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
declare namespace filenamify {
interface Options {
/**
String to use as replacement for reserved filename characters.
Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*`
@default '!'
*/
readonly replacement?: string;
/**
Truncate the filename to the given length.
Systems generally allow up to 255 characters, but we default to 100 for usability reasons.
@default 100
*/
readonly maxLength?: number;
}
}
/**
Convert a string to a valid filename.
@example
```
import filenamify = require('filenamify');
filenamify('<foo/bar>');
//=> 'foo!bar'
filenamify('foo:"bar"', {replacement: '🐴'});
//=> 'foo🐴bar'
```
*/
declare const filenamify: (string: string, options?: filenamify.Options) => string;
export = filenamify;
|
