diff options
Diffstat (limited to 'desktop/node_modules/filenamify/filenamify.d.ts')
-rw-r--r-- | desktop/node_modules/filenamify/filenamify.d.ts | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/desktop/node_modules/filenamify/filenamify.d.ts b/desktop/node_modules/filenamify/filenamify.d.ts new file mode 100644 index 0000000..cc17d11 --- /dev/null +++ b/desktop/node_modules/filenamify/filenamify.d.ts @@ -0,0 +1,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; |