Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-21 20:50:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs(html): improve API docs (#4878)

Browse Source
This commit is contained in:
Yoshiya Hinosawa 2024-05-29 18:15:48 +09:00 committed by GitHub
parent bd7c465ccb
commit 595d812ea3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_tools/check_docs.ts
View File

@ -39,6 +39,7 @@ const ENTRY_POINTS = [
"../fmt/duration.ts",
"../fmt/printf.ts",
"../front_matter/mod.ts",
"../html/mod.ts",
"../http/mod.ts",
"../internal/mod.ts",
"../jsonc/mod.ts",

11
html/entities.ts
View File

@ -25,7 +25,7 @@ const rawRe = new RegExp(`[${[...rawToEntity.keys()].join("")}]`, "g");
/**
* Escapes text for safe interpolation into HTML text content and quoted attributes.
*
* @example
* @example Usage
* ```ts
* import { escape } from "@std/html/entities";
*
@ -35,6 +35,9 @@ const rawRe = new RegExp(`[${[...rawToEntity.keys()].join("")}]`, "g");
* // even if named HTML entities exist for them.
* escape("þð"); // "þð"
* ```
*
* @param str The string to escape.
* @returns The escaped string.
*/
export function escape(str: string): string {
return str.replaceAll(rawRe, (m) => rawToEntity.get(m)!);
@ -57,7 +60,7 @@ const entityListRegexCache = new WeakMap<EntityList, RegExp>();
/**
* Unescapes HTML entities in text.
*
* @example
* @example Usage
* ```ts
* import { unescape } from "@std/html/entities";
*
@ -70,6 +73,10 @@ const entityListRegexCache = new WeakMap<EntityList, RegExp>();
*
* unescape("&thorn;&eth;", { entityList }); // "þð"
* ```
*
* @param str The string to unescape.
* @param options Options for unescaping.
* @returns The unescaped string.
*/
export function unescape(
str: string,