Current File : /home/tradevaly/www/node_modules/entities/lib/encode.d.ts

/**
 * Encodes all non-ASCII characters, as well as characters not valid in XML
 * documents using XML entities.
 *
 * If a character has no equivalent entity, a
 * numeric hexadecimal reference (eg. `ü`) will be used.
 */
export declare const encodeXML: (data: string) => string;
/**
 * Encodes all entities and non-ASCII characters in the input.
 *
 * This includes characters that are valid ASCII characters in HTML documents.
 * For example `#` will be encoded as `#`. To get a more compact output,
 * consider using the `encodeNonAsciiHTML` function.
 *
 * If a character has no equivalent entity, a
 * numeric hexadecimal reference (eg. `ü`) will be used.
 */
export declare const encodeHTML: (data: string) => string;
/**
 * Encodes all non-ASCII characters, as well as characters not valid in HTML
 * documents using HTML entities.
 *
 * If a character has no equivalent entity, a
 * numeric hexadecimal reference (eg. `ü`) will be used.
 */
export declare const encodeNonAsciiHTML: (data: string) => string;
/**
 * Encodes all non-ASCII characters, as well as characters not valid in XML
 * documents using numeric hexadecimal reference (eg. `ü`).
 *
 * Have a look at `escapeUTF8` if you want a more concise output at the expense
 * of reduced transportability.
 *
 * @param data String to escape.
 */
export declare function escape(data: string): string;
/**
 * Encodes all characters not valid in XML documents using numeric hexadecimal
 * reference (eg. `ü`).
 *
 * Note that the output will be character-set dependent.
 *
 * @param data String to escape.
 */
export declare function escapeUTF8(data: string): string;
//# sourceMappingURL=encode.d.ts.map