From a69b4646a02dc49a9222cd50c49d3e194f320ff2 Mon Sep 17 00:00:00 2001 From: Jo Franchetti Date: Mon, 6 May 2024 02:56:55 +0100 Subject: docs: update categories to match new planned sitemap (#23677) Updating categories for new sitemap as documented here: https://lucid.app/lucidspark/744b0498-a133-494d-981c-76059dd18885/edit?view_items=jpvBwFdYlNdB&invitationId=inv_50c83415-2aa5-423f-b438-ea156695c08b --- .../lib.deno_broadcast_channel.d.ts | 6 +- ext/cache/lib.deno_cache.d.ts | 12 +- ext/canvas/lib.deno_canvas.d.ts | 20 +- ext/console/lib.deno_console.d.ts | 2 +- ext/crypto/lib.deno_crypto.d.ts | 84 ++++---- ext/fetch/lib.deno_fetch.d.ts | 56 ++--- ext/url/lib.deno_url.d.ts | 20 +- ext/web/lib.deno_web.d.ts | 226 ++++++++++----------- ext/websocket/lib.deno_websocket.d.ts | 14 +- ext/webstorage/lib.deno_webstorage.d.ts | 4 +- 10 files changed, 222 insertions(+), 222 deletions(-) (limited to 'ext') diff --git a/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts b/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts index a3d74c07b..035d9e1ce 100644 --- a/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts +++ b/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts @@ -6,7 +6,7 @@ /// /** - * @category Broadcast Channel + * @category Messaging * @tags unstable */ declare interface BroadcastChannelEventMap { @@ -15,7 +15,7 @@ declare interface BroadcastChannelEventMap { } /** - * @category Broadcast Channel + * @category Messaging * @tags unstable */ declare interface BroadcastChannel extends EventTarget { @@ -58,7 +58,7 @@ declare interface BroadcastChannel extends EventTarget { } /** - * @category Broadcast Channel + * @category Messaging * @tags unstable */ declare var BroadcastChannel: { diff --git a/ext/cache/lib.deno_cache.d.ts b/ext/cache/lib.deno_cache.d.ts index 409ca2c0c..f28de94ce 100644 --- a/ext/cache/lib.deno_cache.d.ts +++ b/ext/cache/lib.deno_cache.d.ts @@ -5,10 +5,10 @@ /// /// -/** @category Cache API */ +/** @category Cache */ declare var caches: CacheStorage; -/** @category Cache API */ +/** @category Cache */ declare interface CacheStorage { /** Open a cache storage for the provided name. */ open(cacheName: string): Promise; @@ -18,7 +18,7 @@ declare interface CacheStorage { delete(cacheName: string): Promise; } -/** @category Cache API */ +/** @category Cache */ declare interface Cache { /** * Put the provided request/response into the cache. @@ -52,19 +52,19 @@ declare interface Cache { ): Promise; } -/** @category Cache API */ +/** @category Cache */ declare var Cache: { readonly prototype: Cache; new (): never; }; -/** @category Cache API */ +/** @category Cache */ declare var CacheStorage: { readonly prototype: CacheStorage; new (): never; }; -/** @category Cache API */ +/** @category Cache */ declare interface CacheQueryOptions { ignoreMethod?: boolean; ignoreSearch?: boolean; diff --git a/ext/canvas/lib.deno_canvas.d.ts b/ext/canvas/lib.deno_canvas.d.ts index da72ae946..da6bc9fa9 100644 --- a/ext/canvas/lib.deno_canvas.d.ts +++ b/ext/canvas/lib.deno_canvas.d.ts @@ -5,22 +5,22 @@ /// /// -/** @category Web APIs */ +/** @category Canvas */ declare type ColorSpaceConversion = "default" | "none"; -/** @category Web APIs */ +/** @category Canvas */ declare type ImageOrientation = "flipY" | "from-image" | "none"; -/** @category Web APIs */ +/** @category Canvas */ declare type PremultiplyAlpha = "default" | "none" | "premultiply"; -/** @category Web APIs */ +/** @category Canvas */ declare type ResizeQuality = "high" | "low" | "medium" | "pixelated"; -/** @category Web APIs */ +/** @category Canvas */ declare type ImageBitmapSource = Blob | ImageData; -/** @category Web APIs */ +/** @category Canvas */ declare interface ImageBitmapOptions { colorSpaceConversion?: ColorSpaceConversion; imageOrientation?: ImageOrientation; @@ -30,12 +30,12 @@ declare interface ImageBitmapOptions { resizeWidth?: number; } -/** @category Web APIs */ +/** @category Canvas */ declare function createImageBitmap( image: ImageBitmapSource, options?: ImageBitmapOptions, ): Promise; -/** @category Web APIs */ +/** @category Canvas */ declare function createImageBitmap( image: ImageBitmapSource, sx: number, @@ -45,14 +45,14 @@ declare function createImageBitmap( options?: ImageBitmapOptions, ): Promise; -/** @category Web APIs */ +/** @category Canvas */ declare interface ImageBitmap { readonly height: number; readonly width: number; close(): void; } -/** @category Web APIs */ +/** @category Canvas */ declare var ImageBitmap: { prototype: ImageBitmap; new (): ImageBitmap; diff --git a/ext/console/lib.deno_console.d.ts b/ext/console/lib.deno_console.d.ts index 3389c3b25..a4968dc83 100644 --- a/ext/console/lib.deno_console.d.ts +++ b/ext/console/lib.deno_console.d.ts @@ -5,7 +5,7 @@ /// /// -/** @category Console and Debugging */ +/** @category I/O */ declare interface Console { assert(condition?: boolean, ...data: any[]): void; clear(): void; diff --git a/ext/crypto/lib.deno_crypto.d.ts b/ext/crypto/lib.deno_crypto.d.ts index 5369dac3b..0c00470ec 100644 --- a/ext/crypto/lib.deno_crypto.d.ts +++ b/ext/crypto/lib.deno_crypto.d.ts @@ -5,26 +5,26 @@ /// /// -/** @category Web Crypto API */ +/** @category Crypto */ declare var crypto: Crypto; -/** @category Web Crypto API */ +/** @category Crypto */ declare interface Algorithm { name: string; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface KeyAlgorithm { name: string; } -/** @category Web Crypto API */ +/** @category Crypto */ declare type AlgorithmIdentifier = string | Algorithm; -/** @category Web Crypto API */ +/** @category Crypto */ declare type HashAlgorithmIdentifier = AlgorithmIdentifier; -/** @category Web Crypto API */ +/** @category Crypto */ declare type KeyType = "private" | "public" | "secret"; -/** @category Web Crypto API */ +/** @category Crypto */ declare type KeyUsage = | "decrypt" | "deriveBits" @@ -34,19 +34,19 @@ declare type KeyUsage = | "unwrapKey" | "verify" | "wrapKey"; -/** @category Web Crypto API */ +/** @category Crypto */ declare type KeyFormat = "jwk" | "pkcs8" | "raw" | "spki"; -/** @category Web Crypto API */ +/** @category Crypto */ declare type NamedCurve = string; -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaOtherPrimesInfo { d?: string; r?: string; t?: string; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface JsonWebKey { alg?: string; crv?: string; @@ -68,129 +68,129 @@ declare interface JsonWebKey { y?: string; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface AesCbcParams extends Algorithm { iv: BufferSource; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface AesGcmParams extends Algorithm { iv: BufferSource; additionalData?: BufferSource; tagLength?: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface AesCtrParams extends Algorithm { counter: BufferSource; length: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface HmacKeyGenParams extends Algorithm { hash: HashAlgorithmIdentifier; length?: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface EcKeyGenParams extends Algorithm { namedCurve: NamedCurve; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface EcKeyImportParams extends Algorithm { namedCurve: NamedCurve; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface EcdsaParams extends Algorithm { hash: HashAlgorithmIdentifier; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaHashedImportParams extends Algorithm { hash: HashAlgorithmIdentifier; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaHashedKeyGenParams extends RsaKeyGenParams { hash: HashAlgorithmIdentifier; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaKeyGenParams extends Algorithm { modulusLength: number; publicExponent: Uint8Array; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaPssParams extends Algorithm { saltLength: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaOaepParams extends Algorithm { label?: Uint8Array; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface HmacImportParams extends Algorithm { hash: HashAlgorithmIdentifier; length?: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface EcKeyAlgorithm extends KeyAlgorithm { namedCurve: NamedCurve; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface HmacKeyAlgorithm extends KeyAlgorithm { hash: KeyAlgorithm; length: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaHashedKeyAlgorithm extends RsaKeyAlgorithm { hash: KeyAlgorithm; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface RsaKeyAlgorithm extends KeyAlgorithm { modulusLength: number; publicExponent: Uint8Array; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface HkdfParams extends Algorithm { hash: HashAlgorithmIdentifier; info: BufferSource; salt: BufferSource; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface Pbkdf2Params extends Algorithm { hash: HashAlgorithmIdentifier; iterations: number; salt: BufferSource; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface AesDerivedKeyParams extends Algorithm { length: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface EcdhKeyDeriveParams extends Algorithm { public: CryptoKey; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface AesKeyGenParams extends Algorithm { length: number; } -/** @category Web Crypto API */ +/** @category Crypto */ declare interface AesKeyAlgorithm extends KeyAlgorithm { length: number; } @@ -198,7 +198,7 @@ declare interface AesKeyAlgorithm extends KeyAlgorithm { /** The CryptoKey dictionary of the Web Crypto API represents a cryptographic * key. * - * @category Web Crypto API + * @category Crypto */ declare interface CryptoKey { readonly algorithm: KeyAlgorithm; @@ -207,7 +207,7 @@ declare interface CryptoKey { readonly usages: KeyUsage[]; } -/** @category Web Crypto API */ +/** @category Crypto */ declare var CryptoKey: { readonly prototype: CryptoKey; new (): never; @@ -216,14 +216,14 @@ declare var CryptoKey: { /** The CryptoKeyPair dictionary of the Web Crypto API represents a key pair for * an asymmetric cryptography algorithm, also known as a public-key algorithm. * - * @category Web Crypto API + * @category Crypto */ declare interface CryptoKeyPair { privateKey: CryptoKey; publicKey: CryptoKey; } -/** @category Web Crypto API */ +/** @category Crypto */ declare var CryptoKeyPair: { readonly prototype: CryptoKeyPair; new (): never; @@ -233,7 +233,7 @@ declare var CryptoKeyPair: { * functions. It is accessed via the Crypto.subtle properties available in a * window context (via Window.crypto). * - * @category Web Crypto API + * @category Crypto */ declare interface SubtleCrypto { generateKey( @@ -367,13 +367,13 @@ declare interface SubtleCrypto { ): Promise; } -/** @category Web Crypto API */ +/** @category Crypto */ declare var SubtleCrypto: { readonly prototype: SubtleCrypto; new (): never; }; -/** @category Web Crypto API */ +/** @category Crypto */ declare interface Crypto { readonly subtle: SubtleCrypto; getRandomValues< @@ -393,7 +393,7 @@ declare interface Crypto { randomUUID(): `${string}-${string}-${string}-${string}-${string}`; } -/** @category Web Crypto API */ +/** @category Crypto */ declare var Crypto: { readonly prototype: Crypto; new (): never; diff --git a/ext/fetch/lib.deno_fetch.d.ts b/ext/fetch/lib.deno_fetch.d.ts index 40b41b430..4eb303e68 100644 --- a/ext/fetch/lib.deno_fetch.d.ts +++ b/ext/fetch/lib.deno_fetch.d.ts @@ -5,7 +5,7 @@ /// /// -/** @category DOM APIs */ +/** @category Platform */ declare interface DomIterable { keys(): IterableIterator; values(): IterableIterator; @@ -17,7 +17,7 @@ declare interface DomIterable { ): void; } -/** @category Fetch API */ +/** @category Fetch */ declare type FormDataEntryValue = File | string; /** Provides a way to easily construct a set of key/value pairs representing @@ -25,7 +25,7 @@ declare type FormDataEntryValue = File | string; * XMLHttpRequest.send() method. It uses the same format a form would use if the * encoding type were set to "multipart/form-data". * - * @category Fetch API + * @category Fetch */ declare interface FormData extends DomIterable { append(name: string, value: string | Blob, fileName?: string): void; @@ -36,13 +36,13 @@ declare interface FormData extends DomIterable { set(name: string, value: string | Blob, fileName?: string): void; } -/** @category Fetch API */ +/** @category Fetch */ declare var FormData: { readonly prototype: FormData; new (): FormData; }; -/** @category Fetch API */ +/** @category Fetch */ declare interface Body { /** A simple getter used to expose a `ReadableStream` of the body contents. */ readonly body: ReadableStream | null; @@ -72,7 +72,7 @@ declare interface Body { text(): Promise; } -/** @category Fetch API */ +/** @category Fetch */ declare type HeadersInit = Iterable | Record; /** This Fetch API interface allows you to perform various actions on HTTP @@ -83,7 +83,7 @@ declare type HeadersInit = Iterable | Record; * methods of this interface, header names are matched by case-insensitive byte * sequence. * - * @category Fetch API + * @category Fetch */ declare interface Headers extends DomIterable { /** Appends a new value onto an existing header inside a `Headers` object, or @@ -118,16 +118,16 @@ declare interface Headers extends DomIterable { * methods of this interface, header names are matched by case-insensitive byte * sequence. * - * @category Fetch API + * @category Fetch */ declare var Headers: { readonly prototype: Headers; new (init?: HeadersInit): Headers; }; -/** @category Fetch API */ +/** @category Fetch */ declare type RequestInfo = Request | string; -/** @category Fetch API */ +/** @category Fetch */ declare type RequestCache = | "default" | "force-cache" @@ -135,13 +135,13 @@ declare type RequestCache = | "no-store" | "only-if-cached" | "reload"; -/** @category Fetch API */ +/** @category Fetch */ declare type RequestCredentials = "include" | "omit" | "same-origin"; -/** @category Fetch API */ +/** @category Fetch */ declare type RequestMode = "cors" | "navigate" | "no-cors" | "same-origin"; -/** @category Fetch API */ +/** @category Fetch */ declare type RequestRedirect = "error" | "follow" | "manual"; -/** @category Fetch API */ +/** @category Fetch */ declare type ReferrerPolicy = | "" | "no-referrer" @@ -152,7 +152,7 @@ declare type ReferrerPolicy = | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"; -/** @category Fetch API */ +/** @category Fetch */ declare type BodyInit = | Blob | BufferSource @@ -160,7 +160,7 @@ declare type BodyInit = | URLSearchParams | ReadableStream | string; -/** @category Fetch API */ +/** @category Fetch */ declare type RequestDestination = | "" | "audio" @@ -181,7 +181,7 @@ declare type RequestDestination = | "worker" | "xslt"; -/** @category Fetch API */ +/** @category Fetch */ declare interface RequestInit { /** * A BodyInit object or null to set request's body. @@ -248,7 +248,7 @@ declare interface RequestInit { /** This Fetch API interface represents a resource request. * - * @category Fetch API + * @category Fetch */ declare interface Request extends Body { /** @@ -338,21 +338,21 @@ declare interface Request extends Body { /** This Fetch API interface represents a resource request. * - * @category Fetch API + * @category Fetch */ declare var Request: { readonly prototype: Request; new (input: RequestInfo | URL, init?: RequestInit): Request; }; -/** @category Fetch API */ +/** @category Fetch */ declare interface ResponseInit { headers?: HeadersInit; status?: number; statusText?: string; } -/** @category Fetch API */ +/** @category Fetch */ declare type ResponseType = | "basic" | "cors" @@ -363,7 +363,7 @@ declare type ResponseType = /** This Fetch API interface represents the response to a request. * - * @category Fetch API + * @category Fetch */ declare interface Response extends Body { readonly headers: Headers; @@ -378,7 +378,7 @@ declare interface Response extends Body { /** This Fetch API interface represents the response to a request. * - * @category Fetch API + * @category Fetch */ declare var Response: { readonly prototype: Response; @@ -399,7 +399,7 @@ declare var Response: { * ``` * * @tags allow-net, allow-read - * @category Fetch API + * @category Fetch */ declare function fetch( input: URL | Request | string, @@ -407,14 +407,14 @@ declare function fetch( ): Promise; /** - * @category Fetch API + * @category Fetch */ declare interface EventSourceInit { withCredentials?: boolean; } /** - * @category Fetch API + * @category Fetch */ declare interface EventSourceEventMap { "error": Event; @@ -423,7 +423,7 @@ declare interface EventSourceEventMap { } /** - * @category Fetch API + * @category Fetch */ declare interface EventSource extends EventTarget { onerror: ((this: EventSource, ev: Event) => any) | null; @@ -481,7 +481,7 @@ declare interface EventSource extends EventTarget { } /** - * @category Fetch API + * @category Fetch */ declare var EventSource: { prototype: EventSource; diff --git a/ext/url/lib.deno_url.d.ts b/ext/url/lib.deno_url.d.ts index 0ade8c85a..ca5b00e60 100644 --- a/ext/url/lib.deno_url.d.ts +++ b/ext/url/lib.deno_url.d.ts @@ -5,7 +5,7 @@ /// /// -/** @category Web APIs */ +/** @category URL */ declare interface URLSearchParams { /** Appends a specified key/value pair as a new search parameter. * @@ -157,7 +157,7 @@ declare interface URLSearchParams { size: number; } -/** @category Web APIs */ +/** @category URL */ declare var URLSearchParams: { readonly prototype: URLSearchParams; new ( @@ -168,7 +168,7 @@ declare var URLSearchParams: { /** The URL interface represents an object providing static methods used for * creating object URLs. * - * @category Web APIs + * @category URL */ declare interface URL { hash: string; @@ -190,7 +190,7 @@ declare interface URL { /** The URL interface represents an object providing static methods used for * creating object URLs. * - * @category Web APIs + * @category URL */ declare var URL: { readonly prototype: URL; @@ -201,7 +201,7 @@ declare var URL: { revokeObjectURL(url: string): void; }; -/** @category Web APIs */ +/** @category URL */ declare interface URLPatternInit { protocol?: string; username?: string; @@ -214,10 +214,10 @@ declare interface URLPatternInit { baseURL?: string; } -/** @category Web APIs */ +/** @category URL */ declare type URLPatternInput = string | URLPatternInit; -/** @category Web APIs */ +/** @category URL */ declare interface URLPatternComponentResult { input: string; groups: Record; @@ -225,7 +225,7 @@ declare interface URLPatternComponentResult { /** `URLPatternResult` is the object returned from `URLPattern.exec`. * - * @category Web APIs + * @category URL */ declare interface URLPatternResult { /** The inputs provided when matching. */ @@ -277,7 +277,7 @@ declare interface URLPatternResult { * console.log(pattern.test("https://blog.example.com/article/123")); // true * ``` * - * @category Web APIs + * @category URL */ declare interface URLPattern { /** @@ -373,7 +373,7 @@ declare interface URLPattern { * console.log(pattern.test("https://blog.example.com/article/123")); // true * ``` * - * @category Web APIs + * @category URL */ declare var URLPattern: { readonly prototype: URLPattern; diff --git a/ext/web/lib.deno_web.d.ts b/ext/web/lib.deno_web.d.ts index 3ebc9af49..36c77ef81 100644 --- a/ext/web/lib.deno_web.d.ts +++ b/ext/web/lib.deno_web.d.ts @@ -5,7 +5,7 @@ /// /// -/** @category Web APIs */ +/** @category Platform */ declare interface DOMException extends Error { readonly name: string; readonly message: string; @@ -37,7 +37,7 @@ declare interface DOMException extends Error { readonly DATA_CLONE_ERR: 25; } -/** @category Web APIs */ +/** @category Platform */ declare var DOMException: { readonly prototype: DOMException; new (message?: string, name?: string): DOMException; @@ -68,7 +68,7 @@ declare var DOMException: { readonly DATA_CLONE_ERR: 25; }; -/** @category DOM Events */ +/** @category Events */ declare interface EventInit { bubbles?: boolean; cancelable?: boolean; @@ -77,7 +77,7 @@ declare interface EventInit { /** An event which takes place in the DOM. * - * @category DOM Events + * @category Events */ declare interface Event { /** Returns true or false depending on how event was initialized. True if @@ -138,7 +138,7 @@ declare interface Event { /** An event which takes place in the DOM. * - * @category DOM Events + * @category Events */ declare var Event: { readonly prototype: Event; @@ -153,7 +153,7 @@ declare var Event: { * EventTarget is a DOM interface implemented by objects that can receive events * and may have listeners for them. * - * @category DOM Events + * @category Events */ declare interface EventTarget { /** Appends an event listener for events whose type attribute value is type. @@ -201,41 +201,41 @@ declare interface EventTarget { * EventTarget is a DOM interface implemented by objects that can receive events * and may have listeners for them. * - * @category DOM Events + * @category Events */ declare var EventTarget: { readonly prototype: EventTarget; new (): EventTarget; }; -/** @category DOM Events */ +/** @category Events */ declare interface EventListener { (evt: Event): void | Promise; } -/** @category DOM Events */ +/** @category Events */ declare interface EventListenerObject { handleEvent(evt: Event): void | Promise; } -/** @category DOM Events */ +/** @category Events */ declare type EventListenerOrEventListenerObject = | EventListener | EventListenerObject; -/** @category DOM Events */ +/** @category Events */ declare interface AddEventListenerOptions extends EventListenerOptions { once?: boolean; passive?: boolean; signal?: AbortSignal; } -/** @category DOM Events */ +/** @category Events */ declare interface EventListenerOptions { capture?: boolean; } -/** @category DOM Events */ +/** @category Events */ declare interface ProgressEventInit extends EventInit { lengthComputable?: boolean; loaded?: number; @@ -246,7 +246,7 @@ declare interface ProgressEventInit extends EventInit { * (for an XMLHttpRequest, or the loading of the underlying resource of an * ,