aboutsummaryrefslogtreecommitdiff
path: root/node_modules/filenamify/index.d.ts
diff options
context:
space:
mode:
authorMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
committerMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
commitd25e11bee6ca5ca523884da132d18e1400e077b9 (patch)
tree8af39fde19f7ed640a60fb397c7edd647dff1c4c /node_modules/filenamify/index.d.ts
downloadkartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.gz
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.bz2
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.zip
Initial commit
Diffstat (limited to 'node_modules/filenamify/index.d.ts')
-rw-r--r--node_modules/filenamify/index.d.ts30
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;