public_library_map/node_modules/entities/lib/encode.d.ts

22 lines
949 B
TypeScript
Raw Normal View History

2021-11-24 19:46:47 +11:00
/**
2022-09-03 17:12:22 +10:00
* Encodes all characters in the input using HTML entities. This includes
* characters that are valid ASCII characters in HTML documents, such as `#`.
2021-11-24 19:46:47 +11:00
*
2022-09-03 17:12:22 +10:00
* To get a more compact output, consider using the `encodeNonAsciiHTML`
* function, which will only encode characters that are not valid in HTML
* documents, as well as non-ASCII characters.
2021-11-24 19:46:47 +11:00
*
2022-09-03 17:12:22 +10:00
* If a character has no equivalent entity, a numeric hexadecimal reference
* (eg. `ü`) will be used.
2021-11-24 19:46:47 +11:00
*/
2022-09-03 17:12:22 +10:00
export declare function encodeHTML(data: string): string;
2021-11-24 19:46:47 +11:00
/**
* Encodes all non-ASCII characters, as well as characters not valid in HTML
2022-09-03 17:12:22 +10:00
* documents using HTML entities. This function will not encode characters that
* are valid in HTML documents, such as `#`.
2021-11-24 19:46:47 +11:00
*
2022-09-03 17:12:22 +10:00
* If a character has no equivalent entity, a numeric hexadecimal reference
* (eg. `ü`) will be used.
2021-11-24 19:46:47 +11:00
*/
2022-09-03 17:12:22 +10:00
export declare function encodeNonAsciiHTML(data: string): string;
2021-11-24 19:46:47 +11:00
//# sourceMappingURL=encode.d.ts.map