diff options
Diffstat (limited to 'ext')
| -rw-r--r-- | ext/broadcast_channel/lib.deno_broadcast_channel.d.ts | 6 | ||||
| -rw-r--r-- | ext/cache/lib.deno_cache.d.ts | 12 | ||||
| -rw-r--r-- | ext/canvas/lib.deno_canvas.d.ts | 20 | ||||
| -rw-r--r-- | ext/console/lib.deno_console.d.ts | 2 | ||||
| -rw-r--r-- | ext/crypto/lib.deno_crypto.d.ts | 84 | ||||
| -rw-r--r-- | ext/fetch/lib.deno_fetch.d.ts | 56 | ||||
| -rw-r--r-- | ext/url/lib.deno_url.d.ts | 20 | ||||
| -rw-r--r-- | ext/web/lib.deno_web.d.ts | 226 | ||||
| -rw-r--r-- | ext/websocket/lib.deno_websocket.d.ts | 14 | ||||
| -rw-r--r-- | ext/webstorage/lib.deno_webstorage.d.ts | 4 |
10 files changed, 222 insertions, 222 deletions
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 @@ /// <reference lib="esnext" /> /** - * @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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @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<Cache>; @@ -18,7 +18,7 @@ declare interface CacheStorage { delete(cacheName: string): Promise<boolean>; } -/** @category Cache API */ +/** @category Cache */ declare interface Cache { /** * Put the provided request/response into the cache. @@ -52,19 +52,19 @@ declare interface Cache { ): Promise<boolean>; } -/** @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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @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<ImageBitmap>; -/** @category Web APIs */ +/** @category Canvas */ declare function createImageBitmap( image: ImageBitmapSource, sx: number, @@ -45,14 +45,14 @@ declare function createImageBitmap( options?: ImageBitmapOptions, ): Promise<ImageBitmap>; -/** @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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @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<CryptoKey>; } -/** @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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @category DOM APIs */ +/** @category Platform */ declare interface DomIterable<K, V> { keys(): IterableIterator<K>; values(): IterableIterator<V>; @@ -17,7 +17,7 @@ declare interface DomIterable<K, V> { ): 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<string, FormDataEntryValue> { append(name: string, value: string | Blob, fileName?: string): void; @@ -36,13 +36,13 @@ declare interface FormData extends DomIterable<string, FormDataEntryValue> { 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<Uint8Array> | null; @@ -72,7 +72,7 @@ declare interface Body { text(): Promise<string>; } -/** @category Fetch API */ +/** @category Fetch */ declare type HeadersInit = Iterable<string[]> | Record<string, string>; /** This Fetch API interface allows you to perform various actions on HTTP @@ -83,7 +83,7 @@ declare type HeadersInit = Iterable<string[]> | Record<string, string>; * methods of this interface, header names are matched by case-insensitive byte * sequence. * - * @category Fetch API + * @category Fetch */ declare interface Headers extends DomIterable<string, string> { /** Appends a new value onto an existing header inside a `Headers` object, or @@ -118,16 +118,16 @@ declare interface Headers extends DomIterable<string, string> { * 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<Uint8Array> | 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<Response>; /** - * @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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @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<string, string | undefined>; @@ -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 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @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<void>; } -/** @category DOM Events */ +/** @category Events */ declare interface EventListenerObject { handleEvent(evt: Event): void | Promise<void>; } -/** @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 * <img>, <audio>, <video>, <style> or <link>). * - * @category DOM Events + * @category Events */ declare interface ProgressEvent<T extends EventTarget = EventTarget> extends Event { @@ -260,7 +260,7 @@ declare interface ProgressEvent<T extends EventTarget = EventTarget> * (for an XMLHttpRequest, or the loading of the underlying resource of an * <img>, <audio>, <video>, <style> or <link>). * - * @category DOM Events + * @category Events */ declare var ProgressEvent: { readonly prototype: ProgressEvent; @@ -273,7 +273,7 @@ declare var ProgressEvent: { * console.log(atob("aGVsbG8gd29ybGQ=")); // outputs 'hello world' * ``` * - * @category Encoding API + * @category Encoding */ declare function atob(s: string): string; @@ -283,22 +283,22 @@ declare function atob(s: string): string; * console.log(btoa("hello world")); // outputs "aGVsbG8gd29ybGQ=" * ``` * - * @category Encoding API + * @category Encoding */ declare function btoa(s: string): string; -/** @category Encoding API */ +/** @category Encoding */ declare interface TextDecoderOptions { fatal?: boolean; ignoreBOM?: boolean; } -/** @category Encoding API */ +/** @category Encoding */ declare interface TextDecodeOptions { stream?: boolean; } -/** @category Encoding API */ +/** @category Encoding */ declare interface TextDecoder { /** Returns encoding's name, lowercased. */ readonly encoding: string; @@ -311,19 +311,19 @@ declare interface TextDecoder { decode(input?: BufferSource, options?: TextDecodeOptions): string; } -/** @category Encoding API */ +/** @category Encoding */ declare var TextDecoder: { readonly prototype: TextDecoder; new (label?: string, options?: TextDecoderOptions): TextDecoder; }; -/** @category Encoding API */ +/** @category Encoding */ declare interface TextEncoderEncodeIntoResult { read: number; written: number; } -/** @category Encoding API */ +/** @category Encoding */ declare interface TextEncoder { /** Returns "utf-8". */ readonly encoding: "utf-8"; @@ -332,13 +332,13 @@ declare interface TextEncoder { encodeInto(input: string, dest: Uint8Array): TextEncoderEncodeIntoResult; } -/** @category Encoding API */ +/** @category Encoding */ declare var TextEncoder: { readonly prototype: TextEncoder; new (): TextEncoder; }; -/** @category Encoding API */ +/** @category Encoding */ declare interface TextDecoderStream { /** Returns encoding's name, lowercased. */ readonly encoding: string; @@ -351,13 +351,13 @@ declare interface TextDecoderStream { readonly [Symbol.toStringTag]: string; } -/** @category Encoding API */ +/** @category Encoding */ declare var TextDecoderStream: { readonly prototype: TextDecoderStream; new (label?: string, options?: TextDecoderOptions): TextDecoderStream; }; -/** @category Encoding API */ +/** @category Encoding */ declare interface TextEncoderStream { /** Returns "utf-8". */ readonly encoding: "utf-8"; @@ -366,7 +366,7 @@ declare interface TextEncoderStream { readonly [Symbol.toStringTag]: string; } -/** @category Encoding API */ +/** @category Encoding */ declare var TextEncoderStream: { readonly prototype: TextEncoderStream; new (): TextEncoderStream; @@ -375,7 +375,7 @@ declare var TextEncoderStream: { /** A controller object that allows you to abort one or more DOM requests as and * when desired. * - * @category Web APIs + * @category Platform */ declare interface AbortController { /** Returns the AbortSignal object associated with this object. */ @@ -388,14 +388,14 @@ declare interface AbortController { /** A controller object that allows you to abort one or more DOM requests as and * when desired. * - * @category Web APIs + * @category Platform */ declare var AbortController: { readonly prototype: AbortController; new (): AbortController; }; -/** @category Web APIs */ +/** @category Platform */ declare interface AbortSignalEventMap { abort: Event; } @@ -403,7 +403,7 @@ declare interface AbortSignalEventMap { /** A signal object that allows you to communicate with a DOM request (such as a * Fetch) and abort it if required via an AbortController object. * - * @category Web APIs + * @category Platform */ declare interface AbortSignal extends EventTarget { /** Returns true if this AbortSignal's AbortController has signaled to abort, @@ -437,7 +437,7 @@ declare interface AbortSignal extends EventTarget { throwIfAborted(): void; } -/** @category Web APIs */ +/** @category Platform */ declare var AbortSignal: { readonly prototype: AbortSignal; new (): never; @@ -446,7 +446,7 @@ declare var AbortSignal: { timeout(milliseconds: number): AbortSignal; }; -/** @category Web File API */ +/** @category File */ declare interface FileReaderEventMap { "abort": ProgressEvent<FileReader>; "error": ProgressEvent<FileReader>; @@ -460,7 +460,7 @@ declare interface FileReaderEventMap { * buffers) stored on the user's computer, using File or Blob objects to specify * the file or data to read. * - * @category Web File API + * @category File */ declare interface FileReader extends EventTarget { readonly error: DOMException | null; @@ -504,7 +504,7 @@ declare interface FileReader extends EventTarget { ): void; } -/** @category Web File API */ +/** @category File */ declare var FileReader: { readonly prototype: FileReader; new (): FileReader; @@ -513,10 +513,10 @@ declare var FileReader: { readonly LOADING: number; }; -/** @category Web File API */ +/** @category File */ declare type BlobPart = BufferSource | Blob | string; -/** @category Web File API */ +/** @category File */ declare interface BlobPropertyBag { type?: string; endings?: "transparent" | "native"; @@ -527,7 +527,7 @@ declare interface BlobPropertyBag { * Blob, inheriting blob functionality and expanding it to support files on the * user's system. * - * @category Web File API + * @category File */ declare interface Blob { readonly size: number; @@ -543,14 +543,14 @@ declare interface Blob { * Blob, inheriting blob functionality and expanding it to support files on the * user's system. * - * @category Web File API + * @category File */ declare var Blob: { readonly prototype: Blob; new (blobParts?: BlobPart[], options?: BlobPropertyBag): Blob; }; -/** @category Web File API */ +/** @category File */ declare interface FilePropertyBag extends BlobPropertyBag { lastModified?: number; } @@ -558,7 +558,7 @@ declare interface FilePropertyBag extends BlobPropertyBag { /** Provides information about files and allows JavaScript in a web page to * access their content. * - * @category Web File API + * @category File */ declare interface File extends Blob { readonly lastModified: number; @@ -568,31 +568,31 @@ declare interface File extends Blob { /** Provides information about files and allows JavaScript in a web page to * access their content. * - * @category Web File API + * @category File */ declare var File: { readonly prototype: File; new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag): File; }; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamDefaultReadDoneResult { done: true; value?: undefined; } -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamDefaultReadValueResult<T> { done: false; value: T; } -/** @category Streams API */ +/** @category Streams */ declare type ReadableStreamDefaultReadResult<T> = | ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadDoneResult; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamDefaultReader<R = any> { readonly closed: Promise<void>; cancel(reason?: any): Promise<void>; @@ -600,35 +600,35 @@ declare interface ReadableStreamDefaultReader<R = any> { releaseLock(): void; } -/** @category Streams API */ +/** @category Streams */ declare var ReadableStreamDefaultReader: { readonly prototype: ReadableStreamDefaultReader; new <R>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>; }; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamBYOBReadDoneResult<V extends ArrayBufferView> { done: true; value?: V; } -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamBYOBReadValueResult<V extends ArrayBufferView> { done: false; value: V; } -/** @category Streams API */ +/** @category Streams */ declare type ReadableStreamBYOBReadResult<V extends ArrayBufferView> = | ReadableStreamBYOBReadDoneResult<V> | ReadableStreamBYOBReadValueResult<V>; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamBYOBReaderReadOptions { min?: number; } -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamBYOBReader { readonly closed: Promise<void>; cancel(reason?: any): Promise<void>; @@ -639,31 +639,31 @@ declare interface ReadableStreamBYOBReader { releaseLock(): void; } -/** @category Streams API */ +/** @category Streams */ declare var ReadableStreamBYOBReader: { readonly prototype: ReadableStreamBYOBReader; new (stream: ReadableStream<Uint8Array>): ReadableStreamBYOBReader; }; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamBYOBRequest { readonly view: ArrayBufferView | null; respond(bytesWritten: number): void; respondWithNewView(view: ArrayBufferView): void; } -/** @category Streams API */ +/** @category Streams */ declare var ReadableStreamBYOBRequest: { readonly prototype: ReadableStreamBYOBRequest; new (): never; }; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableByteStreamControllerCallback { (controller: ReadableByteStreamController): void | PromiseLike<void>; } -/** @category Streams API */ +/** @category Streams */ declare interface UnderlyingByteSource { autoAllocateChunkSize?: number; cancel?: ReadableStreamErrorCallback; @@ -672,7 +672,7 @@ declare interface UnderlyingByteSource { type: "bytes"; } -/** @category Streams API */ +/** @category Streams */ declare interface UnderlyingSink<W = any> { abort?: WritableStreamErrorCallback; close?: WritableStreamDefaultControllerCloseCallback; @@ -681,7 +681,7 @@ declare interface UnderlyingSink<W = any> { write?: WritableStreamDefaultControllerWriteCallback<W>; } -/** @category Streams API */ +/** @category Streams */ declare interface UnderlyingSource<R = any> { cancel?: ReadableStreamErrorCallback; pull?: ReadableStreamDefaultControllerCallback<R>; @@ -689,17 +689,17 @@ declare interface UnderlyingSource<R = any> { type?: undefined; } -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamErrorCallback { (reason: any): void | PromiseLike<void>; } -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamDefaultControllerCallback<R> { (controller: ReadableStreamDefaultController<R>): void | PromiseLike<void>; } -/** @category Streams API */ +/** @category Streams */ declare interface ReadableStreamDefaultController<R = any> { readonly desiredSize: number | null; close(): void; @@ -707,13 +707,13 @@ declare interface ReadableStreamDefaultController<R = any> { error(error?: any): void; } -/** @category Streams API */ +/** @category Streams */ declare var ReadableStreamDefaultController: { readonly prototype: ReadableStreamDefaultController; new (): never; }; -/** @category Streams API */ +/** @category Streams */ declare interface ReadableByteStreamController { readonly byobRequest: ReadableStreamBYOBRequest | null; readonly desiredSize: number | null; @@ -722,13 +722,13 @@ declare interface ReadableByteStreamController { error(error?: any): void; } -/** @category Streams API */ +/** @category Streams */ declare var ReadableByteStreamController: { readonly prototype: ReadableByteStreamController; new (): never; }; -/** @category Streams API */ +/** @category Streams */ declare interface PipeOptions { preventAbort?: boolean; preventCancel?: boolean; @@ -736,12 +736,12 @@ declare interface PipeOptions { signal?: AbortSignal; } -/** @category Streams API */ +/** @category Streams */ declare interface QueuingStrategySizeCallback<T = any> { (chunk: T): number; } -/** @category Streams API */ +/** @category Streams */ declare interface QueuingStrategy<T = any> { highWaterMark?: number; size?: QueuingStrategySizeCallback<T>; @@ -750,27 +750,27 @@ declare interface QueuingStrategy<T = any> { /** This Streams API interface provides a built-in byte length queuing strategy * that can be used when constructing streams. * - * @category Streams API + * @category Streams */ declare interface CountQueuingStrategy extends QueuingStrategy { highWaterMark: number; size(chunk: any): 1; } -/** @category Streams API */ +/** @category Streams */ declare var CountQueuingStrategy: { readonly prototype: CountQueuingStrategy; new (options: { highWaterMark: number }): CountQueuingStrategy; }; -/** @category Streams API */ +/** @category Streams */ declare interface ByteLengthQueuingStrategy extends QueuingStrategy<ArrayBufferView> { highWaterMark: number; size(chunk: ArrayBufferView): number; } -/** @category Streams API */ +/** @category Streams */ declare var ByteLengthQueuingStrategy: { readonly prototype: ByteLengthQueuingStrategy; new (options: { highWaterMark: number }): ByteLengthQueuingStrategy; @@ -780,7 +780,7 @@ declare var ByteLengthQueuingStrategy: { * Fetch API offers a concrete instance of a ReadableStream through the body * property of a Response object. * - * @category Streams API + * @category Streams */ declare interface ReadableStream<R = any> { readonly locked: boolean; @@ -801,7 +801,7 @@ declare interface ReadableStream<R = any> { }): AsyncIterableIterator<R>; } -/** @category Streams API */ +/** @category Streams */ declare var ReadableStream: { readonly prototype: ReadableStream; new ( @@ -817,17 +817,17 @@ declare var ReadableStream: { ): ReadableStream<R>; }; -/** @category Streams API */ +/** @category Streams */ declare interface WritableStreamDefaultControllerCloseCallback { (): void | PromiseLike<void>; } -/** @category Streams API */ +/** @category Streams */ declare interface WritableStreamDefaultControllerStartCallback { (controller: WritableStreamDefaultController): void | PromiseLike<void>; } -/** @category Streams API */ +/** @category Streams */ declare interface WritableStreamDefaultControllerWriteCallback<W> { (chunk: W, controller: WritableStreamDefaultController): | void @@ -836,7 +836,7 @@ declare interface WritableStreamDefaultControllerWriteCallback<W> { >; } -/** @category Streams API */ +/** @category Streams */ declare interface WritableStreamErrorCallback { (reason: any): void | PromiseLike<void>; } @@ -845,7 +845,7 @@ declare interface WritableStreamErrorCallback { * streaming data to a destination, known as a sink. This object comes with * built-in backpressure and queuing. * - * @category Streams API + * @category Streams */ declare interface WritableStream<W = any> { readonly locked: boolean; @@ -854,7 +854,7 @@ declare interface WritableStream<W = any> { getWriter(): WritableStreamDefaultWriter<W>; } -/** @category Streams API */ +/** @category Streams */ declare var WritableStream: { readonly prototype: WritableStream; new <W = any>( @@ -868,14 +868,14 @@ declare var WritableStream: { * sink is given a corresponding WritableStreamDefaultController instance to * manipulate. * - * @category Streams API + * @category Streams */ declare interface WritableStreamDefaultController { signal: AbortSignal; error(error?: any): void; } -/** @category Streams API */ +/** @category Streams */ declare var WritableStreamDefaultController: { readonly prototype: WritableStreamDefaultController; new (): never; @@ -886,7 +886,7 @@ declare var WritableStreamDefaultController: { * WritableStream ensuring that no other streams can write to the underlying * sink. * - * @category Streams API + * @category Streams */ declare interface WritableStreamDefaultWriter<W = any> { readonly closed: Promise<void>; @@ -898,19 +898,19 @@ declare interface WritableStreamDefaultWriter<W = any> { write(chunk: W): Promise<void>; } -/** @category Streams API */ +/** @category Streams */ declare var WritableStreamDefaultWriter: { readonly prototype: WritableStreamDefaultWriter; new <W>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>; }; -/** @category Streams API */ +/** @category Streams */ declare interface TransformStream<I = any, O = any> { readonly readable: ReadableStream<O>; readonly writable: WritableStream<I>; } -/** @category Streams API */ +/** @category Streams */ declare var TransformStream: { readonly prototype: TransformStream; new <I = any, O = any>( @@ -920,7 +920,7 @@ declare var TransformStream: { ): TransformStream<I, O>; }; -/** @category Streams API */ +/** @category Streams */ declare interface TransformStreamDefaultController<O = any> { readonly desiredSize: number | null; enqueue(chunk: O): void; @@ -928,13 +928,13 @@ declare interface TransformStreamDefaultController<O = any> { terminate(): void; } -/** @category Streams API */ +/** @category Streams */ declare var TransformStreamDefaultController: { readonly prototype: TransformStreamDefaultController; new (): never; }; -/** @category Streams API */ +/** @category Streams */ declare interface Transformer<I = any, O = any> { flush?: TransformStreamDefaultControllerCallback<O>; readableType?: undefined; @@ -944,12 +944,12 @@ declare interface Transformer<I = any, O = any> { writableType?: undefined; } -/** @category Streams API */ +/** @category Streams */ declare interface TransformStreamDefaultControllerCallback<O> { (controller: TransformStreamDefaultController<O>): void | PromiseLike<void>; } -/** @category Streams API */ +/** @category Streams */ declare interface TransformStreamDefaultControllerTransformCallback<I, O> { ( chunk: I, @@ -957,14 +957,14 @@ declare interface TransformStreamDefaultControllerTransformCallback<I, O> { ): void | PromiseLike<void>; } -/** @category DOM APIs */ +/** @category Events */ declare interface MessageEventInit<T = any> extends EventInit { data?: T; origin?: string; lastEventId?: string; } -/** @category DOM APIs */ +/** @category Events */ declare interface MessageEvent<T = any> extends Event { /** * Returns the data of the message. @@ -985,13 +985,13 @@ declare interface MessageEvent<T = any> extends Event { readonly ports: ReadonlyArray<MessagePort>; } -/** @category DOM APIs */ +/** @category Events */ declare var MessageEvent: { readonly prototype: MessageEvent; new <T>(type: string, eventInitDict?: MessageEventInit<T>): MessageEvent<T>; }; -/** @category DOM APIs */ +/** @category Events */ declare type Transferable = ArrayBuffer | MessagePort; /** @@ -999,11 +999,11 @@ declare type Transferable = ArrayBuffer | MessagePort; * new code. * * @deprecated use `StructuredSerializeOptions` instead. - * @category DOM APIs + * @category Events */ declare type PostMessageOptions = StructuredSerializeOptions; -/** @category DOM APIs */ +/** @category Platform */ declare interface StructuredSerializeOptions { transfer?: Transferable[]; } @@ -1012,7 +1012,7 @@ declare interface StructuredSerializeOptions { * create a new message channel and send data through it via its two MessagePort * properties. * - * @category DOM APIs + * @category Messaging */ declare interface MessageChannel { readonly port1: MessagePort; @@ -1023,14 +1023,14 @@ declare interface MessageChannel { * create a new message channel and send data through it via its two MessagePort * properties. * - * @category DOM APIs + * @category Messaging */ declare var MessageChannel: { readonly prototype: MessageChannel; new (): MessageChannel; }; -/** @category DOM APIs */ +/** @category Messaging */ declare interface MessagePortEventMap { "message": MessageEvent; "messageerror": MessageEvent; @@ -1040,7 +1040,7 @@ declare interface MessagePortEventMap { * two ports of a MessageChannel, allowing messages to be sent from one port and * listening out for them arriving at the other. * - * @category DOM APIs + * @category Messaging */ declare interface MessagePort extends EventTarget { onmessage: ((this: MessagePort, ev: MessageEvent) => any) | null; @@ -1090,7 +1090,7 @@ declare interface MessagePort extends EventTarget { * two ports of a MessageChannel, allowing messages to be sent from one port and * listening out for them arriving at the other. * - * @category DOM APIs + * @category Messaging */ declare var MessagePort: { readonly prototype: MessagePort; @@ -1122,7 +1122,7 @@ declare var MessagePort: { * console.log(shallowCopy.x, object.x); // 1 1 * ``` * - * @category DOM APIs + * @category Platform */ declare function structuredClone<T = any>( value: T, @@ -1139,7 +1139,7 @@ declare function structuredClone<T = any>( * .pipeTo(Deno.stdout.writable); * ``` * - * @category Compression Streams API + * @category Streams */ declare interface CompressionStream { readonly readable: ReadableStream<Uint8Array>; @@ -1156,7 +1156,7 @@ declare interface CompressionStream { * .pipeTo(Deno.stdout.writable); * ``` * - * @category Compression Streams API + * @category Streams */ declare var CompressionStream: { readonly prototype: CompressionStream; @@ -1183,7 +1183,7 @@ declare var CompressionStream: { * .pipeTo(output.writable); * ``` * - * @category Compression Streams API + * @category Streams */ declare interface DecompressionStream { readonly readable: ReadableStream<Uint8Array>; @@ -1203,7 +1203,7 @@ declare interface DecompressionStream { * .pipeTo(output.writable); * ``` * - * @category Compression Streams API + * @category Streams */ declare var DecompressionStream: { readonly prototype: DecompressionStream; @@ -1232,21 +1232,21 @@ declare var DecompressionStream: { * ``` * In Deno, this error will terminate the process if not intercepted like above. * - * @category Web APIs + * @category Platform */ declare function reportError( error: any, ): void; -/** @category Web APIs */ +/** @category Platform */ declare type PredefinedColorSpace = "srgb" | "display-p3"; -/** @category Web APIs */ +/** @category Platform */ declare interface ImageDataSettings { readonly colorSpace?: PredefinedColorSpace; } -/** @category Web APIs */ +/** @category Platform */ declare interface ImageData { readonly colorSpace: PredefinedColorSpace; readonly data: Uint8ClampedArray; @@ -1254,7 +1254,7 @@ declare interface ImageData { readonly width: number; } -/** @category Web APIs */ +/** @category Platform */ declare var ImageData: { prototype: ImageData; new (sw: number, sh: number, settings?: ImageDataSettings): ImageData; diff --git a/ext/websocket/lib.deno_websocket.d.ts b/ext/websocket/lib.deno_websocket.d.ts index 311bf2b24..c1bdf3542 100644 --- a/ext/websocket/lib.deno_websocket.d.ts +++ b/ext/websocket/lib.deno_websocket.d.ts @@ -5,14 +5,14 @@ /// <reference no-default-lib="true" /> /// <reference lib="esnext" /> -/** @category Web Sockets */ +/** @category WebSockets */ declare interface CloseEventInit extends EventInit { code?: number; reason?: string; wasClean?: boolean; } -/** @category Web Sockets */ +/** @category WebSockets */ declare interface CloseEvent extends Event { /** * Returns the WebSocket connection close code provided by the server. @@ -28,13 +28,13 @@ declare interface CloseEvent extends Event { readonly wasClean: boolean; } -/** @category Web Sockets */ +/** @category WebSockets */ declare var CloseEvent: { readonly prototype: CloseEvent; new (type: string, eventInitDict?: CloseEventInit): CloseEvent; }; -/** @category Web Sockets */ +/** @category WebSockets */ declare interface WebSocketEventMap { close: CloseEvent; error: Event; @@ -50,7 +50,7 @@ declare interface WebSocketEventMap { * `Deno.upgradeWebSocket()`. * * @tags allow-net - * @category Web Sockets + * @category WebSockets */ declare interface WebSocket extends EventTarget { /** @@ -119,7 +119,7 @@ declare interface WebSocket extends EventTarget { ): void; } -/** @category Web Sockets */ +/** @category WebSockets */ declare var WebSocket: { readonly prototype: WebSocket; new (url: string | URL, protocols?: string | string[]): WebSocket; @@ -129,5 +129,5 @@ declare var WebSocket: { readonly OPEN: number; }; -/** @category Web Sockets */ +/** @category WebSockets */ declare type BinaryType = "arraybuffer" | "blob"; diff --git a/ext/webstorage/lib.deno_webstorage.d.ts b/ext/webstorage/lib.deno_webstorage.d.ts index d3a65c47a..a3a4d6cd1 100644 --- a/ext/webstorage/lib.deno_webstorage.d.ts +++ b/ext/webstorage/lib.deno_webstorage.d.ts @@ -9,7 +9,7 @@ * session or local storage. It allows, for example, the addition, modification, * or deletion of stored data items. * - * @category Web Storage API + * @category Storage */ declare interface Storage { /** @@ -41,7 +41,7 @@ declare interface Storage { [name: string]: any; } -/** @category Web Storage API */ +/** @category Storage */ declare var Storage: { readonly prototype: Storage; new (): never; |