@technobuddha/library
Version:
A large library of useful functions
19 lines (18 loc) • 644 B
TypeScript
declare type Options = {
/** if the mask is longer, fill with character */
missing?: string;
};
/**
* Use a simple mask to display a string
*
* @remark The simple mask is a string where '#' characters are replaced by characters from the input string. Other characters in the mask
* are output as-is, to output a '#' use '\#'
*
* @param input The string
* @param mask The mask
* @param __namedParameters see {@link Options}
* @default missing space
* @returns The mask filled with characters from the string
*/
export declare function mask(input: string, maskStr: string, { missing }?: Options): string;
export default mask;