From a69b4646a02dc49a9222cd50c49d3e194f320ff2 Mon Sep 17 00:00:00 2001 From: Jo Franchetti Date: Mon, 6 May 2024 02:56:55 +0100 Subject: [PATCH] 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 --- cli/tsc/dts/lib.deno.ns.d.ts | 74 ++--- cli/tsc/dts/lib.deno.shared_globals.d.ts | 108 +++---- cli/tsc/dts/lib.deno.unstable.d.ts | 94 +++--- cli/tsc/dts/lib.deno.window.d.ts | 58 ++-- cli/tsc/dts/lib.deno.worker.d.ts | 50 ++-- cli/tsc/dts/lib.deno_webgpu.d.ts | 268 +++++++++--------- .../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 +- tests/integration/lsp_tests.rs | 4 +- 17 files changed, 550 insertions(+), 550 deletions(-) diff --git a/cli/tsc/dts/lib.deno.ns.d.ts b/cli/tsc/dts/lib.deno.ns.d.ts index f9b61dc66f..c940a6e615 100644 --- a/cli/tsc/dts/lib.deno.ns.d.ts +++ b/cli/tsc/dts/lib.deno.ns.d.ts @@ -8,7 +8,7 @@ * to ensure that these are still available when using the Deno namespace in * conjunction with other type libs, like `dom`. * - * @category ES Modules + * @category Platform */ declare interface ImportMeta { /** A string representation of the fully qualified module URL. When the @@ -322,7 +322,7 @@ declare namespace Deno { * console.log(Deno.pid); * ``` * - * @category Runtime Environment + * @category Runtime */ export const pid: number; @@ -333,11 +333,11 @@ declare namespace Deno { * console.log(Deno.ppid); * ``` * - * @category Runtime Environment + * @category Runtime */ export const ppid: number; - /** @category Runtime Environment */ + /** @category Runtime */ export interface MemoryUsage { /** The number of bytes of the current Deno's process resident set size, * which is the amount of memory occupied in main memory (RAM). */ @@ -355,7 +355,7 @@ declare namespace Deno { * Returns an object describing the memory usage of the Deno process and the * V8 subsystem measured in bytes. * - * @category Runtime Environment + * @category Runtime */ export function memoryUsage(): MemoryUsage; @@ -369,7 +369,7 @@ declare namespace Deno { * Requires `allow-sys` permission. * * @tags allow-sys - * @category Runtime Environment + * @category Runtime */ export function hostname(): string; @@ -389,7 +389,7 @@ declare namespace Deno { * On Windows there is no API available to retrieve this information and this method returns `[ 0, 0, 0 ]`. * * @tags allow-sys - * @category Observability + * @category Runtime */ export function loadavg(): number[]; @@ -443,14 +443,14 @@ declare namespace Deno { * Requires `allow-sys` permission. * * @tags allow-sys - * @category Runtime Environment + * @category Runtime */ export function systemMemoryInfo(): SystemMemoryInfo; /** * Information returned from a call to {@linkcode Deno.systemMemoryInfo}. * - * @category Runtime Environment + * @category Runtime */ export interface SystemMemoryInfo { /** Total installed memory in bytes. */ @@ -481,7 +481,7 @@ declare namespace Deno { * * See: https://no-color.org/ * - * @category Runtime Environment + * @category Runtime */ export const noColor: boolean; @@ -497,7 +497,7 @@ declare namespace Deno { * it should depend sys-info, which may not be desirable. * * @tags allow-sys - * @category Runtime Environment + * @category Runtime */ export function osRelease(): string; @@ -511,7 +511,7 @@ declare namespace Deno { * Requires `allow-sys` permission. * * @tags allow-sys - * @category Runtime Environment + * @category Runtime */ export function osUptime(): number; @@ -1462,7 +1462,7 @@ declare namespace Deno { * Deno.exit(5); * ``` * - * @category Runtime Environment + * @category Runtime */ export function exit(code?: number): never; @@ -1470,7 +1470,7 @@ declare namespace Deno { * variables. * * @tags allow-env - * @category Runtime Environment + * @category Runtime */ export interface Env { /** Retrieve the value of an environment variable. @@ -1549,7 +1549,7 @@ declare namespace Deno { * variables. * * @tags allow-env - * @category Runtime Environment + * @category Runtime */ export const env: Env; @@ -1563,7 +1563,7 @@ declare namespace Deno { * Requires `allow-read` permission. * * @tags allow-read - * @category Runtime Environment + * @category Runtime */ export function execPath(): string; @@ -1584,7 +1584,7 @@ declare namespace Deno { * Requires `allow-read` permission. * * @tags allow-read - * @category Runtime Environment + * @category Runtime */ export function chdir(directory: string | URL): void; @@ -1603,7 +1603,7 @@ declare namespace Deno { * Requires `allow-read` permission. * * @tags allow-read - * @category Runtime Environment + * @category Runtime */ export function cwd(): string; @@ -4033,7 +4033,7 @@ declare namespace Deno { */ export function truncateSync(name: string, len?: number): void; - /** @category Observability + /** @category Runtime * * @deprecated This will be removed in Deno 2.0. */ @@ -4051,7 +4051,7 @@ declare namespace Deno { bytesReceived: number; } - /** @category Observability + /** @category Runtime * * @deprecated This will be removed in Deno 2.0. */ @@ -4082,7 +4082,7 @@ declare namespace Deno { * └─────────────────────────┴────────┘ * ``` * - * @category Observability + * @category Runtime * * @deprecated This will be removed in Deno 2.0. */ @@ -4094,7 +4094,7 @@ declare namespace Deno { * * @deprecated This will be removed in Deno 2.0. * - * @category Observability */ + * @category Runtime */ export interface ResourceMap { [rid: number]: unknown; } @@ -4114,7 +4114,7 @@ declare namespace Deno { * * @deprecated This will be removed in Deno 2.0. * - * @category Observability + * @category Runtime */ export function resources(): ResourceMap; @@ -4392,7 +4392,7 @@ declare namespace Deno { /** Operating signals which can be listened for or sent to sub-processes. What * signals and what their standard behaviors are OS dependent. * - * @category Runtime Environment */ + * @category Runtime */ export type Signal = | "SIGABRT" | "SIGALRM" @@ -4443,7 +4443,7 @@ declare namespace Deno { * _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break) * are supported. * - * @category Runtime Environment + * @category Runtime */ export function addSignalListener(signal: Signal, handler: () => void): void; @@ -4461,7 +4461,7 @@ declare namespace Deno { * _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break) * are supported. * - * @category Runtime Environment + * @category Runtime */ export function removeSignalListener( signal: Signal, @@ -4745,7 +4745,7 @@ declare namespace Deno { /** Option which can be specified when performing {@linkcode Deno.inspect}. * - * @category Console and Debugging */ + * @category I/O */ export interface InspectOptions { /** Stylize output with ANSI colors. * @@ -4831,7 +4831,7 @@ declare namespace Deno { * Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } } * ``` * - * @category Console and Debugging + * @category I/O */ export function inspect(value: unknown, options?: InspectOptions): string; @@ -5241,7 +5241,7 @@ declare namespace Deno { * * The intended use for the information is for logging and debugging purposes. * - * @category Runtime Environment + * @category Runtime */ export const build: { /** The [LLVM](https://llvm.org/) target triple, which is the combination @@ -5277,7 +5277,7 @@ declare namespace Deno { * * The intended use for the information is for logging and debugging purposes. * - * @category Runtime Environment + * @category Runtime */ export const version: { /** Deno CLI's version. For example: `"1.26.0"`. */ @@ -5312,7 +5312,7 @@ declare namespace Deno { * [`parseArgs()`](https://jsr.io/@std/cli/doc/parse-args/~/parseArgs) from * the Deno Standard Library. * - * @category Runtime Environment + * @category Runtime */ export const args: string[]; @@ -5325,7 +5325,7 @@ declare namespace Deno { * {@link https://docs.deno.com/runtime/manual/advanced/migrate_deprecations | Deno 1.x to 2.x Migration Guide} * for migration instructions. * - * @category Console and Debugging + * @category I/O */ export const customInspect: unique symbol; @@ -5335,7 +5335,7 @@ declare namespace Deno { * Also see {@linkcode ImportMeta} for other related information. * * @tags allow-read - * @category Runtime Environment + * @category Runtime */ export const mainModule: string; @@ -6178,14 +6178,14 @@ declare namespace Deno { /** * Make the timer of the given `id` block the event loop from finishing. * - * @category Timers + * @category Runtime */ export function refTimer(id: number): void; /** * Make the timer of the given `id` not block the event loop from finishing. * - * @category Timers + * @category Runtime */ export function unrefTimer(id: number): void; @@ -6199,7 +6199,7 @@ declare namespace Deno { * Requires `allow-sys` permission. * * @tags allow-sys - * @category Runtime Environment + * @category Runtime */ export function uid(): number | null; @@ -6213,7 +6213,7 @@ declare namespace Deno { * Requires `allow-sys` permission. * * @tags allow-sys - * @category Runtime Environment + * @category Runtime */ export function gid(): number | null; diff --git a/cli/tsc/dts/lib.deno.shared_globals.d.ts b/cli/tsc/dts/lib.deno.shared_globals.d.ts index ca6b419f38..1521cf12de 100644 --- a/cli/tsc/dts/lib.deno.shared_globals.d.ts +++ b/cli/tsc/dts/lib.deno.shared_globals.d.ts @@ -14,14 +14,14 @@ /// /// -/** @category WebAssembly */ +/** @category WASM */ declare namespace WebAssembly { /** * The `WebAssembly.CompileError` object indicates an error during WebAssembly decoding or validation. * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/CompileError) * - * @category WebAssembly + * @category WASM */ export class CompileError extends Error { /** Creates a new `WebAssembly.CompileError` object. */ @@ -35,7 +35,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Global) * - * @category WebAssembly + * @category WASM */ export class Global { /** Creates a new `Global` object. */ @@ -58,7 +58,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Instance) * - * @category WebAssembly + * @category WASM */ export class Instance { /** Creates a new Instance object. */ @@ -78,7 +78,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/LinkError) * - * @category WebAssembly + * @category WASM */ export class LinkError extends Error { /** Creates a new WebAssembly.LinkError object. */ @@ -94,7 +94,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Memory) * - * @category WebAssembly + * @category WASM */ export class Memory { /** Creates a new `Memory` object. */ @@ -116,7 +116,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module) * - * @category WebAssembly + * @category WASM */ export class Module { /** Creates a new `Module` object. */ @@ -144,7 +144,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/RuntimeError) * - * @category WebAssembly + * @category WASM */ export class RuntimeError extends Error { /** Creates a new `WebAssembly.RuntimeError` object. */ @@ -159,7 +159,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Table) * - * @category WebAssembly + * @category WASM */ export class Table { /** Creates a new `Table` object. */ @@ -181,7 +181,7 @@ declare namespace WebAssembly { /** The `GlobalDescriptor` describes the options you can pass to * `new WebAssembly.Global()`. * - * @category WebAssembly + * @category WASM */ export interface GlobalDescriptor { mutable?: boolean; @@ -191,7 +191,7 @@ declare namespace WebAssembly { /** The `MemoryDescriptor` describes the options you can pass to * `new WebAssembly.Memory()`. * - * @category WebAssembly + * @category WASM */ export interface MemoryDescriptor { initial: number; @@ -202,7 +202,7 @@ declare namespace WebAssembly { /** A `ModuleExportDescriptor` is the description of a declared export in a * `WebAssembly.Module`. * - * @category WebAssembly + * @category WASM */ export interface ModuleExportDescriptor { kind: ImportExportKind; @@ -212,7 +212,7 @@ declare namespace WebAssembly { /** A `ModuleImportDescriptor` is the description of a declared import in a * `WebAssembly.Module`. * - * @category WebAssembly + * @category WASM */ export interface ModuleImportDescriptor { kind: ImportExportKind; @@ -223,7 +223,7 @@ declare namespace WebAssembly { /** The `TableDescriptor` describes the options you can pass to * `new WebAssembly.Table()`. * - * @category WebAssembly + * @category WASM */ export interface TableDescriptor { element: TableKind; @@ -233,7 +233,7 @@ declare namespace WebAssembly { /** The value returned from `WebAssembly.instantiate`. * - * @category WebAssembly + * @category WASM */ export interface WebAssemblyInstantiatedSource { /* A `WebAssembly.Instance` object that contains all the exported WebAssembly functions. */ @@ -246,21 +246,21 @@ declare namespace WebAssembly { module: Module; } - /** @category WebAssembly */ + /** @category WASM */ export type ImportExportKind = "function" | "global" | "memory" | "table"; - /** @category WebAssembly */ + /** @category WASM */ export type TableKind = "anyfunc"; - /** @category WebAssembly */ + /** @category WASM */ export type ValueType = "f32" | "f64" | "i32" | "i64"; - /** @category WebAssembly */ + /** @category WASM */ export type ExportValue = Function | Global | Memory | Table; - /** @category WebAssembly */ + /** @category WASM */ export type Exports = Record; - /** @category WebAssembly */ + /** @category WASM */ export type ImportValue = ExportValue | number; - /** @category WebAssembly */ + /** @category WASM */ export type ModuleImports = Record; - /** @category WebAssembly */ + /** @category WASM */ export type Imports = Record; /** @@ -271,7 +271,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/compile) * - * @category WebAssembly + * @category WASM */ export function compile(bytes: BufferSource): Promise; @@ -283,7 +283,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/compileStreaming) * - * @category WebAssembly + * @category WASM */ export function compileStreaming( source: Response | Promise, @@ -300,7 +300,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate) * - * @category WebAssembly + * @category WASM */ export function instantiate( bytes: BufferSource, @@ -317,7 +317,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate) * - * @category WebAssembly + * @category WASM */ export function instantiate( moduleObject: Module, @@ -331,7 +331,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiateStreaming) * - * @category WebAssembly + * @category WASM */ export function instantiateStreaming( response: Response | PromiseLike, @@ -345,7 +345,7 @@ declare namespace WebAssembly { * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/validate) * - * @category WebAssembly + * @category WASM */ export function validate(bytes: BufferSource): boolean; } @@ -357,7 +357,7 @@ declare namespace WebAssembly { * setTimeout(() => { console.log('hello'); }, 500); * ``` * - * @category Timers + * @category Platform */ declare function setTimeout( /** callback function to execute when timer expires */ @@ -375,7 +375,7 @@ declare function setTimeout( * setInterval(() => { console.log('hello'); }, 500); * ``` * - * @category Timers + * @category Platform */ declare function setInterval( /** callback function to execute when timer expires */ @@ -395,7 +395,7 @@ declare function setInterval( * clearInterval(id); * ``` * - * @category Timers + * @category Platform */ declare function clearInterval(id?: number): void; @@ -407,11 +407,11 @@ declare function clearInterval(id?: number): void; * clearTimeout(id); * ``` * - * @category Timers + * @category Platform */ declare function clearTimeout(id?: number): void; -/** @category Scheduling */ +/** @category Platform */ declare interface VoidFunction { (): void; } @@ -426,7 +426,7 @@ declare interface VoidFunction { * queueMicrotask(() => { console.log('This event loop stack is complete'); }); * ``` * - * @category Scheduling + * @category Platform */ declare function queueMicrotask(func: VoidFunction): void; @@ -439,11 +439,11 @@ declare function queueMicrotask(func: VoidFunction): void; * dispatchEvent(new Event('unload')); * ``` * - * @category DOM Events + * @category Events */ declare function dispatchEvent(event: Event): boolean; -/** @category DOM APIs */ +/** @category Platform */ declare interface DOMStringList { /** Returns the number of strings in strings. */ readonly length: number; @@ -454,13 +454,13 @@ declare interface DOMStringList { [index: number]: string; } -/** @category Typed Arrays */ +/** @category Platform */ declare type BufferSource = ArrayBufferView | ArrayBuffer; -/** @category Console and Debugging */ +/** @category I/O */ declare var console: Console; -/** @category DOM Events */ +/** @category Events */ declare interface ErrorEventInit extends EventInit { message?: string; filename?: string; @@ -469,7 +469,7 @@ declare interface ErrorEventInit extends EventInit { error?: any; } -/** @category DOM Events */ +/** @category Events */ declare interface ErrorEvent extends Event { readonly message: string; readonly filename: string; @@ -478,25 +478,25 @@ declare interface ErrorEvent extends Event { readonly error: any; } -/** @category DOM Events */ +/** @category Events */ declare var ErrorEvent: { readonly prototype: ErrorEvent; new (type: string, eventInitDict?: ErrorEventInit): ErrorEvent; }; -/** @category Observability */ +/** @category Events */ declare interface PromiseRejectionEventInit extends EventInit { promise: Promise; reason?: any; } -/** @category Observability */ +/** @category Events */ declare interface PromiseRejectionEvent extends Event { readonly promise: Promise; readonly reason: any; } -/** @category Observability */ +/** @category Events */ declare var PromiseRejectionEvent: { readonly prototype: PromiseRejectionEvent; new ( @@ -505,24 +505,24 @@ declare var PromiseRejectionEvent: { ): PromiseRejectionEvent; }; -/** @category Web Workers */ +/** @category Workers */ declare interface AbstractWorkerEventMap { "error": ErrorEvent; } -/** @category Web Workers */ +/** @category Workers */ declare interface WorkerEventMap extends AbstractWorkerEventMap { "message": MessageEvent; "messageerror": MessageEvent; } -/** @category Web Workers */ +/** @category Workers */ declare interface WorkerOptions { type?: "classic" | "module"; name?: string; } -/** @category Web Workers */ +/** @category Workers */ declare interface Worker extends EventTarget { onerror: (this: Worker, e: ErrorEvent) => any | null; onmessage: (this: Worker, e: MessageEvent) => any | null; @@ -552,7 +552,7 @@ declare interface Worker extends EventTarget { terminate(): void; } -/** @category Web Workers */ +/** @category Workers */ declare var Worker: { readonly prototype: Worker; new (specifier: string | URL, options?: WorkerOptions): Worker; @@ -719,25 +719,25 @@ declare var PerformanceMeasure: { new (): never; }; -/** @category DOM Events */ +/** @category Events */ declare interface CustomEventInit extends EventInit { detail?: T; } -/** @category DOM Events */ +/** @category Events */ declare interface CustomEvent extends Event { /** Returns any custom data event was created with. Typically used for * synthetic events. */ readonly detail: T; } -/** @category DOM Events */ +/** @category Events */ declare var CustomEvent: { readonly prototype: CustomEvent; new (typeArg: string, eventInitDict?: CustomEventInit): CustomEvent; }; -/** @category DOM APIs */ +/** @category Platform */ declare interface ErrorConstructor { /** See https://v8.dev/docs/stack-trace-api#stack-trace-collection-for-custom-exceptions. */ captureStackTrace(error: Object, constructor?: Function): void; diff --git a/cli/tsc/dts/lib.deno.unstable.d.ts b/cli/tsc/dts/lib.deno.unstable.d.ts index 437a881116..488780ff79 100644 --- a/cli/tsc/dts/lib.deno.unstable.d.ts +++ b/cli/tsc/dts/lib.deno.unstable.d.ts @@ -843,7 +843,7 @@ declare namespace Deno { * | "x11" (Linux) | Xlib `Window` | Xlib `Display*` | * | "wayland" (Linux) | `wl_surface*` | `wl_display*` | * - * @category WebGPU + * @category GPU * @tags unstable */ export class UnsafeWindowSurface { @@ -940,7 +940,7 @@ declare namespace Deno { * const req = await fetch("https://myserver.com", { client }); * ``` * - * @category Fetch API + * @category Fetch * @tags unstable */ export interface HttpClient extends Disposable { @@ -952,7 +952,7 @@ declare namespace Deno { * * The options used when creating a {@linkcode Deno.HttpClient}. * - * @category Fetch API + * @category Fetch * @tags unstable */ export interface CreateHttpClientOptions { @@ -991,7 +991,7 @@ declare namespace Deno { * The definition of a proxy when specifying * {@linkcode Deno.CreateHttpClientOptions}. * - * @category Fetch API + * @category Fetch * @tags unstable */ export interface Proxy { @@ -1006,7 +1006,7 @@ declare namespace Deno { * Basic authentication credentials to be used with a {@linkcode Deno.Proxy} * server when specifying {@linkcode Deno.CreateHttpClientOptions}. * - * @category Fetch API + * @category Fetch * @tags unstable */ export interface BasicAuth { @@ -1035,7 +1035,7 @@ declare namespace Deno { * const response = await fetch("https://myserver.com", { client }); * ``` * - * @category Fetch API + * @category Fetch * @tags unstable */ export function createHttpClient( @@ -1057,7 +1057,7 @@ declare namespace Deno { * const response = await fetch("https://myserver.com", { client }); * ``` * - * @category Fetch API + * @category Fetch * @tags unstable */ export function createHttpClient( @@ -1269,7 +1269,7 @@ declare namespace Deno { * can be found in the Deno Manual. * * @tags allow-read, allow-write, unstable - * @category KV + * @category Cloud */ export function openKv(path?: string): Promise; @@ -1277,7 +1277,7 @@ declare namespace Deno { * * CronScheduleExpression is used as the type of `minute`, `hour`, * `dayOfMonth`, `month`, and `dayOfWeek` in {@linkcode CronSchedule}. - * @category Cron + * @category Cloud * @tags unstable */ export type CronScheduleExpression = number | { exact: number | number[] } | { @@ -1290,7 +1290,7 @@ declare namespace Deno { * * CronSchedule is the interface used for JSON format * cron `schedule`. - * @category Cron + * @category Cloud * @tags unstable */ export interface CronSchedule { @@ -1322,7 +1322,7 @@ declare namespace Deno { * as specified by interface {@linkcode CronSchedule}, where time is specified * using UTC time zone. * - * @category Cron + * @category Cloud * @tags unstable */ export function cron( @@ -1354,7 +1354,7 @@ declare namespace Deno { * means that a failed execution will be retried at most 3 times, with 1 * second, 5 seconds, and 10 seconds delay between each retry. * - * @category Cron + * @category Cloud * @tags unstable */ export function cron( @@ -1379,7 +1379,7 @@ declare namespace Deno { * exceeds this limit, an error will be thrown on the operation that this key * was passed to. * - * @category KV + * @category Cloud * @tags unstable */ export type KvKey = readonly KvKeyPart[]; @@ -1416,7 +1416,7 @@ declare namespace Deno { * `1.0` is a number and `0n` is a bigint, and type ordering has precedence * over the ordering of values within a type. * - * @category KV + * @category Cloud * @tags unstable */ export type KvKeyPart = @@ -1434,7 +1434,7 @@ declare namespace Deno { * - `strong` - This operation must be strongly-consistent. * - `eventual` - Eventually-consistent behavior is allowed. * - * @category KV + * @category Cloud * @tags unstable */ export type KvConsistencyLevel = "strong" | "eventual"; @@ -1449,7 +1449,7 @@ declare namespace Deno { * starting at a given key). A range selector selects all keys that are * lexicographically between the given start and end keys. * - * @category KV + * @category Cloud * @tags unstable */ export type KvListSelector = @@ -1488,7 +1488,7 @@ declare namespace Deno { * existing value must be of type `Deno.KvU64`. If the key does not exist, * the value is set to the given value. * - * @category KV + * @category Cloud * @tags unstable */ export type KvMutation = @@ -1508,7 +1508,7 @@ declare namespace Deno { * The cursor getter returns the cursor that can be used to resume the * iteration from the current position in the future. * - * @category KV + * @category Cloud * @tags unstable */ export class KvListIterator implements AsyncIterableIterator> { @@ -1531,7 +1531,7 @@ declare namespace Deno { * key-value pair. It can be used to perform atomic operations on the KV store * by passing it to the `check` method of a {@linkcode Deno.AtomicOperation}. * - * @category KV + * @category Cloud * @tags unstable */ export type KvEntry = { key: KvKey; value: T; versionstamp: string }; @@ -1544,7 +1544,7 @@ declare namespace Deno { * This is the same as a {@linkcode KvEntry}, but the `value` and `versionstamp` * fields may be `null` if no value exists for the given key in the KV store. * - * @category KV + * @category Cloud * @tags unstable */ export type KvEntryMaybe = KvEntry | { @@ -1557,7 +1557,7 @@ declare namespace Deno { * * Options for listing key-value pairs in a {@linkcode Deno.Kv}. * - * @category KV + * @category Cloud * @tags unstable */ export interface KvListOptions { @@ -1612,7 +1612,7 @@ declare namespace Deno { } /** - * @category KV + * @category Cloud * @tags unstable */ export interface KvCommitResult { @@ -1622,7 +1622,7 @@ declare namespace Deno { } /** - * @category KV + * @category Cloud * @tags unstable */ export interface KvCommitError { @@ -1636,7 +1636,7 @@ declare namespace Deno { * not match the given versionstamp. A check with a `null` versionstamp checks * that the key-value pair does not currently exist in the KV store. * - * @category KV + * @category Cloud * @tags unstable */ export interface AtomicCheck { @@ -1678,7 +1678,7 @@ declare namespace Deno { * will be a {@linkcode Deno.KvCommitResult} object with a `ok: true` property * and the versionstamp of the value committed to KV. * - * @category KV + * @category Cloud * @tags unstable */ export class AtomicOperation { @@ -1795,7 +1795,7 @@ declare namespace Deno { * of a JSON serialization of that same value. If theses limits are exceeded, * an exception will be thrown. * - * @category KV + * @category Cloud * @tags unstable */ export class Kv implements Disposable { @@ -2066,7 +2066,7 @@ declare namespace Deno { * Wrapper type for 64-bit unsigned integers for use as values in a * {@linkcode Deno.Kv}. * - * @category KV + * @category Cloud * @tags unstable */ export class KvU64 { @@ -2283,7 +2283,7 @@ declare namespace Deno { * way to connect via proxies and use custom TLS certificates. * * @tags allow-net, allow-read, unstable - * @category Fetch API + * @category Fetch */ declare function fetch( input: Request | URL | string, @@ -2292,7 +2292,7 @@ declare function fetch( /** **UNSTABLE**: New API, yet to be vetted. * - * @category Web Workers + * @category Workers * @tags unstable */ declare interface WorkerOptions { @@ -2333,7 +2333,7 @@ declare interface WorkerOptions { /** **UNSTABLE**: New API, yet to be vetted. * - * @category Web Sockets + * @category WebSockets * @tags unstable */ declare interface WebSocketStreamOptions { @@ -2344,7 +2344,7 @@ declare interface WebSocketStreamOptions { /** **UNSTABLE**: New API, yet to be vetted. * - * @category Web Sockets + * @category WebSockets * @tags unstable */ declare interface WebSocketConnection { @@ -2356,7 +2356,7 @@ declare interface WebSocketConnection { /** **UNSTABLE**: New API, yet to be vetted. * - * @category Web Sockets + * @category WebSockets * @tags unstable */ declare interface WebSocketCloseInfo { @@ -2367,7 +2367,7 @@ declare interface WebSocketCloseInfo { /** **UNSTABLE**: New API, yet to be vetted. * * @tags allow-net, unstable - * @category Web Sockets + * @category WebSockets */ declare interface WebSocketStream { url: string; @@ -2379,7 +2379,7 @@ declare interface WebSocketStream { /** **UNSTABLE**: New API, yet to be vetted. * * @tags allow-net, unstable - * @category Web Sockets + * @category WebSockets */ declare var WebSocketStream: { readonly prototype: WebSocketStream; @@ -2389,7 +2389,7 @@ declare var WebSocketStream: { /** **UNSTABLE**: New API, yet to be vetted. * * @tags allow-net, unstable - * @category Web Sockets + * @category WebSockets */ declare interface WebSocketError extends DOMException { readonly closeCode: number; @@ -2399,7 +2399,7 @@ declare interface WebSocketError extends DOMException { /** **UNSTABLE**: New API, yet to be vetted. * * @tags allow-net, unstable - * @category Web Sockets + * @category WebSockets */ declare var WebSocketError: { readonly prototype: WebSocketError; @@ -4630,7 +4630,7 @@ declare namespace Intl { * A typed array of 16-bit float values. The contents are initialized to 0. If the requested number * of bytes could not be allocated an exception is raised. * - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16Array { @@ -4945,7 +4945,7 @@ declare interface Float16Array { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16ArrayConstructor { @@ -4988,13 +4988,13 @@ declare interface Float16ArrayConstructor { ): Float16Array; } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare var Float16Array: Float16ArrayConstructor; /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16 { @@ -5014,7 +5014,7 @@ declare interface Float16 { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16Constructor { @@ -5034,7 +5034,7 @@ declare interface Float16Constructor { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16Array { @@ -5042,7 +5042,7 @@ declare interface Float16Array { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16Array { @@ -5055,7 +5055,7 @@ declare interface Float16Array { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16ArrayConstructor { @@ -5063,7 +5063,7 @@ declare interface Float16ArrayConstructor { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16Array { @@ -5075,7 +5075,7 @@ declare interface Float16Array { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface Float16Array { @@ -5151,7 +5151,7 @@ declare interface Float16Array { } /** - * @category Web APIs + * @category Platform * @tags unstable */ declare interface DataView { diff --git a/cli/tsc/dts/lib.deno.window.d.ts b/cli/tsc/dts/lib.deno.window.d.ts index ed3ff6b6e7..511bb04ad4 100644 --- a/cli/tsc/dts/lib.deno.window.d.ts +++ b/cli/tsc/dts/lib.deno.window.d.ts @@ -7,14 +7,14 @@ /// /// -/** @category Web APIs */ +/** @category Platform */ declare interface WindowEventMap { "error": ErrorEvent; "unhandledrejection": PromiseRejectionEvent; "rejectionhandled": PromiseRejectionEvent; } -/** @category Web APIs */ +/** @category Platform */ declare interface Window extends EventTarget { readonly window: Window & typeof globalThis; readonly self: Window & typeof globalThis; @@ -71,40 +71,40 @@ declare interface Window extends EventTarget { ): void; } -/** @category Web APIs */ +/** @category Platform */ declare var Window: { readonly prototype: Window; new (): never; }; -/** @category Web APIs */ +/** @category Platform */ declare var window: Window & typeof globalThis; -/** @category Web APIs */ +/** @category Platform */ declare var self: Window & typeof globalThis; -/** @category Web APIs */ +/** @category Platform */ declare var closed: boolean; -/** @category Web APIs */ +/** @category Platform */ declare function close(): void; -/** @category DOM Events */ +/** @category Events */ declare var onerror: ((this: Window, ev: ErrorEvent) => any) | null; -/** @category DOM Events */ +/** @category Events */ declare var onload: ((this: Window, ev: Event) => any) | null; -/** @category DOM Events */ +/** @category Events */ declare var onbeforeunload: ((this: Window, ev: Event) => any) | null; -/** @category DOM Events */ +/** @category Events */ declare var onunload: ((this: Window, ev: Event) => any) | null; -/** @category Observability */ +/** @category Events */ declare var onunhandledrejection: | ((this: Window, ev: PromiseRejectionEvent) => any) | null; -/** @category Web Storage API */ +/** @category Storage */ declare var localStorage: Storage; -/** @category Web Storage API */ +/** @category Storage */ declare var sessionStorage: Storage; -/** @category Cache API */ +/** @category Cache */ declare var caches: CacheStorage; -/** @category Web APIs */ +/** @category Platform */ declare interface Navigator { readonly gpu: GPU; readonly hardwareConcurrency: number; @@ -113,13 +113,13 @@ declare interface Navigator { readonly languages: string[]; } -/** @category Web APIs */ +/** @category Platform */ declare var Navigator: { readonly prototype: Navigator; new (): never; }; -/** @category Web APIs */ +/** @category Platform */ declare var navigator: Navigator; /** @@ -127,7 +127,7 @@ declare var navigator: Navigator; * * If the stdin is not interactive, it does nothing. * - * @category Web APIs + * @category Platform * * @param message */ @@ -140,7 +140,7 @@ declare function alert(message?: string): void; * * If the stdin is not interactive, it returns false. * - * @category Web APIs + * @category Platform * * @param message */ @@ -157,7 +157,7 @@ declare function confirm(message?: string): boolean; * * If the stdin is not interactive, it returns null. * - * @category Web APIs + * @category Platform * * @param message * @param defaultValue @@ -173,7 +173,7 @@ declare function prompt(message?: string, defaultValue?: string): string | null; * dispatchEvent(new Event('unload')); * ``` * - * @category DOM Events + * @category Events */ declare function addEventListener< K extends keyof WindowEventMap, @@ -182,7 +182,7 @@ declare function addEventListener< listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions, ): void; -/** @category DOM Events */ +/** @category Events */ declare function addEventListener( type: string, listener: EventListenerOrEventListenerObject, @@ -197,7 +197,7 @@ declare function addEventListener( * removeEventListener('load', listener); * ``` * - * @category DOM Events + * @category Events */ declare function removeEventListener< K extends keyof WindowEventMap, @@ -206,7 +206,7 @@ declare function removeEventListener< listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | EventListenerOptions, ): void; -/** @category DOM Events */ +/** @category Events */ declare function removeEventListener( type: string, listener: EventListenerOrEventListenerObject, @@ -219,7 +219,7 @@ declare function removeEventListener( * reflected on the object it relates to. Accessible via * `globalThis.location`. * - * @category Web APIs + * @category Platform */ declare interface Location { /** Returns a DOMStringList object listing the origins of the ancestor @@ -289,7 +289,7 @@ declare interface Location { * reflected on the object it relates to. Accessible via * `globalThis.location`. * - * @category Web APIs + * @category Platform */ declare var Location: { readonly prototype: Location; @@ -298,8 +298,8 @@ declare var Location: { // TODO(nayeemrmn): Move this to `extensions/web` where its implementation is. // The types there must first be split into window, worker and global types. -/** @category Web APIs */ +/** @category Platform */ declare var location: Location; -/** @category Web APIs */ +/** @category Platform */ declare var name: string; diff --git a/cli/tsc/dts/lib.deno.worker.d.ts b/cli/tsc/dts/lib.deno.worker.d.ts index d9e6634947..fa69cc57d6 100644 --- a/cli/tsc/dts/lib.deno.worker.d.ts +++ b/cli/tsc/dts/lib.deno.worker.d.ts @@ -6,13 +6,13 @@ /// /// -/** @category Web Workers */ +/** @category Workers */ declare interface WorkerGlobalScopeEventMap { "error": ErrorEvent; "unhandledrejection": PromiseRejectionEvent; } -/** @category Web Workers */ +/** @category Workers */ declare interface WorkerGlobalScope extends EventTarget { readonly location: WorkerLocation; readonly navigator: WorkerNavigator; @@ -54,13 +54,13 @@ declare interface WorkerGlobalScope extends EventTarget { caches: CacheStorage; } -/** @category Web Workers */ +/** @category Workers */ declare var WorkerGlobalScope: { readonly prototype: WorkerGlobalScope; new (): never; }; -/** @category Web APIs */ +/** @category Platform */ declare interface WorkerNavigator { readonly gpu: GPU; readonly hardwareConcurrency: number; @@ -69,23 +69,23 @@ declare interface WorkerNavigator { readonly languages: string[]; } -/** @category Web APIs */ +/** @category Platform */ declare var WorkerNavigator: { readonly prototype: WorkerNavigator; new (): never; }; -/** @category Web APIs */ +/** @category Platform */ declare var navigator: WorkerNavigator; -/** @category Web Workers */ +/** @category Workers */ declare interface DedicatedWorkerGlobalScopeEventMap extends WorkerGlobalScopeEventMap { "message": MessageEvent; "messageerror": MessageEvent; } -/** @category Web APIs */ +/** @category Platform */ declare interface DedicatedWorkerGlobalScope extends WorkerGlobalScope { readonly name: string; onmessage: @@ -125,34 +125,34 @@ declare interface DedicatedWorkerGlobalScope extends WorkerGlobalScope { ): void; } -/** @category Web APIs */ +/** @category Platform */ declare var DedicatedWorkerGlobalScope: { readonly prototype: DedicatedWorkerGlobalScope; new (): never; }; -/** @category Web Workers */ +/** @category Workers */ declare var name: string; -/** @category Web Workers */ +/** @category Workers */ declare var onmessage: | ((this: DedicatedWorkerGlobalScope, ev: MessageEvent) => any) | null; -/** @category Web Workers */ +/** @category Workers */ declare var onmessageerror: | ((this: DedicatedWorkerGlobalScope, ev: MessageEvent) => any) | null; -/** @category Web Workers */ +/** @category Workers */ declare function close(): void; -/** @category Web Workers */ +/** @category Workers */ declare function postMessage(message: any, transfer: Transferable[]): void; -/** @category Web Workers */ +/** @category Workers */ declare function postMessage( message: any, options?: StructuredSerializeOptions, ): void; -/** @category Web APIs */ +/** @category Platform */ declare var navigator: WorkerNavigator; -/** @category Web APIs */ +/** @category Platform */ declare var onerror: | ((this: DedicatedWorkerGlobalScope, ev: ErrorEvent) => any) | null; @@ -160,9 +160,9 @@ declare var onerror: declare var onunhandledrejection: | ((this: DedicatedWorkerGlobalScope, ev: PromiseRejectionEvent) => any) | null; -/** @category Web Workers */ +/** @category Workers */ declare var self: WorkerGlobalScope & typeof globalThis; -/** @category DOM Events */ +/** @category Events */ declare function addEventListener< K extends keyof DedicatedWorkerGlobalScopeEventMap, >( @@ -173,13 +173,13 @@ declare function addEventListener< ) => any, options?: boolean | AddEventListenerOptions, ): void; -/** @category DOM Events */ +/** @category Events */ declare function addEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions, ): void; -/** @category DOM Events */ +/** @category Events */ declare function removeEventListener< K extends keyof DedicatedWorkerGlobalScopeEventMap, >( @@ -190,7 +190,7 @@ declare function removeEventListener< ) => any, options?: boolean | EventListenerOptions, ): void; -/** @category DOM Events */ +/** @category Events */ declare function removeEventListener( type: string, listener: EventListenerOrEventListenerObject, @@ -203,7 +203,7 @@ declare function removeEventListener( * is initialized for each worker and is available via the * WorkerGlobalScope.location property obtained by calling self.location. * - * @category Web APIs + * @category Platform */ declare interface WorkerLocation { readonly hash: string; @@ -224,7 +224,7 @@ declare interface WorkerLocation { * is initialized for each worker and is available via the * WorkerGlobalScope.location property obtained by calling self.location. * - * @category Web APIs + * @category Platform */ declare var WorkerLocation: { readonly prototype: WorkerLocation; @@ -233,5 +233,5 @@ declare var WorkerLocation: { // TODO(nayeemrmn): Move this to `extensions/web` where its implementation is. // The types there must first be split into window, worker and global types. -/** @category Web APIs */ +/** @category Platform */ declare var location: WorkerLocation; diff --git a/cli/tsc/dts/lib.deno_webgpu.d.ts b/cli/tsc/dts/lib.deno_webgpu.d.ts index 8362ba2e26..8051a051b5 100644 --- a/cli/tsc/dts/lib.deno_webgpu.d.ts +++ b/cli/tsc/dts/lib.deno_webgpu.d.ts @@ -6,7 +6,7 @@ /// /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUObjectBase { @@ -14,7 +14,7 @@ declare interface GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUObjectDescriptorBase { @@ -22,7 +22,7 @@ declare interface GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUSupportedLimits { @@ -59,7 +59,7 @@ declare class GPUSupportedLimits { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUSupportedFeatures { @@ -80,7 +80,7 @@ declare class GPUSupportedFeatures { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUAdapterInfo { @@ -91,7 +91,7 @@ declare class GPUAdapterInfo { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPU { @@ -102,7 +102,7 @@ declare class GPU { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURequestAdapterOptions { @@ -111,13 +111,13 @@ declare interface GPURequestAdapterOptions { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUPowerPreference = "low-power" | "high-performance"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUAdapter { @@ -130,7 +130,7 @@ declare class GPUAdapter { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUDeviceDescriptor extends GPUObjectDescriptorBase { @@ -139,7 +139,7 @@ declare interface GPUDeviceDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUFeatureName = @@ -170,7 +170,7 @@ declare type GPUFeatureName = | "vertex-attribute-64bit"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUDevice extends EventTarget implements GPUObjectBase { @@ -223,7 +223,7 @@ declare class GPUDevice extends EventTarget implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUBuffer implements GPUObjectBase { @@ -245,13 +245,13 @@ declare class GPUBuffer implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUBufferMapState = "unmapped" | "pending" | "mapped"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBufferDescriptor extends GPUObjectDescriptorBase { @@ -261,19 +261,19 @@ declare interface GPUBufferDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUBufferUsageFlags = number; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUFlagsConstant = number; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUBufferUsage { @@ -290,13 +290,13 @@ declare class GPUBufferUsage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUMapModeFlags = number; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUMapMode { @@ -305,7 +305,7 @@ declare class GPUMapMode { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUTexture implements GPUObjectBase { @@ -325,7 +325,7 @@ declare class GPUTexture implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUTextureDescriptor extends GPUObjectDescriptorBase { @@ -339,19 +339,19 @@ declare interface GPUTextureDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUTextureDimension = "1d" | "2d" | "3d"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUTextureUsageFlags = number; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUTextureUsage { @@ -363,7 +363,7 @@ declare class GPUTextureUsage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUTextureView implements GPUObjectBase { @@ -371,7 +371,7 @@ declare class GPUTextureView implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUTextureViewDescriptor extends GPUObjectDescriptorBase { @@ -385,7 +385,7 @@ declare interface GPUTextureViewDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUTextureViewDimension = @@ -397,13 +397,13 @@ declare type GPUTextureViewDimension = | "3d"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUTextureAspect = "all" | "stencil-only" | "depth-only"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUTextureFormat = @@ -504,7 +504,7 @@ declare type GPUTextureFormat = | "astc-12x12-unorm-srgb"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUSampler implements GPUObjectBase { @@ -512,7 +512,7 @@ declare class GPUSampler implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUSamplerDescriptor extends GPUObjectDescriptorBase { @@ -529,25 +529,25 @@ declare interface GPUSamplerDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUAddressMode = "clamp-to-edge" | "repeat" | "mirror-repeat"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUFilterMode = "nearest" | "linear"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUMipmapFilterMode = "nearest" | "linear"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUCompareFunction = @@ -561,7 +561,7 @@ declare type GPUCompareFunction = | "always"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUBindGroupLayout implements GPUObjectBase { @@ -569,7 +569,7 @@ declare class GPUBindGroupLayout implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBindGroupLayoutDescriptor extends GPUObjectDescriptorBase { @@ -577,7 +577,7 @@ declare interface GPUBindGroupLayoutDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBindGroupLayoutEntry { @@ -591,13 +591,13 @@ declare interface GPUBindGroupLayoutEntry { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUShaderStageFlags = number; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUShaderStage { @@ -607,7 +607,7 @@ declare class GPUShaderStage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBufferBindingLayout { @@ -617,13 +617,13 @@ declare interface GPUBufferBindingLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUBufferBindingType = "uniform" | "storage" | "read-only-storage"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUSamplerBindingLayout { @@ -631,7 +631,7 @@ declare interface GPUSamplerBindingLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUSamplerBindingType = @@ -640,7 +640,7 @@ declare type GPUSamplerBindingType = | "comparison"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUTextureBindingLayout { @@ -650,7 +650,7 @@ declare interface GPUTextureBindingLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUTextureSampleType = @@ -661,7 +661,7 @@ declare type GPUTextureSampleType = | "uint"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUStorageTextureAccess = @@ -670,7 +670,7 @@ declare type GPUStorageTextureAccess = | "read-write"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUStorageTextureBindingLayout { @@ -680,7 +680,7 @@ declare interface GPUStorageTextureBindingLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUBindGroup implements GPUObjectBase { @@ -688,7 +688,7 @@ declare class GPUBindGroup implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBindGroupDescriptor extends GPUObjectDescriptorBase { @@ -697,7 +697,7 @@ declare interface GPUBindGroupDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUBindingResource = @@ -706,7 +706,7 @@ declare type GPUBindingResource = | GPUBufferBinding; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBindGroupEntry { @@ -715,7 +715,7 @@ declare interface GPUBindGroupEntry { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBufferBinding { @@ -725,7 +725,7 @@ declare interface GPUBufferBinding { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUPipelineLayout implements GPUObjectBase { @@ -733,7 +733,7 @@ declare class GPUPipelineLayout implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUPipelineLayoutDescriptor extends GPUObjectDescriptorBase { @@ -741,13 +741,13 @@ declare interface GPUPipelineLayoutDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUCompilationMessageType = "error" | "warning" | "info"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUCompilationMessage { @@ -758,7 +758,7 @@ declare interface GPUCompilationMessage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUCompilationInfo { @@ -790,7 +790,7 @@ declare interface GPUPipelineErrorInit { declare type GPUPipelineErrorReason = "validation" | "internal"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUShaderModule implements GPUObjectBase { @@ -798,7 +798,7 @@ declare class GPUShaderModule implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUShaderModuleDescriptor extends GPUObjectDescriptorBase { @@ -807,13 +807,13 @@ declare interface GPUShaderModuleDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUAutoLayoutMode = "auto"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUPipelineDescriptorBase extends GPUObjectDescriptorBase { @@ -821,7 +821,7 @@ declare interface GPUPipelineDescriptorBase extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUPipelineBase { @@ -829,7 +829,7 @@ declare interface GPUPipelineBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUProgrammableStage { @@ -839,7 +839,7 @@ declare interface GPUProgrammableStage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUComputePipeline implements GPUObjectBase, GPUPipelineBase { @@ -849,7 +849,7 @@ declare class GPUComputePipeline implements GPUObjectBase, GPUPipelineBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUComputePipelineDescriptor @@ -858,7 +858,7 @@ declare interface GPUComputePipelineDescriptor } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPURenderPipeline implements GPUObjectBase, GPUPipelineBase { @@ -868,7 +868,7 @@ declare class GPURenderPipeline implements GPUObjectBase, GPUPipelineBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderPipelineDescriptor @@ -881,7 +881,7 @@ declare interface GPURenderPipelineDescriptor } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUPrimitiveState { @@ -893,7 +893,7 @@ declare interface GPUPrimitiveState { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUPrimitiveTopology = @@ -904,19 +904,19 @@ declare type GPUPrimitiveTopology = | "triangle-strip"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUFrontFace = "ccw" | "cw"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUCullMode = "none" | "front" | "back"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUMultisampleState { @@ -926,7 +926,7 @@ declare interface GPUMultisampleState { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUFragmentState extends GPUProgrammableStage { @@ -934,7 +934,7 @@ declare interface GPUFragmentState extends GPUProgrammableStage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUColorTargetState { @@ -945,7 +945,7 @@ declare interface GPUColorTargetState { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBlendState { @@ -954,13 +954,13 @@ declare interface GPUBlendState { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUColorWriteFlags = number; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUColorWrite { @@ -972,7 +972,7 @@ declare class GPUColorWrite { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUBlendComponent { @@ -982,7 +982,7 @@ declare interface GPUBlendComponent { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUBlendFactor = @@ -1001,7 +1001,7 @@ declare type GPUBlendFactor = | "one-minus-constant"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUBlendOperation = @@ -1012,7 +1012,7 @@ declare type GPUBlendOperation = | "max"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUDepthStencilState { @@ -1033,7 +1033,7 @@ declare interface GPUDepthStencilState { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUStencilFaceState { @@ -1044,7 +1044,7 @@ declare interface GPUStencilFaceState { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUStencilOperation = @@ -1058,13 +1058,13 @@ declare type GPUStencilOperation = | "decrement-wrap"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUIndexFormat = "uint16" | "uint32"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUVertexFormat = @@ -1101,13 +1101,13 @@ declare type GPUVertexFormat = | "unorm10-10-10-2"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUVertexStepMode = "vertex" | "instance"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUVertexState extends GPUProgrammableStage { @@ -1115,7 +1115,7 @@ declare interface GPUVertexState extends GPUProgrammableStage { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUVertexBufferLayout { @@ -1125,7 +1125,7 @@ declare interface GPUVertexBufferLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUVertexAttribute { @@ -1136,7 +1136,7 @@ declare interface GPUVertexAttribute { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUImageDataLayout { @@ -1146,7 +1146,7 @@ declare interface GPUImageDataLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUCommandBuffer implements GPUObjectBase { @@ -1154,13 +1154,13 @@ declare class GPUCommandBuffer implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUCommandBufferDescriptor extends GPUObjectDescriptorBase {} /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUCommandEncoder implements GPUObjectBase { @@ -1221,13 +1221,13 @@ declare class GPUCommandEncoder implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUCommandEncoderDescriptor extends GPUObjectDescriptorBase {} /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUImageCopyBuffer extends GPUImageDataLayout { @@ -1235,7 +1235,7 @@ declare interface GPUImageCopyBuffer extends GPUImageDataLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUImageCopyTexture { @@ -1246,7 +1246,7 @@ declare interface GPUImageCopyTexture { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUProgrammablePassEncoder { @@ -1270,7 +1270,7 @@ declare interface GPUProgrammablePassEncoder { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUComputePassEncoder @@ -1302,7 +1302,7 @@ declare class GPUComputePassEncoder } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUComputePassTimestampWrites { @@ -1312,7 +1312,7 @@ declare interface GPUComputePassTimestampWrites { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUComputePassDescriptor extends GPUObjectDescriptorBase { @@ -1320,7 +1320,7 @@ declare interface GPUComputePassDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderEncoderBase { @@ -1361,7 +1361,7 @@ declare interface GPURenderEncoderBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPURenderPassEncoder @@ -1441,7 +1441,7 @@ declare class GPURenderPassEncoder } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderPassTimestampWrites { @@ -1451,7 +1451,7 @@ declare interface GPURenderPassTimestampWrites { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderPassDescriptor extends GPUObjectDescriptorBase { @@ -1462,7 +1462,7 @@ declare interface GPURenderPassDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderPassColorAttachment { @@ -1475,7 +1475,7 @@ declare interface GPURenderPassColorAttachment { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderPassDepthStencilAttachment { @@ -1493,19 +1493,19 @@ declare interface GPURenderPassDepthStencilAttachment { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPULoadOp = "load" | "clear"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUStoreOp = "store" | "discard"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPURenderBundle implements GPUObjectBase { @@ -1513,13 +1513,13 @@ declare class GPURenderBundle implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderBundleDescriptor extends GPUObjectDescriptorBase {} /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPURenderBundleEncoder @@ -1576,7 +1576,7 @@ declare class GPURenderBundleEncoder } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderPassLayout extends GPUObjectDescriptorBase { @@ -1586,7 +1586,7 @@ declare interface GPURenderPassLayout extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPURenderBundleEncoderDescriptor extends GPURenderPassLayout { @@ -1595,7 +1595,7 @@ declare interface GPURenderBundleEncoderDescriptor extends GPURenderPassLayout { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUQueue implements GPUObjectBase { @@ -1622,7 +1622,7 @@ declare class GPUQueue implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUQuerySet implements GPUObjectBase { @@ -1635,7 +1635,7 @@ declare class GPUQuerySet implements GPUObjectBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUQuerySetDescriptor extends GPUObjectDescriptorBase { @@ -1644,19 +1644,19 @@ declare interface GPUQuerySetDescriptor extends GPUObjectDescriptorBase { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUQueryType = "occlusion" | "timestamp"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUDeviceLostReason = "destroyed"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUDeviceLostInfo { @@ -1665,7 +1665,7 @@ declare interface GPUDeviceLostInfo { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUError { @@ -1673,7 +1673,7 @@ declare class GPUError { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUOutOfMemoryError extends GPUError { @@ -1681,7 +1681,7 @@ declare class GPUOutOfMemoryError extends GPUError { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare class GPUValidationError extends GPUError { @@ -1697,7 +1697,7 @@ declare class GPUInternalError extends GPUError { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUErrorFilter = "out-of-memory" | "validation" | "internal"; @@ -1724,7 +1724,7 @@ declare interface GPUUncapturedErrorEventInit extends EventInit { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUColorDict { @@ -1735,13 +1735,13 @@ declare interface GPUColorDict { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUColor = number[] | GPUColorDict; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUOrigin3DDict { @@ -1751,13 +1751,13 @@ declare interface GPUOrigin3DDict { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUOrigin3D = number[] | GPUOrigin3DDict; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUExtent3DDict { @@ -1767,19 +1767,19 @@ declare interface GPUExtent3DDict { } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUExtent3D = number[] | GPUExtent3DDict; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare type GPUCanvasAlphaMode = "opaque" | "premultiplied"; /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUCanvasConfiguration { @@ -1793,7 +1793,7 @@ declare interface GPUCanvasConfiguration { height: number; } /** - * @category WebGPU + * @category GPU * @tags unstable */ declare interface GPUCanvasContext { diff --git a/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts b/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts index a3d74c07bb..035d9e1ce5 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 409ca2c0c0..f28de94cee 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 da72ae9462..da6bc9fa9f 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 3389c3b255..a4968dc836 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 5369dac3b2..0c00470ecd 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 40b41b4306..4eb303e688 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 0ade8c85af..ca5b00e607 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 3ebc9af498..36c77ef818 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 * ,