diff options
Diffstat (limited to 'node_modules/filenamify/index.d.ts')
-rw-r--r-- | node_modules/filenamify/index.d.ts | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/node_modules/filenamify/index.d.ts b/node_modules/filenamify/index.d.ts new file mode 100644 index 0000000..9f6ce0a --- /dev/null +++ b/node_modules/filenamify/index.d.ts @@ -0,0 +1,30 @@ +export interface Options { + /** + * String to use as replacement for reserved filename characters. + * + * Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*` + * + * @default '!' + */ + readonly replacement?: string; +} + +/** + * Accepts a filename and returns a valid filename. + * + * @param input - A string to convert to a valid filename. + */ +export interface Filenamify { + (input: string, options?: Options): string; + + /** + * Accepts a path and returns the path with a valid filename. + * + * @param input - A string to convert to a valid path with a filename. + */ + path(input: string, options?: Options): string; +} + +declare const filenamify: Filenamify; + +export default filenamify; |