ghaction-upx/node_modules/filenamify/index.d.ts

31 lines
685 B
TypeScript
Raw Normal View History

2020-04-03 02:12:31 -06:00
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;