summaryrefslogtreecommitdiff
path: root/ext/url
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2022-08-17 13:12:24 +1000
committerGitHub <noreply@github.com>2022-08-17 13:12:24 +1000
commita2ab5eee015b1dafc1a18cd2bc5f5c5756123d74 (patch)
tree1efd7d79208fee44cc05c71c18c7d9e6759ed8c3 /ext/url
parent868c7e38bfc9a09b5cfeae30ea5a2345a6d700d7 (diff)
docs: add category tag for built-in APIs (#15480)
Diffstat (limited to 'ext/url')
-rw-r--r--ext/url/lib.deno_url.d.ts17
1 files changed, 15 insertions, 2 deletions
diff --git a/ext/url/lib.deno_url.d.ts b/ext/url/lib.deno_url.d.ts
index d3a51a00e..53298166b 100644
--- a/ext/url/lib.deno_url.d.ts
+++ b/ext/url/lib.deno_url.d.ts
@@ -5,6 +5,7 @@
/// <reference no-default-lib="true" />
/// <reference lib="esnext" />
+/** @category Web APIs */
declare class URLSearchParams {
constructor(
init?: string[][] | Record<string, string> | string | URLSearchParams,
@@ -151,7 +152,11 @@ declare class URLSearchParams {
toString(): string;
}
-/** The URL interface represents an object providing static methods used for creating object URLs. */
+/** The URL interface represents an object providing static methods used for
+ * creating object URLs.
+ *
+ * @category Web APIs
+ */
declare class URL {
constructor(url: string | URL, base?: string | URL);
static createObjectURL(blob: Blob): string;
@@ -173,6 +178,7 @@ declare class URL {
toJSON(): string;
}
+/** @category Web APIs */
declare interface URLPatternInit {
protocol?: string;
username?: string;
@@ -185,14 +191,19 @@ declare interface URLPatternInit {
baseURL?: string;
}
+/** @category Web APIs */
declare type URLPatternInput = string | URLPatternInit;
+/** @category Web APIs */
declare interface URLPatternComponentResult {
input: string;
groups: Record<string, string>;
}
-/** `URLPatternResult` is the object returned from `URLPattern.exec`. */
+/** `URLPatternResult` is the object returned from `URLPattern.exec`.
+ *
+ * @category Web APIs
+ */
declare interface URLPatternResult {
/** The inputs provided when matching. */
inputs: [URLPatternInit] | [URLPatternInit, string];
@@ -242,6 +253,8 @@ declare interface URLPatternResult {
* console.log(pattern.test("https://blog.example.com/article")); // true
* console.log(pattern.test("https://blog.example.com/article/123")); // false
* ```
+ *
+ * @category Web APIs
*/
declare class URLPattern {
constructor(input: URLPatternInput, baseURL?: string);