@technobuddha/library/dist/escape-html.d.ts

A large library of useful functions

/**
 * Options for {@link escapeHTML}
 * @group Programming
 * @category Escaping
 */
export type EscapeHtmlOptions = {
    /** escape all characters outside the 7-bit ASCII range */
    escapeNonASCII?: boolean;
};
/**
 * Escape a string for use in HTML
 * @param input - The string to escape
 * @param options - see {@link EscapeHtmlOptions}
 * @example
 * ```typescript
 * escapeHTML('<div>hello</div>'); // '&lt;div&gt;hello&lt;/div&gt';
 * escapeHTML('aáΔ😀', { escapeNonASCII: true }); // 'a&#225;&#916;&#128512';
 * ```
 * @group Programming
 * @category Escaping
 */
export declare function escapeHTML(input: string, { escapeNonASCII: escapeNonAscii }?: EscapeHtmlOptions): string;