foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-28 16:20:57 -05:00
Code Issues Packages 1 Wiki Activity

docs: update categories to match new planned sitemap (#23677)

Browse source 
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
This commit is contained in:
Jo Franchetti 2024-05-06 02:56:55 +01:00 committed by GitHub
parent 397be1a22c
commit a69b4646a0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 550 additions and 550 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
cli/tsc/dts/lib.deno.ns.d.ts vendored
View file

@ -8,7 +8,7 @@
* to ensure that these are still available when using the Deno namespace in * to ensure that these are still available when using the Deno namespace in
* conjunction with other type libs, like `dom`. * conjunction with other type libs, like `dom`.
* *
* @category ES Modules * @category Platform
*/ */
declare interface ImportMeta { declare interface ImportMeta {
/** A string representation of the fully qualified module URL. When the /** A string representation of the fully qualified module URL. When the
@ -322,7 +322,7 @@ declare namespace Deno {
* console.log(Deno.pid); * console.log(Deno.pid);
* ``` * ```
* *
* @category Runtime Environment * @category Runtime
*/ */
export const pid: number; export const pid: number;
@ -333,11 +333,11 @@ declare namespace Deno {
* console.log(Deno.ppid); * console.log(Deno.ppid);
* ``` * ```
* *
* @category Runtime Environment * @category Runtime
*/ */
export const ppid: number; export const ppid: number;
/** @category Runtime Environment */ /** @category Runtime */
export interface MemoryUsage { export interface MemoryUsage {
/** The number of bytes of the current Deno's process resident set size, /** The number of bytes of the current Deno's process resident set size,
* which is the amount of memory occupied in main memory (RAM). */ * 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 * Returns an object describing the memory usage of the Deno process and the
* V8 subsystem measured in bytes. * V8 subsystem measured in bytes.
* *
* @category Runtime Environment * @category Runtime
*/ */
export function memoryUsage(): MemoryUsage; export function memoryUsage(): MemoryUsage;
@ -369,7 +369,7 @@ declare namespace Deno {
* Requires `allow-sys` permission. * Requires `allow-sys` permission.
* *
* @tags allow-sys * @tags allow-sys
* @category Runtime Environment * @category Runtime
*/ */
export function hostname(): string; 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 ]`. * On Windows there is no API available to retrieve this information and this method returns `[ 0, 0, 0 ]`.
* *
* @tags allow-sys * @tags allow-sys
* @category Observability * @category Runtime
*/ */
export function loadavg(): number[]; export function loadavg(): number[];
@ -443,14 +443,14 @@ declare namespace Deno {
* Requires `allow-sys` permission. * Requires `allow-sys` permission.
* *
* @tags allow-sys * @tags allow-sys
* @category Runtime Environment * @category Runtime
*/ */
export function systemMemoryInfo(): SystemMemoryInfo; export function systemMemoryInfo(): SystemMemoryInfo;
/** /**
* Information returned from a call to {@linkcode Deno.systemMemoryInfo}. * Information returned from a call to {@linkcode Deno.systemMemoryInfo}.
* *
* @category Runtime Environment * @category Runtime
*/ */
export interface SystemMemoryInfo { export interface SystemMemoryInfo {
/** Total installed memory in bytes. */ /** Total installed memory in bytes. */
@ -481,7 +481,7 @@ declare namespace Deno {
* *
* See: https://no-color.org/ * See: https://no-color.org/
* *
* @category Runtime Environment * @category Runtime
*/ */
export const noColor: boolean; export const noColor: boolean;
@ -497,7 +497,7 @@ declare namespace Deno {
* it should depend sys-info, which may not be desirable. * it should depend sys-info, which may not be desirable.
* *
* @tags allow-sys * @tags allow-sys
* @category Runtime Environment * @category Runtime
*/ */
export function osRelease(): string; export function osRelease(): string;
@ -511,7 +511,7 @@ declare namespace Deno {
* Requires `allow-sys` permission. * Requires `allow-sys` permission.
* *
* @tags allow-sys * @tags allow-sys
* @category Runtime Environment * @category Runtime
*/ */
export function osUptime(): number; export function osUptime(): number;
@ -1462,7 +1462,7 @@ declare namespace Deno {
* Deno.exit(5); * Deno.exit(5);
* ``` * ```
* *
* @category Runtime Environment * @category Runtime
*/ */
export function exit(code?: number): never; export function exit(code?: number): never;
@ -1470,7 +1470,7 @@ declare namespace Deno {
* variables. * variables.
* *
* @tags allow-env * @tags allow-env
* @category Runtime Environment * @category Runtime
*/ */
export interface Env { export interface Env {
/** Retrieve the value of an environment variable. /** Retrieve the value of an environment variable.
@ -1549,7 +1549,7 @@ declare namespace Deno {
* variables. * variables.
* *
* @tags allow-env * @tags allow-env
* @category Runtime Environment * @category Runtime
*/ */
export const env: Env; export const env: Env;
@ -1563,7 +1563,7 @@ declare namespace Deno {
* Requires `allow-read` permission. * Requires `allow-read` permission.
* *
* @tags allow-read * @tags allow-read
* @category Runtime Environment * @category Runtime
*/ */
export function execPath(): string; export function execPath(): string;
@ -1584,7 +1584,7 @@ declare namespace Deno {
* Requires `allow-read` permission. * Requires `allow-read` permission.
* *
* @tags allow-read * @tags allow-read
* @category Runtime Environment * @category Runtime
*/ */
export function chdir(directory: string | URL): void; export function chdir(directory: string | URL): void;
@ -1603,7 +1603,7 @@ declare namespace Deno {
* Requires `allow-read` permission. * Requires `allow-read` permission.
* *
* @tags allow-read * @tags allow-read
* @category Runtime Environment * @category Runtime
*/ */
export function cwd(): string; export function cwd(): string;
@ -4033,7 +4033,7 @@ declare namespace Deno {
*/ */
export function truncateSync(name: string, len?: number): void; export function truncateSync(name: string, len?: number): void;
/** @category Observability /** @category Runtime
* *
* @deprecated This will be removed in Deno 2.0. * @deprecated This will be removed in Deno 2.0.
*/ */
@ -4051,7 +4051,7 @@ declare namespace Deno {
bytesReceived: number; bytesReceived: number;
} }
/** @category Observability /** @category Runtime
* *
* @deprecated This will be removed in Deno 2.0. * @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. * @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. * @deprecated This will be removed in Deno 2.0.
* *
* @category Observability */ * @category Runtime */
export interface ResourceMap { export interface ResourceMap {
[rid: number]: unknown; [rid: number]: unknown;
} }
@ -4114,7 +4114,7 @@ declare namespace Deno {
* *
* @deprecated This will be removed in Deno 2.0. * @deprecated This will be removed in Deno 2.0.
* *
* @category Observability * @category Runtime
*/ */
export function resources(): ResourceMap; export function resources(): ResourceMap;
@ -4392,7 +4392,7 @@ declare namespace Deno {
/** Operating signals which can be listened for or sent to sub-processes. What /** Operating signals which can be listened for or sent to sub-processes. What
* signals and what their standard behaviors are OS dependent. * signals and what their standard behaviors are OS dependent.
* *
* @category Runtime Environment */ * @category Runtime */
export type Signal = export type Signal =
| "SIGABRT" | "SIGABRT"
| "SIGALRM" | "SIGALRM"
@ -4443,7 +4443,7 @@ declare namespace Deno {
* _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break) * _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break)
* are supported. * are supported.
* *
* @category Runtime Environment * @category Runtime
*/ */
export function addSignalListener(signal: Signal, handler: () => void): void; 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) * _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break)
* are supported. * are supported.
* *
* @category Runtime Environment * @category Runtime
*/ */
export function removeSignalListener( export function removeSignalListener(
signal: Signal, signal: Signal,
@ -4745,7 +4745,7 @@ declare namespace Deno {
/** Option which can be specified when performing {@linkcode Deno.inspect}. /** Option which can be specified when performing {@linkcode Deno.inspect}.
* *
* @category Console and Debugging */ * @category I/O */
export interface InspectOptions { export interface InspectOptions {
/** Stylize output with ANSI colors. /** Stylize output with ANSI colors.
* *
@ -4831,7 +4831,7 @@ declare namespace Deno {
* Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } } * 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; 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. * The intended use for the information is for logging and debugging purposes.
* *
* @category Runtime Environment * @category Runtime
*/ */
export const build: { export const build: {
/** The [LLVM](https://llvm.org/) target triple, which is the combination /** 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. * The intended use for the information is for logging and debugging purposes.
* *
* @category Runtime Environment * @category Runtime
*/ */
export const version: { export const version: {
/** Deno CLI's version. For example: `"1.26.0"`. */ /** 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 * [`parseArgs()`](https://jsr.io/@std/cli/doc/parse-args/~/parseArgs) from
* the Deno Standard Library. * the Deno Standard Library.
* *
* @category Runtime Environment * @category Runtime
*/ */
export const args: string[]; 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} * {@link https://docs.deno.com/runtime/manual/advanced/migrate_deprecations | Deno 1.x to 2.x Migration Guide}
* for migration instructions. * for migration instructions.
* *
* @category Console and Debugging * @category I/O
*/ */
export const customInspect: unique symbol; export const customInspect: unique symbol;
@ -5335,7 +5335,7 @@ declare namespace Deno {
* Also see {@linkcode ImportMeta} for other related information. * Also see {@linkcode ImportMeta} for other related information.
* *
* @tags allow-read * @tags allow-read
* @category Runtime Environment * @category Runtime
*/ */
export const mainModule: string; export const mainModule: string;
@ -6178,14 +6178,14 @@ declare namespace Deno {
/** /**
* Make the timer of the given `id` block the event loop from finishing. * Make the timer of the given `id` block the event loop from finishing.
* *
* @category Timers * @category Runtime
*/ */
export function refTimer(id: number): void; export function refTimer(id: number): void;
/** /**
* Make the timer of the given `id` not block the event loop from finishing. * Make the timer of the given `id` not block the event loop from finishing.
* *
* @category Timers * @category Runtime
*/ */
export function unrefTimer(id: number): void; export function unrefTimer(id: number): void;
@ -6199,7 +6199,7 @@ declare namespace Deno {
* Requires `allow-sys` permission. * Requires `allow-sys` permission.
* *
* @tags allow-sys * @tags allow-sys
* @category Runtime Environment * @category Runtime
*/ */
export function uid(): number | null; export function uid(): number | null;
@ -6213,7 +6213,7 @@ declare namespace Deno {
* Requires `allow-sys` permission. * Requires `allow-sys` permission.
* *
* @tags allow-sys * @tags allow-sys
* @category Runtime Environment * @category Runtime
*/ */
export function gid(): number | null; export function gid(): number | null;

108
cli/tsc/dts/lib.deno.shared_globals.d.ts vendored
View file

@ -14,14 +14,14 @@
/// <reference lib="deno.websocket" /> /// <reference lib="deno.websocket" />
/// <reference lib="deno.crypto" /> /// <reference lib="deno.crypto" />
/** @category WebAssembly */ /** @category WASM */
declare namespace WebAssembly { declare namespace WebAssembly {
/** /**
* The `WebAssembly.CompileError` object indicates an error during WebAssembly decoding or validation. * 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/CompileError)
* *
* @category WebAssembly * @category WASM
*/ */
export class CompileError extends Error { export class CompileError extends Error {
/** Creates a new `WebAssembly.CompileError` object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Global)
* *
* @category WebAssembly * @category WASM
*/ */
export class Global { export class Global {
/** Creates a new `Global` object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Instance)
* *
* @category WebAssembly * @category WASM
*/ */
export class Instance { export class Instance {
/** Creates a new Instance object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/LinkError)
* *
* @category WebAssembly * @category WASM
*/ */
export class LinkError extends Error { export class LinkError extends Error {
/** Creates a new WebAssembly.LinkError object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Memory)
* *
* @category WebAssembly * @category WASM
*/ */
export class Memory { export class Memory {
/** Creates a new `Memory` object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module)
* *
* @category WebAssembly * @category WASM
*/ */
export class Module { export class Module {
/** Creates a new `Module` object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/RuntimeError)
* *
* @category WebAssembly * @category WASM
*/ */
export class RuntimeError extends Error { export class RuntimeError extends Error {
/** Creates a new `WebAssembly.RuntimeError` object. */ /** 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) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Table)
* *
* @category WebAssembly * @category WASM
*/ */
export class Table { export class Table {
/** Creates a new `Table` object. */ /** Creates a new `Table` object. */
@ -181,7 +181,7 @@ declare namespace WebAssembly {
/** The `GlobalDescriptor` describes the options you can pass to /** The `GlobalDescriptor` describes the options you can pass to
* `new WebAssembly.Global()`. * `new WebAssembly.Global()`.
* *
* @category WebAssembly * @category WASM
*/ */
export interface GlobalDescriptor { export interface GlobalDescriptor {
mutable?: boolean; mutable?: boolean;
@ -191,7 +191,7 @@ declare namespace WebAssembly {
/** The `MemoryDescriptor` describes the options you can pass to /** The `MemoryDescriptor` describes the options you can pass to
* `new WebAssembly.Memory()`. * `new WebAssembly.Memory()`.
* *
* @category WebAssembly * @category WASM
*/ */
export interface MemoryDescriptor { export interface MemoryDescriptor {
initial: number; initial: number;
@ -202,7 +202,7 @@ declare namespace WebAssembly {
/** A `ModuleExportDescriptor` is the description of a declared export in a /** A `ModuleExportDescriptor` is the description of a declared export in a
* `WebAssembly.Module`. * `WebAssembly.Module`.
* *
* @category WebAssembly * @category WASM
*/ */
export interface ModuleExportDescriptor { export interface ModuleExportDescriptor {
kind: ImportExportKind; kind: ImportExportKind;
@ -212,7 +212,7 @@ declare namespace WebAssembly {
/** A `ModuleImportDescriptor` is the description of a declared import in a /** A `ModuleImportDescriptor` is the description of a declared import in a
* `WebAssembly.Module`. * `WebAssembly.Module`.
* *
* @category WebAssembly * @category WASM
*/ */
export interface ModuleImportDescriptor { export interface ModuleImportDescriptor {
kind: ImportExportKind; kind: ImportExportKind;
@ -223,7 +223,7 @@ declare namespace WebAssembly {
/** The `TableDescriptor` describes the options you can pass to /** The `TableDescriptor` describes the options you can pass to
* `new WebAssembly.Table()`. * `new WebAssembly.Table()`.
* *
* @category WebAssembly * @category WASM
*/ */
export interface TableDescriptor { export interface TableDescriptor {
element: TableKind; element: TableKind;
@ -233,7 +233,7 @@ declare namespace WebAssembly {
/** The value returned from `WebAssembly.instantiate`. /** The value returned from `WebAssembly.instantiate`.
* *
* @category WebAssembly * @category WASM
*/ */
export interface WebAssemblyInstantiatedSource { export interface WebAssemblyInstantiatedSource {
/* A `WebAssembly.Instance` object that contains all the exported WebAssembly functions. */ /* A `WebAssembly.Instance` object that contains all the exported WebAssembly functions. */
@ -246,21 +246,21 @@ declare namespace WebAssembly {
module: Module; module: Module;
} }
/** @category WebAssembly */ /** @category WASM */
export type ImportExportKind = "function" | "global" | "memory" | "table"; export type ImportExportKind = "function" | "global" | "memory" | "table";
/** @category WebAssembly */ /** @category WASM */
export type TableKind = "anyfunc"; export type TableKind = "anyfunc";
/** @category WebAssembly */ /** @category WASM */
export type ValueType = "f32" | "f64" | "i32" | "i64"; export type ValueType = "f32" | "f64" | "i32" | "i64";
/** @category WebAssembly */ /** @category WASM */
export type ExportValue = Function | Global | Memory | Table; export type ExportValue = Function | Global | Memory | Table;
/** @category WebAssembly */ /** @category WASM */
export type Exports = Record<string, ExportValue>; export type Exports = Record<string, ExportValue>;
/** @category WebAssembly */ /** @category WASM */
export type ImportValue = ExportValue | number; export type ImportValue = ExportValue | number;
/** @category WebAssembly */ /** @category WASM */
export type ModuleImports = Record<string, ImportValue>; export type ModuleImports = Record<string, ImportValue>;
/** @category WebAssembly */ /** @category WASM */
export type Imports = Record<string, ModuleImports>; export type Imports = Record<string, ModuleImports>;
/** /**
@ -271,7 +271,7 @@ declare namespace WebAssembly {
* *
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/compile) * [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<Module>; export function compile(bytes: BufferSource): Promise<Module>;
@ -283,7 +283,7 @@ declare namespace WebAssembly {
* *
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/compileStreaming) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/compileStreaming)
* *
* @category WebAssembly * @category WASM
*/ */
export function compileStreaming( export function compileStreaming(
source: Response | Promise<Response>, source: Response | Promise<Response>,
@ -300,7 +300,7 @@ declare namespace WebAssembly {
* *
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate)
* *
* @category WebAssembly * @category WASM
*/ */
export function instantiate( export function instantiate(
bytes: BufferSource, bytes: BufferSource,
@ -317,7 +317,7 @@ declare namespace WebAssembly {
* *
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate)
* *
* @category WebAssembly * @category WASM
*/ */
export function instantiate( export function instantiate(
moduleObject: Module, moduleObject: Module,
@ -331,7 +331,7 @@ declare namespace WebAssembly {
* *
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiateStreaming) * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiateStreaming)
* *
* @category WebAssembly * @category WASM
*/ */
export function instantiateStreaming( export function instantiateStreaming(
response: Response | PromiseLike<Response>, response: Response | PromiseLike<Response>,
@ -345,7 +345,7 @@ declare namespace WebAssembly {
* *
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/validate) * [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; export function validate(bytes: BufferSource): boolean;
} }
@ -357,7 +357,7 @@ declare namespace WebAssembly {
* setTimeout(() => { console.log('hello'); }, 500); * setTimeout(() => { console.log('hello'); }, 500);
* ``` * ```
* *
* @category Timers * @category Platform
*/ */
declare function setTimeout( declare function setTimeout(
/** callback function to execute when timer expires */ /** callback function to execute when timer expires */
@ -375,7 +375,7 @@ declare function setTimeout(
* setInterval(() => { console.log('hello'); }, 500); * setInterval(() => { console.log('hello'); }, 500);
* ``` * ```
* *
* @category Timers * @category Platform
*/ */
declare function setInterval( declare function setInterval(
/** callback function to execute when timer expires */ /** callback function to execute when timer expires */
@ -395,7 +395,7 @@ declare function setInterval(
* clearInterval(id); * clearInterval(id);
* ``` * ```
* *
* @category Timers * @category Platform
*/ */
declare function clearInterval(id?: number): void; declare function clearInterval(id?: number): void;
@ -407,11 +407,11 @@ declare function clearInterval(id?: number): void;
* clearTimeout(id); * clearTimeout(id);
* ``` * ```
* *
* @category Timers * @category Platform
*/ */
declare function clearTimeout(id?: number): void; declare function clearTimeout(id?: number): void;
/** @category Scheduling */ /** @category Platform */
declare interface VoidFunction { declare interface VoidFunction {
(): void; (): void;
} }
@ -426,7 +426,7 @@ declare interface VoidFunction {
* queueMicrotask(() => { console.log('This event loop stack is complete'); }); * queueMicrotask(() => { console.log('This event loop stack is complete'); });
* ``` * ```
* *
* @category Scheduling * @category Platform
*/ */
declare function queueMicrotask(func: VoidFunction): void; declare function queueMicrotask(func: VoidFunction): void;
@ -439,11 +439,11 @@ declare function queueMicrotask(func: VoidFunction): void;
* dispatchEvent(new Event('unload')); * dispatchEvent(new Event('unload'));
* ``` * ```
* *
* @category DOM Events * @category Events
*/ */
declare function dispatchEvent(event: Event): boolean; declare function dispatchEvent(event: Event): boolean;
/** @category DOM APIs */ /** @category Platform */
declare interface DOMStringList { declare interface DOMStringList {
/** Returns the number of strings in strings. */ /** Returns the number of strings in strings. */
readonly length: number; readonly length: number;
@ -454,13 +454,13 @@ declare interface DOMStringList {
[index: number]: string; [index: number]: string;
} }
/** @category Typed Arrays */ /** @category Platform */
declare type BufferSource = ArrayBufferView | ArrayBuffer; declare type BufferSource = ArrayBufferView | ArrayBuffer;
/** @category Console and Debugging */ /** @category I/O */
declare var console: Console; declare var console: Console;
/** @category DOM Events */ /** @category Events */
declare interface ErrorEventInit extends EventInit { declare interface ErrorEventInit extends EventInit {
message?: string; message?: string;
filename?: string; filename?: string;
@ -469,7 +469,7 @@ declare interface ErrorEventInit extends EventInit {
error?: any; error?: any;
} }
/** @category DOM Events */ /** @category Events */
declare interface ErrorEvent extends Event { declare interface ErrorEvent extends Event {
readonly message: string; readonly message: string;
readonly filename: string; readonly filename: string;
@ -478,25 +478,25 @@ declare interface ErrorEvent extends Event {
readonly error: any; readonly error: any;
} }
/** @category DOM Events */ /** @category Events */
declare var ErrorEvent: { declare var ErrorEvent: {
readonly prototype: ErrorEvent; readonly prototype: ErrorEvent;
new (type: string, eventInitDict?: ErrorEventInit): ErrorEvent; new (type: string, eventInitDict?: ErrorEventInit): ErrorEvent;
}; };
/** @category Observability */ /** @category Events */
declare interface PromiseRejectionEventInit extends EventInit { declare interface PromiseRejectionEventInit extends EventInit {
promise: Promise<any>; promise: Promise<any>;
reason?: any; reason?: any;
} }
/** @category Observability */ /** @category Events */
declare interface PromiseRejectionEvent extends Event { declare interface PromiseRejectionEvent extends Event {
readonly promise: Promise<any>; readonly promise: Promise<any>;
readonly reason: any; readonly reason: any;
} }
/** @category Observability */ /** @category Events */
declare var PromiseRejectionEvent: { declare var PromiseRejectionEvent: {
readonly prototype: PromiseRejectionEvent; readonly prototype: PromiseRejectionEvent;
new ( new (
@ -505,24 +505,24 @@ declare var PromiseRejectionEvent: {
): PromiseRejectionEvent; ): PromiseRejectionEvent;
}; };
/** @category Web Workers */ /** @category Workers */
declare interface AbstractWorkerEventMap { declare interface AbstractWorkerEventMap {
"error": ErrorEvent; "error": ErrorEvent;
} }
/** @category Web Workers */ /** @category Workers */
declare interface WorkerEventMap extends AbstractWorkerEventMap { declare interface WorkerEventMap extends AbstractWorkerEventMap {
"message": MessageEvent; "message": MessageEvent;
"messageerror": MessageEvent; "messageerror": MessageEvent;
} }
/** @category Web Workers */ /** @category Workers */
declare interface WorkerOptions { declare interface WorkerOptions {
type?: "classic" | "module"; type?: "classic" | "module";
name?: string; name?: string;
} }
/** @category Web Workers */ /** @category Workers */
declare interface Worker extends EventTarget { declare interface Worker extends EventTarget {
onerror: (this: Worker, e: ErrorEvent) => any | null; onerror: (this: Worker, e: ErrorEvent) => any | null;
onmessage: (this: Worker, e: MessageEvent) => any | null; onmessage: (this: Worker, e: MessageEvent) => any | null;
@ -552,7 +552,7 @@ declare interface Worker extends EventTarget {
terminate(): void; terminate(): void;
} }
/** @category Web Workers */ /** @category Workers */
declare var Worker: { declare var Worker: {
readonly prototype: Worker; readonly prototype: Worker;
new (specifier: string | URL, options?: WorkerOptions): Worker; new (specifier: string | URL, options?: WorkerOptions): Worker;
@ -719,25 +719,25 @@ declare var PerformanceMeasure: {
new (): never; new (): never;
}; };
/** @category DOM Events */ /** @category Events */
declare interface CustomEventInit<T = any> extends EventInit { declare interface CustomEventInit<T = any> extends EventInit {
detail?: T; detail?: T;
} }
/** @category DOM Events */ /** @category Events */
declare interface CustomEvent<T = any> extends Event { declare interface CustomEvent<T = any> extends Event {
/** Returns any custom data event was created with. Typically used for /** Returns any custom data event was created with. Typically used for
* synthetic events. */ * synthetic events. */
readonly detail: T; readonly detail: T;
} }
/** @category DOM Events */ /** @category Events */
declare var CustomEvent: { declare var CustomEvent: {
readonly prototype: CustomEvent; readonly prototype: CustomEvent;
new <T>(typeArg: string, eventInitDict?: CustomEventInit<T>): CustomEvent<T>; new <T>(typeArg: string, eventInitDict?: CustomEventInit<T>): CustomEvent<T>;
}; };
/** @category DOM APIs */ /** @category Platform */
declare interface ErrorConstructor { declare interface ErrorConstructor {
/** See https://v8.dev/docs/stack-trace-api#stack-trace-collection-for-custom-exceptions. */ /** See https://v8.dev/docs/stack-trace-api#stack-trace-collection-for-custom-exceptions. */
captureStackTrace(error: Object, constructor?: Function): void; captureStackTrace(error: Object, constructor?: Function): void;

94
cli/tsc/dts/lib.deno.unstable.d.ts vendored
View file

@ -843,7 +843,7 @@ declare namespace Deno {
* | "x11" (Linux) | Xlib `Window` | Xlib `Display*` | * | "x11" (Linux) | Xlib `Window` | Xlib `Display*` |
* | "wayland" (Linux) | `wl_surface*` | `wl_display*` | * | "wayland" (Linux) | `wl_surface*` | `wl_display*` |
* *
* @category WebGPU * @category GPU
* @tags unstable * @tags unstable
*/ */
export class UnsafeWindowSurface { export class UnsafeWindowSurface {
@ -940,7 +940,7 @@ declare namespace Deno {
* const req = await fetch("https://myserver.com", { client }); * const req = await fetch("https://myserver.com", { client });
* ``` * ```
* *
* @category Fetch API * @category Fetch
* @tags unstable * @tags unstable
*/ */
export interface HttpClient extends Disposable { export interface HttpClient extends Disposable {
@ -952,7 +952,7 @@ declare namespace Deno {
* *
* The options used when creating a {@linkcode Deno.HttpClient}. * The options used when creating a {@linkcode Deno.HttpClient}.
* *
* @category Fetch API * @category Fetch
* @tags unstable * @tags unstable
*/ */
export interface CreateHttpClientOptions { export interface CreateHttpClientOptions {
@ -991,7 +991,7 @@ declare namespace Deno {
* The definition of a proxy when specifying * The definition of a proxy when specifying
* {@linkcode Deno.CreateHttpClientOptions}. * {@linkcode Deno.CreateHttpClientOptions}.
* *
* @category Fetch API * @category Fetch
* @tags unstable * @tags unstable
*/ */
export interface Proxy { export interface Proxy {
@ -1006,7 +1006,7 @@ declare namespace Deno {
* Basic authentication credentials to be used with a {@linkcode Deno.Proxy} * Basic authentication credentials to be used with a {@linkcode Deno.Proxy}
* server when specifying {@linkcode Deno.CreateHttpClientOptions}. * server when specifying {@linkcode Deno.CreateHttpClientOptions}.
* *
* @category Fetch API * @category Fetch
* @tags unstable * @tags unstable
*/ */
export interface BasicAuth { export interface BasicAuth {
@ -1035,7 +1035,7 @@ declare namespace Deno {
* const response = await fetch("https://myserver.com", { client }); * const response = await fetch("https://myserver.com", { client });
* ``` * ```
* *
* @category Fetch API * @category Fetch
* @tags unstable * @tags unstable
*/ */
export function createHttpClient( export function createHttpClient(
@ -1057,7 +1057,7 @@ declare namespace Deno {
* const response = await fetch("https://myserver.com", { client }); * const response = await fetch("https://myserver.com", { client });
* ``` * ```
* *
* @category Fetch API * @category Fetch
* @tags unstable * @tags unstable
*/ */
export function createHttpClient( export function createHttpClient(
@ -1269,7 +1269,7 @@ declare namespace Deno {
* can be found in the Deno Manual. * can be found in the Deno Manual.
* *
* @tags allow-read, allow-write, unstable * @tags allow-read, allow-write, unstable
* @category KV * @category Cloud
*/ */
export function openKv(path?: string): Promise<Deno.Kv>; export function openKv(path?: string): Promise<Deno.Kv>;
@ -1277,7 +1277,7 @@ declare namespace Deno {
* *
* CronScheduleExpression is used as the type of `minute`, `hour`, * CronScheduleExpression is used as the type of `minute`, `hour`,
* `dayOfMonth`, `month`, and `dayOfWeek` in {@linkcode CronSchedule}. * `dayOfMonth`, `month`, and `dayOfWeek` in {@linkcode CronSchedule}.
* @category Cron * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type CronScheduleExpression = number | { exact: number | number[] } | { export type CronScheduleExpression = number | { exact: number | number[] } | {
@ -1290,7 +1290,7 @@ declare namespace Deno {
* *
* CronSchedule is the interface used for JSON format * CronSchedule is the interface used for JSON format
* cron `schedule`. * cron `schedule`.
* @category Cron * @category Cloud
* @tags unstable * @tags unstable
*/ */
export interface CronSchedule { export interface CronSchedule {
@ -1322,7 +1322,7 @@ declare namespace Deno {
* as specified by interface {@linkcode CronSchedule}, where time is specified * as specified by interface {@linkcode CronSchedule}, where time is specified
* using UTC time zone. * using UTC time zone.
* *
* @category Cron * @category Cloud
* @tags unstable * @tags unstable
*/ */
export function cron( export function cron(
@ -1354,7 +1354,7 @@ declare namespace Deno {
* means that a failed execution will be retried at most 3 times, with 1 * means that a failed execution will be retried at most 3 times, with 1
* second, 5 seconds, and 10 seconds delay between each retry. * second, 5 seconds, and 10 seconds delay between each retry.
* *
* @category Cron * @category Cloud
* @tags unstable * @tags unstable
*/ */
export function cron( export function cron(
@ -1379,7 +1379,7 @@ declare namespace Deno {
* exceeds this limit, an error will be thrown on the operation that this key * exceeds this limit, an error will be thrown on the operation that this key
* was passed to. * was passed to.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvKey = readonly KvKeyPart[]; 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 * `1.0` is a number and `0n` is a bigint, and type ordering has precedence
* over the ordering of values within a type. * over the ordering of values within a type.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvKeyPart = export type KvKeyPart =
@ -1434,7 +1434,7 @@ declare namespace Deno {
* - `strong` - This operation must be strongly-consistent. * - `strong` - This operation must be strongly-consistent.
* - `eventual` - Eventually-consistent behavior is allowed. * - `eventual` - Eventually-consistent behavior is allowed.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvConsistencyLevel = "strong" | "eventual"; 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 * starting at a given key). A range selector selects all keys that are
* lexicographically between the given start and end keys. * lexicographically between the given start and end keys.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvListSelector = export type KvListSelector =
@ -1488,7 +1488,7 @@ declare namespace Deno {
* existing value must be of type `Deno.KvU64`. If the key does not exist, * existing value must be of type `Deno.KvU64`. If the key does not exist,
* the value is set to the given value. * the value is set to the given value.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvMutation = export type KvMutation =
@ -1508,7 +1508,7 @@ declare namespace Deno {
* The cursor getter returns the cursor that can be used to resume the * The cursor getter returns the cursor that can be used to resume the
* iteration from the current position in the future. * iteration from the current position in the future.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export class KvListIterator<T> implements AsyncIterableIterator<KvEntry<T>> { export class KvListIterator<T> implements AsyncIterableIterator<KvEntry<T>> {
@ -1531,7 +1531,7 @@ declare namespace Deno {
* key-value pair. It can be used to perform atomic operations on the KV store * 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}. * by passing it to the `check` method of a {@linkcode Deno.AtomicOperation}.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvEntry<T> = { key: KvKey; value: T; versionstamp: string }; export type KvEntry<T> = { 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` * 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. * fields may be `null` if no value exists for the given key in the KV store.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export type KvEntryMaybe<T> = KvEntry<T> | { export type KvEntryMaybe<T> = KvEntry<T> | {
@ -1557,7 +1557,7 @@ declare namespace Deno {
* *
* Options for listing key-value pairs in a {@linkcode Deno.Kv}. * Options for listing key-value pairs in a {@linkcode Deno.Kv}.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export interface KvListOptions { export interface KvListOptions {
@ -1612,7 +1612,7 @@ declare namespace Deno {
} }
/** /**
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export interface KvCommitResult { export interface KvCommitResult {
@ -1622,7 +1622,7 @@ declare namespace Deno {
} }
/** /**
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export interface KvCommitError { export interface KvCommitError {
@ -1636,7 +1636,7 @@ declare namespace Deno {
* not match the given versionstamp. A check with a `null` versionstamp checks * 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. * that the key-value pair does not currently exist in the KV store.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export interface AtomicCheck { export interface AtomicCheck {
@ -1678,7 +1678,7 @@ declare namespace Deno {
* will be a {@linkcode Deno.KvCommitResult} object with a `ok: true` property * will be a {@linkcode Deno.KvCommitResult} object with a `ok: true` property
* and the versionstamp of the value committed to KV. * and the versionstamp of the value committed to KV.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export class AtomicOperation { export class AtomicOperation {
@ -1795,7 +1795,7 @@ declare namespace Deno {
* of a JSON serialization of that same value. If theses limits are exceeded, * of a JSON serialization of that same value. If theses limits are exceeded,
* an exception will be thrown. * an exception will be thrown.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export class Kv implements Disposable { 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 * Wrapper type for 64-bit unsigned integers for use as values in a
* {@linkcode Deno.Kv}. * {@linkcode Deno.Kv}.
* *
* @category KV * @category Cloud
* @tags unstable * @tags unstable
*/ */
export class KvU64 { export class KvU64 {
@ -2283,7 +2283,7 @@ declare namespace Deno {
* way to connect via proxies and use custom TLS certificates. * way to connect via proxies and use custom TLS certificates.
* *
* @tags allow-net, allow-read, unstable * @tags allow-net, allow-read, unstable
* @category Fetch API * @category Fetch
*/ */
declare function fetch( declare function fetch(
input: Request | URL | string, input: Request | URL | string,
@ -2292,7 +2292,7 @@ declare function fetch(
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @category Web Workers * @category Workers
* @tags unstable * @tags unstable
*/ */
declare interface WorkerOptions { declare interface WorkerOptions {
@ -2333,7 +2333,7 @@ declare interface WorkerOptions {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @category Web Sockets * @category WebSockets
* @tags unstable * @tags unstable
*/ */
declare interface WebSocketStreamOptions { declare interface WebSocketStreamOptions {
@ -2344,7 +2344,7 @@ declare interface WebSocketStreamOptions {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @category Web Sockets * @category WebSockets
* @tags unstable * @tags unstable
*/ */
declare interface WebSocketConnection { declare interface WebSocketConnection {
@ -2356,7 +2356,7 @@ declare interface WebSocketConnection {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @category Web Sockets * @category WebSockets
* @tags unstable * @tags unstable
*/ */
declare interface WebSocketCloseInfo { declare interface WebSocketCloseInfo {
@ -2367,7 +2367,7 @@ declare interface WebSocketCloseInfo {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @tags allow-net, unstable * @tags allow-net, unstable
* @category Web Sockets * @category WebSockets
*/ */
declare interface WebSocketStream { declare interface WebSocketStream {
url: string; url: string;
@ -2379,7 +2379,7 @@ declare interface WebSocketStream {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @tags allow-net, unstable * @tags allow-net, unstable
* @category Web Sockets * @category WebSockets
*/ */
declare var WebSocketStream: { declare var WebSocketStream: {
readonly prototype: WebSocketStream; readonly prototype: WebSocketStream;
@ -2389,7 +2389,7 @@ declare var WebSocketStream: {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @tags allow-net, unstable * @tags allow-net, unstable
* @category Web Sockets * @category WebSockets
*/ */
declare interface WebSocketError extends DOMException { declare interface WebSocketError extends DOMException {
readonly closeCode: number; readonly closeCode: number;
@ -2399,7 +2399,7 @@ declare interface WebSocketError extends DOMException {
/** **UNSTABLE**: New API, yet to be vetted. /** **UNSTABLE**: New API, yet to be vetted.
* *
* @tags allow-net, unstable * @tags allow-net, unstable
* @category Web Sockets * @category WebSockets
*/ */
declare var WebSocketError: { declare var WebSocketError: {
readonly prototype: 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 * 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. * of bytes could not be allocated an exception is raised.
* *
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16Array { declare interface Float16Array {
@ -4945,7 +4945,7 @@ declare interface Float16Array {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16ArrayConstructor { declare interface Float16ArrayConstructor {
@ -4988,13 +4988,13 @@ declare interface Float16ArrayConstructor {
): Float16Array; ): Float16Array;
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare var Float16Array: Float16ArrayConstructor; declare var Float16Array: Float16ArrayConstructor;
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16 { declare interface Float16 {
@ -5014,7 +5014,7 @@ declare interface Float16 {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16Constructor { declare interface Float16Constructor {
@ -5034,7 +5034,7 @@ declare interface Float16Constructor {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16Array { declare interface Float16Array {
@ -5042,7 +5042,7 @@ declare interface Float16Array {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16Array { declare interface Float16Array {
@ -5055,7 +5055,7 @@ declare interface Float16Array {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16ArrayConstructor { declare interface Float16ArrayConstructor {
@ -5063,7 +5063,7 @@ declare interface Float16ArrayConstructor {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16Array { declare interface Float16Array {
@ -5075,7 +5075,7 @@ declare interface Float16Array {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface Float16Array { declare interface Float16Array {
@ -5151,7 +5151,7 @@ declare interface Float16Array {
} }
/** /**
* @category Web APIs * @category Platform
* @tags unstable * @tags unstable
*/ */
declare interface DataView { declare interface DataView {

58
cli/tsc/dts/lib.deno.window.d.ts vendored
View file

@ -7,14 +7,14 @@
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/// <reference lib="deno.cache" /> /// <reference lib="deno.cache" />
/** @category Web APIs */ /** @category Platform */
declare interface WindowEventMap { declare interface WindowEventMap {
"error": ErrorEvent; "error": ErrorEvent;
"unhandledrejection": PromiseRejectionEvent; "unhandledrejection": PromiseRejectionEvent;
"rejectionhandled": PromiseRejectionEvent; "rejectionhandled": PromiseRejectionEvent;
} }
/** @category Web APIs */ /** @category Platform */
declare interface Window extends EventTarget { declare interface Window extends EventTarget {
readonly window: Window & typeof globalThis; readonly window: Window & typeof globalThis;
readonly self: Window & typeof globalThis; readonly self: Window & typeof globalThis;
@ -71,40 +71,40 @@ declare interface Window extends EventTarget {
): void; ): void;
} }
/** @category Web APIs */ /** @category Platform */
declare var Window: { declare var Window: {
readonly prototype: Window; readonly prototype: Window;
new (): never; new (): never;
}; };
/** @category Web APIs */ /** @category Platform */
declare var window: Window & typeof globalThis; declare var window: Window & typeof globalThis;
/** @category Web APIs */ /** @category Platform */
declare var self: Window & typeof globalThis; declare var self: Window & typeof globalThis;
/** @category Web APIs */ /** @category Platform */
declare var closed: boolean; declare var closed: boolean;
/** @category Web APIs */ /** @category Platform */
declare function close(): void; declare function close(): void;
/** @category DOM Events */ /** @category Events */
declare var onerror: ((this: Window, ev: ErrorEvent) => any) | null; declare var onerror: ((this: Window, ev: ErrorEvent) => any) | null;
/** @category DOM Events */ /** @category Events */
declare var onload: ((this: Window, ev: Event) => any) | null; declare var onload: ((this: Window, ev: Event) => any) | null;
/** @category DOM Events */ /** @category Events */
declare var onbeforeunload: ((this: Window, ev: Event) => any) | null; declare var onbeforeunload: ((this: Window, ev: Event) => any) | null;
/** @category DOM Events */ /** @category Events */
declare var onunload: ((this: Window, ev: Event) => any) | null; declare var onunload: ((this: Window, ev: Event) => any) | null;
/** @category Observability */ /** @category Events */
declare var onunhandledrejection: declare var onunhandledrejection:
| ((this: Window, ev: PromiseRejectionEvent) => any) | ((this: Window, ev: PromiseRejectionEvent) => any)
| null; | null;
/** @category Web Storage API */ /** @category Storage */
declare var localStorage: Storage; declare var localStorage: Storage;
/** @category Web Storage API */ /** @category Storage */
declare var sessionStorage: Storage; declare var sessionStorage: Storage;
/** @category Cache API */ /** @category Cache */
declare var caches: CacheStorage; declare var caches: CacheStorage;
/** @category Web APIs */ /** @category Platform */
declare interface Navigator { declare interface Navigator {
readonly gpu: GPU; readonly gpu: GPU;
readonly hardwareConcurrency: number; readonly hardwareConcurrency: number;
@ -113,13 +113,13 @@ declare interface Navigator {
readonly languages: string[]; readonly languages: string[];
} }
/** @category Web APIs */ /** @category Platform */
declare var Navigator: { declare var Navigator: {
readonly prototype: Navigator; readonly prototype: Navigator;
new (): never; new (): never;
}; };
/** @category Web APIs */ /** @category Platform */
declare var navigator: Navigator; declare var navigator: Navigator;
/** /**
@ -127,7 +127,7 @@ declare var navigator: Navigator;
* *
* If the stdin is not interactive, it does nothing. * If the stdin is not interactive, it does nothing.
* *
* @category Web APIs * @category Platform
* *
* @param message * @param message
*/ */
@ -140,7 +140,7 @@ declare function alert(message?: string): void;
* *
* If the stdin is not interactive, it returns false. * If the stdin is not interactive, it returns false.
* *
* @category Web APIs * @category Platform
* *
* @param message * @param message
*/ */
@ -157,7 +157,7 @@ declare function confirm(message?: string): boolean;
* *
* If the stdin is not interactive, it returns null. * If the stdin is not interactive, it returns null.
* *
* @category Web APIs * @category Platform
* *
* @param message * @param message
* @param defaultValue * @param defaultValue
@ -173,7 +173,7 @@ declare function prompt(message?: string, defaultValue?: string): string | null;
* dispatchEvent(new Event('unload')); * dispatchEvent(new Event('unload'));
* ``` * ```
* *
* @category DOM Events * @category Events
*/ */
declare function addEventListener< declare function addEventListener<
K extends keyof WindowEventMap, K extends keyof WindowEventMap,
@ -182,7 +182,7 @@ declare function addEventListener<
listener: (this: Window, ev: WindowEventMap[K]) => any, listener: (this: Window, ev: WindowEventMap[K]) => any,
options?: boolean | AddEventListenerOptions, options?: boolean | AddEventListenerOptions,
): void; ): void;
/** @category DOM Events */ /** @category Events */
declare function addEventListener( declare function addEventListener(
type: string, type: string,
listener: EventListenerOrEventListenerObject, listener: EventListenerOrEventListenerObject,
@ -197,7 +197,7 @@ declare function addEventListener(
* removeEventListener('load', listener); * removeEventListener('load', listener);
* ``` * ```
* *
* @category DOM Events * @category Events
*/ */
declare function removeEventListener< declare function removeEventListener<
K extends keyof WindowEventMap, K extends keyof WindowEventMap,
@ -206,7 +206,7 @@ declare function removeEventListener<
listener: (this: Window, ev: WindowEventMap[K]) => any, listener: (this: Window, ev: WindowEventMap[K]) => any,
options?: boolean | EventListenerOptions, options?: boolean | EventListenerOptions,
): void; ): void;
/** @category DOM Events */ /** @category Events */
declare function removeEventListener( declare function removeEventListener(
type: string, type: string,
listener: EventListenerOrEventListenerObject, listener: EventListenerOrEventListenerObject,
@ -219,7 +219,7 @@ declare function removeEventListener(
* reflected on the object it relates to. Accessible via * reflected on the object it relates to. Accessible via
* `globalThis.location`. * `globalThis.location`.
* *
* @category Web APIs * @category Platform
*/ */
declare interface Location { declare interface Location {
/** Returns a DOMStringList object listing the origins of the ancestor /** 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 * reflected on the object it relates to. Accessible via
* `globalThis.location`. * `globalThis.location`.
* *
* @category Web APIs * @category Platform
*/ */
declare var Location: { declare var Location: {
readonly prototype: Location; readonly prototype: Location;
@ -298,8 +298,8 @@ declare var Location: {
// TODO(nayeemrmn): Move this to `extensions/web` where its implementation is. // TODO(nayeemrmn): Move this to `extensions/web` where its implementation is.
// The types there must first be split into window, worker and global types. // The types there must first be split into window, worker and global types.
/** @category Web APIs */ /** @category Platform */
declare var location: Location; declare var location: Location;
/** @category Web APIs */ /** @category Platform */
declare var name: string; declare var name: string;

50
cli/tsc/dts/lib.deno.worker.d.ts vendored
View file

@ -6,13 +6,13 @@
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/// <reference lib="deno.cache" /> /// <reference lib="deno.cache" />
/** @category Web Workers */ /** @category Workers */
declare interface WorkerGlobalScopeEventMap { declare interface WorkerGlobalScopeEventMap {
"error": ErrorEvent; "error": ErrorEvent;
"unhandledrejection": PromiseRejectionEvent; "unhandledrejection": PromiseRejectionEvent;
} }
/** @category Web Workers */ /** @category Workers */
declare interface WorkerGlobalScope extends EventTarget { declare interface WorkerGlobalScope extends EventTarget {
readonly location: WorkerLocation; readonly location: WorkerLocation;
readonly navigator: WorkerNavigator; readonly navigator: WorkerNavigator;
@ -54,13 +54,13 @@ declare interface WorkerGlobalScope extends EventTarget {
caches: CacheStorage; caches: CacheStorage;
} }
/** @category Web Workers */ /** @category Workers */
declare var WorkerGlobalScope: { declare var WorkerGlobalScope: {
readonly prototype: WorkerGlobalScope; readonly prototype: WorkerGlobalScope;
new (): never; new (): never;
}; };
/** @category Web APIs */ /** @category Platform */
declare interface WorkerNavigator { declare interface WorkerNavigator {
readonly gpu: GPU; readonly gpu: GPU;
readonly hardwareConcurrency: number; readonly hardwareConcurrency: number;
@ -69,23 +69,23 @@ declare interface WorkerNavigator {
readonly languages: string[]; readonly languages: string[];
} }
/** @category Web APIs */ /** @category Platform */
declare var WorkerNavigator: { declare var WorkerNavigator: {
readonly prototype: WorkerNavigator; readonly prototype: WorkerNavigator;
new (): never; new (): never;
}; };
/** @category Web APIs */ /** @category Platform */
declare var navigator: WorkerNavigator; declare var navigator: WorkerNavigator;
/** @category Web Workers */ /** @category Workers */
declare interface DedicatedWorkerGlobalScopeEventMap declare interface DedicatedWorkerGlobalScopeEventMap
extends WorkerGlobalScopeEventMap { extends WorkerGlobalScopeEventMap {
"message": MessageEvent; "message": MessageEvent;
"messageerror": MessageEvent; "messageerror": MessageEvent;
} }
/** @category Web APIs */ /** @category Platform */
declare interface DedicatedWorkerGlobalScope extends WorkerGlobalScope { declare interface DedicatedWorkerGlobalScope extends WorkerGlobalScope {
readonly name: string; readonly name: string;
onmessage: onmessage:
@ -125,34 +125,34 @@ declare interface DedicatedWorkerGlobalScope extends WorkerGlobalScope {
): void; ): void;
} }
/** @category Web APIs */ /** @category Platform */
declare var DedicatedWorkerGlobalScope: { declare var DedicatedWorkerGlobalScope: {
readonly prototype: DedicatedWorkerGlobalScope; readonly prototype: DedicatedWorkerGlobalScope;
new (): never; new (): never;
}; };
/** @category Web Workers */ /** @category Workers */
declare var name: string; declare var name: string;
/** @category Web Workers */ /** @category Workers */
declare var onmessage: declare var onmessage:
| ((this: DedicatedWorkerGlobalScope, ev: MessageEvent) => any) | ((this: DedicatedWorkerGlobalScope, ev: MessageEvent) => any)
| null; | null;
/** @category Web Workers */ /** @category Workers */
declare var onmessageerror: declare var onmessageerror:
| ((this: DedicatedWorkerGlobalScope, ev: MessageEvent) => any) | ((this: DedicatedWorkerGlobalScope, ev: MessageEvent) => any)
| null; | null;
/** @category Web Workers */ /** @category Workers */
declare function close(): void; declare function close(): void;
/** @category Web Workers */ /** @category Workers */
declare function postMessage(message: any, transfer: Transferable[]): void; declare function postMessage(message: any, transfer: Transferable[]): void;
/** @category Web Workers */ /** @category Workers */
declare function postMessage( declare function postMessage(
message: any, message: any,
options?: StructuredSerializeOptions, options?: StructuredSerializeOptions,
): void; ): void;
/** @category Web APIs */ /** @category Platform */
declare var navigator: WorkerNavigator; declare var navigator: WorkerNavigator;
/** @category Web APIs */ /** @category Platform */
declare var onerror: declare var onerror:
| ((this: DedicatedWorkerGlobalScope, ev: ErrorEvent) => any) | ((this: DedicatedWorkerGlobalScope, ev: ErrorEvent) => any)
| null; | null;
@ -160,9 +160,9 @@ declare var onerror:
declare var onunhandledrejection: declare var onunhandledrejection:
| ((this: DedicatedWorkerGlobalScope, ev: PromiseRejectionEvent) => any) | ((this: DedicatedWorkerGlobalScope, ev: PromiseRejectionEvent) => any)
| null; | null;
/** @category Web Workers */ /** @category Workers */
declare var self: WorkerGlobalScope & typeof globalThis; declare var self: WorkerGlobalScope & typeof globalThis;
/** @category DOM Events */ /** @category Events */
declare function addEventListener< declare function addEventListener<
K extends keyof DedicatedWorkerGlobalScopeEventMap, K extends keyof DedicatedWorkerGlobalScopeEventMap,
>( >(
@ -173,13 +173,13 @@ declare function addEventListener<
) => any, ) => any,
options?: boolean | AddEventListenerOptions, options?: boolean | AddEventListenerOptions,
): void; ): void;
/** @category DOM Events */ /** @category Events */
declare function addEventListener( declare function addEventListener(
type: string, type: string,
listener: EventListenerOrEventListenerObject, listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions, options?: boolean | AddEventListenerOptions,
): void; ): void;
/** @category DOM Events */ /** @category Events */
declare function removeEventListener< declare function removeEventListener<
K extends keyof DedicatedWorkerGlobalScopeEventMap, K extends keyof DedicatedWorkerGlobalScopeEventMap,
>( >(
@ -190,7 +190,7 @@ declare function removeEventListener<
) => any, ) => any,
options?: boolean | EventListenerOptions, options?: boolean | EventListenerOptions,
): void; ): void;
/** @category DOM Events */ /** @category Events */
declare function removeEventListener( declare function removeEventListener(
type: string, type: string,
listener: EventListenerOrEventListenerObject, listener: EventListenerOrEventListenerObject,
@ -203,7 +203,7 @@ declare function removeEventListener(
* is initialized for each worker and is available via the * is initialized for each worker and is available via the
* WorkerGlobalScope.location property obtained by calling self.location. * WorkerGlobalScope.location property obtained by calling self.location.
* *
* @category Web APIs * @category Platform
*/ */
declare interface WorkerLocation { declare interface WorkerLocation {
readonly hash: string; readonly hash: string;
@ -224,7 +224,7 @@ declare interface WorkerLocation {
* is initialized for each worker and is available via the * is initialized for each worker and is available via the
* WorkerGlobalScope.location property obtained by calling self.location. * WorkerGlobalScope.location property obtained by calling self.location.
* *
* @category Web APIs * @category Platform
*/ */
declare var WorkerLocation: { declare var WorkerLocation: {
readonly prototype: WorkerLocation; readonly prototype: WorkerLocation;
@ -233,5 +233,5 @@ declare var WorkerLocation: {
// TODO(nayeemrmn): Move this to `extensions/web` where its implementation is. // TODO(nayeemrmn): Move this to `extensions/web` where its implementation is.
// The types there must first be split into window, worker and global types. // The types there must first be split into window, worker and global types.
/** @category Web APIs */ /** @category Platform */
declare var location: WorkerLocation; declare var location: WorkerLocation;

268
cli/tsc/dts/lib.deno_webgpu.d.ts vendored
View file

File diff suppressed because it is too large Load diff

6
ext/broadcast_channel/lib.deno_broadcast_channel.d.ts vendored
View file

@ -6,7 +6,7 @@
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** /**
* @category Broadcast Channel * @category Messaging
* @tags unstable * @tags unstable
*/ */
declare interface BroadcastChannelEventMap { declare interface BroadcastChannelEventMap {
@ -15,7 +15,7 @@ declare interface BroadcastChannelEventMap {
} }
/** /**
* @category Broadcast Channel * @category Messaging
* @tags unstable * @tags unstable
*/ */
declare interface BroadcastChannel extends EventTarget { declare interface BroadcastChannel extends EventTarget {
@ -58,7 +58,7 @@ declare interface BroadcastChannel extends EventTarget {
} }
/** /**
* @category Broadcast Channel * @category Messaging
* @tags unstable * @tags unstable
*/ */
declare var BroadcastChannel: { declare var BroadcastChannel: {

12
ext/cache/lib.deno_cache.d.ts vendored
View file

@ -5,10 +5,10 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Cache API */ /** @category Cache */
declare var caches: CacheStorage; declare var caches: CacheStorage;
/** @category Cache API */ /** @category Cache */
declare interface CacheStorage { declare interface CacheStorage {
/** Open a cache storage for the provided name. */ /** Open a cache storage for the provided name. */
open(cacheName: string): Promise<Cache>; open(cacheName: string): Promise<Cache>;
@ -18,7 +18,7 @@ declare interface CacheStorage {
delete(cacheName: string): Promise<boolean>; delete(cacheName: string): Promise<boolean>;
} }
/** @category Cache API */ /** @category Cache */
declare interface Cache { declare interface Cache {
/** /**
* Put the provided request/response into the cache. * Put the provided request/response into the cache.
@ -52,19 +52,19 @@ declare interface Cache {
): Promise<boolean>; ): Promise<boolean>;
} }
/** @category Cache API */ /** @category Cache */
declare var Cache: { declare var Cache: {
readonly prototype: Cache; readonly prototype: Cache;
new (): never; new (): never;
}; };
/** @category Cache API */ /** @category Cache */
declare var CacheStorage: { declare var CacheStorage: {
readonly prototype: CacheStorage; readonly prototype: CacheStorage;
new (): never; new (): never;
}; };
/** @category Cache API */ /** @category Cache */
declare interface CacheQueryOptions { declare interface CacheQueryOptions {
ignoreMethod?: boolean; ignoreMethod?: boolean;
ignoreSearch?: boolean; ignoreSearch?: boolean;

20
ext/canvas/lib.deno_canvas.d.ts vendored
View file

@ -5,22 +5,22 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Web APIs */ /** @category Canvas */
declare type ColorSpaceConversion = "default" | "none"; declare type ColorSpaceConversion = "default" | "none";
/** @category Web APIs */ /** @category Canvas */
declare type ImageOrientation = "flipY" | "from-image" | "none"; declare type ImageOrientation = "flipY" | "from-image" | "none";
/** @category Web APIs */ /** @category Canvas */
declare type PremultiplyAlpha = "default" | "none" | "premultiply"; declare type PremultiplyAlpha = "default" | "none" | "premultiply";
/** @category Web APIs */ /** @category Canvas */
declare type ResizeQuality = "high" | "low" | "medium" | "pixelated"; declare type ResizeQuality = "high" | "low" | "medium" | "pixelated";
/** @category Web APIs */ /** @category Canvas */
declare type ImageBitmapSource = Blob | ImageData; declare type ImageBitmapSource = Blob | ImageData;
/** @category Web APIs */ /** @category Canvas */
declare interface ImageBitmapOptions { declare interface ImageBitmapOptions {
colorSpaceConversion?: ColorSpaceConversion; colorSpaceConversion?: ColorSpaceConversion;
imageOrientation?: ImageOrientation; imageOrientation?: ImageOrientation;
@ -30,12 +30,12 @@ declare interface ImageBitmapOptions {
resizeWidth?: number; resizeWidth?: number;
} }
/** @category Web APIs */ /** @category Canvas */
declare function createImageBitmap( declare function createImageBitmap(
image: ImageBitmapSource, image: ImageBitmapSource,
options?: ImageBitmapOptions, options?: ImageBitmapOptions,
): Promise<ImageBitmap>; ): Promise<ImageBitmap>;
/** @category Web APIs */ /** @category Canvas */
declare function createImageBitmap( declare function createImageBitmap(
image: ImageBitmapSource, image: ImageBitmapSource,
sx: number, sx: number,
@ -45,14 +45,14 @@ declare function createImageBitmap(
options?: ImageBitmapOptions, options?: ImageBitmapOptions,
): Promise<ImageBitmap>; ): Promise<ImageBitmap>;
/** @category Web APIs */ /** @category Canvas */
declare interface ImageBitmap { declare interface ImageBitmap {
readonly height: number; readonly height: number;
readonly width: number; readonly width: number;
close(): void; close(): void;
} }
/** @category Web APIs */ /** @category Canvas */
declare var ImageBitmap: { declare var ImageBitmap: {
prototype: ImageBitmap; prototype: ImageBitmap;
new (): ImageBitmap; new (): ImageBitmap;

2
ext/console/lib.deno_console.d.ts vendored
View file

@ -5,7 +5,7 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Console and Debugging */ /** @category I/O */
declare interface Console { declare interface Console {
assert(condition?: boolean, ...data: any[]): void; assert(condition?: boolean, ...data: any[]): void;
clear(): void; clear(): void;

84
ext/crypto/lib.deno_crypto.d.ts vendored
View file

@ -5,26 +5,26 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Web Crypto API */ /** @category Crypto */
declare var crypto: Crypto; declare var crypto: Crypto;
/** @category Web Crypto API */ /** @category Crypto */
declare interface Algorithm { declare interface Algorithm {
name: string; name: string;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface KeyAlgorithm { declare interface KeyAlgorithm {
name: string; name: string;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare type AlgorithmIdentifier = string | Algorithm; declare type AlgorithmIdentifier = string | Algorithm;
/** @category Web Crypto API */ /** @category Crypto */
declare type HashAlgorithmIdentifier = AlgorithmIdentifier; declare type HashAlgorithmIdentifier = AlgorithmIdentifier;
/** @category Web Crypto API */ /** @category Crypto */
declare type KeyType = "private" | "public" | "secret"; declare type KeyType = "private" | "public" | "secret";
/** @category Web Crypto API */ /** @category Crypto */
declare type KeyUsage = declare type KeyUsage =
| "decrypt" | "decrypt"
| "deriveBits" | "deriveBits"
@ -34,19 +34,19 @@ declare type KeyUsage =
| "unwrapKey" | "unwrapKey"
| "verify" | "verify"
| "wrapKey"; | "wrapKey";
/** @category Web Crypto API */ /** @category Crypto */
declare type KeyFormat = "jwk" | "pkcs8" | "raw" | "spki"; declare type KeyFormat = "jwk" | "pkcs8" | "raw" | "spki";
/** @category Web Crypto API */ /** @category Crypto */
declare type NamedCurve = string; declare type NamedCurve = string;
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaOtherPrimesInfo { declare interface RsaOtherPrimesInfo {
d?: string; d?: string;
r?: string; r?: string;
t?: string; t?: string;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface JsonWebKey { declare interface JsonWebKey {
alg?: string; alg?: string;
crv?: string; crv?: string;
@ -68,129 +68,129 @@ declare interface JsonWebKey {
y?: string; y?: string;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface AesCbcParams extends Algorithm { declare interface AesCbcParams extends Algorithm {
iv: BufferSource; iv: BufferSource;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface AesGcmParams extends Algorithm { declare interface AesGcmParams extends Algorithm {
iv: BufferSource; iv: BufferSource;
additionalData?: BufferSource; additionalData?: BufferSource;
tagLength?: number; tagLength?: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface AesCtrParams extends Algorithm { declare interface AesCtrParams extends Algorithm {
counter: BufferSource; counter: BufferSource;
length: number; length: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface HmacKeyGenParams extends Algorithm { declare interface HmacKeyGenParams extends Algorithm {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
length?: number; length?: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface EcKeyGenParams extends Algorithm { declare interface EcKeyGenParams extends Algorithm {
namedCurve: NamedCurve; namedCurve: NamedCurve;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface EcKeyImportParams extends Algorithm { declare interface EcKeyImportParams extends Algorithm {
namedCurve: NamedCurve; namedCurve: NamedCurve;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface EcdsaParams extends Algorithm { declare interface EcdsaParams extends Algorithm {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaHashedImportParams extends Algorithm { declare interface RsaHashedImportParams extends Algorithm {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaHashedKeyGenParams extends RsaKeyGenParams { declare interface RsaHashedKeyGenParams extends RsaKeyGenParams {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaKeyGenParams extends Algorithm { declare interface RsaKeyGenParams extends Algorithm {
modulusLength: number; modulusLength: number;
publicExponent: Uint8Array; publicExponent: Uint8Array;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaPssParams extends Algorithm { declare interface RsaPssParams extends Algorithm {
saltLength: number; saltLength: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaOaepParams extends Algorithm { declare interface RsaOaepParams extends Algorithm {
label?: Uint8Array; label?: Uint8Array;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface HmacImportParams extends Algorithm { declare interface HmacImportParams extends Algorithm {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
length?: number; length?: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface EcKeyAlgorithm extends KeyAlgorithm { declare interface EcKeyAlgorithm extends KeyAlgorithm {
namedCurve: NamedCurve; namedCurve: NamedCurve;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface HmacKeyAlgorithm extends KeyAlgorithm { declare interface HmacKeyAlgorithm extends KeyAlgorithm {
hash: KeyAlgorithm; hash: KeyAlgorithm;
length: number; length: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaHashedKeyAlgorithm extends RsaKeyAlgorithm { declare interface RsaHashedKeyAlgorithm extends RsaKeyAlgorithm {
hash: KeyAlgorithm; hash: KeyAlgorithm;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface RsaKeyAlgorithm extends KeyAlgorithm { declare interface RsaKeyAlgorithm extends KeyAlgorithm {
modulusLength: number; modulusLength: number;
publicExponent: Uint8Array; publicExponent: Uint8Array;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface HkdfParams extends Algorithm { declare interface HkdfParams extends Algorithm {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
info: BufferSource; info: BufferSource;
salt: BufferSource; salt: BufferSource;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface Pbkdf2Params extends Algorithm { declare interface Pbkdf2Params extends Algorithm {
hash: HashAlgorithmIdentifier; hash: HashAlgorithmIdentifier;
iterations: number; iterations: number;
salt: BufferSource; salt: BufferSource;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface AesDerivedKeyParams extends Algorithm { declare interface AesDerivedKeyParams extends Algorithm {
length: number; length: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface EcdhKeyDeriveParams extends Algorithm { declare interface EcdhKeyDeriveParams extends Algorithm {
public: CryptoKey; public: CryptoKey;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface AesKeyGenParams extends Algorithm { declare interface AesKeyGenParams extends Algorithm {
length: number; length: number;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare interface AesKeyAlgorithm extends KeyAlgorithm { declare interface AesKeyAlgorithm extends KeyAlgorithm {
length: number; length: number;
} }
@ -198,7 +198,7 @@ declare interface AesKeyAlgorithm extends KeyAlgorithm {
/** The CryptoKey dictionary of the Web Crypto API represents a cryptographic /** The CryptoKey dictionary of the Web Crypto API represents a cryptographic
* key. * key.
* *
* @category Web Crypto API * @category Crypto
*/ */
declare interface CryptoKey { declare interface CryptoKey {
readonly algorithm: KeyAlgorithm; readonly algorithm: KeyAlgorithm;
@ -207,7 +207,7 @@ declare interface CryptoKey {
readonly usages: KeyUsage[]; readonly usages: KeyUsage[];
} }
/** @category Web Crypto API */ /** @category Crypto */
declare var CryptoKey: { declare var CryptoKey: {
readonly prototype: CryptoKey; readonly prototype: CryptoKey;
new (): never; new (): never;
@ -216,14 +216,14 @@ declare var CryptoKey: {
/** The CryptoKeyPair dictionary of the Web Crypto API represents a key pair for /** The CryptoKeyPair dictionary of the Web Crypto API represents a key pair for
* an asymmetric cryptography algorithm, also known as a public-key algorithm. * an asymmetric cryptography algorithm, also known as a public-key algorithm.
* *
* @category Web Crypto API * @category Crypto
*/ */
declare interface CryptoKeyPair { declare interface CryptoKeyPair {
privateKey: CryptoKey; privateKey: CryptoKey;
publicKey: CryptoKey; publicKey: CryptoKey;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare var CryptoKeyPair: { declare var CryptoKeyPair: {
readonly prototype: CryptoKeyPair; readonly prototype: CryptoKeyPair;
new (): never; new (): never;
@ -233,7 +233,7 @@ declare var CryptoKeyPair: {
* functions. It is accessed via the Crypto.subtle properties available in a * functions. It is accessed via the Crypto.subtle properties available in a
* window context (via Window.crypto). * window context (via Window.crypto).
* *
* @category Web Crypto API * @category Crypto
*/ */
declare interface SubtleCrypto { declare interface SubtleCrypto {
generateKey( generateKey(
@ -367,13 +367,13 @@ declare interface SubtleCrypto {
): Promise<CryptoKey>; ): Promise<CryptoKey>;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare var SubtleCrypto: { declare var SubtleCrypto: {
readonly prototype: SubtleCrypto; readonly prototype: SubtleCrypto;
new (): never; new (): never;
}; };
/** @category Web Crypto API */ /** @category Crypto */
declare interface Crypto { declare interface Crypto {
readonly subtle: SubtleCrypto; readonly subtle: SubtleCrypto;
getRandomValues< getRandomValues<
@ -393,7 +393,7 @@ declare interface Crypto {
randomUUID(): `${string}-${string}-${string}-${string}-${string}`; randomUUID(): `${string}-${string}-${string}-${string}-${string}`;
} }
/** @category Web Crypto API */ /** @category Crypto */
declare var Crypto: { declare var Crypto: {
readonly prototype: Crypto; readonly prototype: Crypto;
new (): never; new (): never;

56
ext/fetch/lib.deno_fetch.d.ts vendored
View file

@ -5,7 +5,7 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category DOM APIs */ /** @category Platform */
declare interface DomIterable<K, V> { declare interface DomIterable<K, V> {
keys(): IterableIterator<K>; keys(): IterableIterator<K>;
values(): IterableIterator<V>; values(): IterableIterator<V>;
@ -17,7 +17,7 @@ declare interface DomIterable<K, V> {
): void; ): void;
} }
/** @category Fetch API */ /** @category Fetch */
declare type FormDataEntryValue = File | string; declare type FormDataEntryValue = File | string;
/** Provides a way to easily construct a set of key/value pairs representing /** 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 * XMLHttpRequest.send() method. It uses the same format a form would use if the
* encoding type were set to "multipart/form-data". * encoding type were set to "multipart/form-data".
* *
* @category Fetch API * @category Fetch
*/ */
declare interface FormData extends DomIterable<string, FormDataEntryValue> { declare interface FormData extends DomIterable<string, FormDataEntryValue> {
append(name: string, value: string | Blob, fileName?: string): void; 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; set(name: string, value: string | Blob, fileName?: string): void;
} }
/** @category Fetch API */ /** @category Fetch */
declare var FormData: { declare var FormData: {
readonly prototype: FormData; readonly prototype: FormData;
new (): FormData; new (): FormData;
}; };
/** @category Fetch API */ /** @category Fetch */
declare interface Body { declare interface Body {
/** A simple getter used to expose a `ReadableStream` of the body contents. */ /** A simple getter used to expose a `ReadableStream` of the body contents. */
readonly body: ReadableStream<Uint8Array> | null; readonly body: ReadableStream<Uint8Array> | null;
@ -72,7 +72,7 @@ declare interface Body {
text(): Promise<string>; text(): Promise<string>;
} }
/** @category Fetch API */ /** @category Fetch */
declare type HeadersInit = Iterable<string[]> | Record<string, string>; declare type HeadersInit = Iterable<string[]> | Record<string, string>;
/** This Fetch API interface allows you to perform various actions on HTTP /** 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 * methods of this interface, header names are matched by case-insensitive byte
* sequence. * sequence.
* *
* @category Fetch API * @category Fetch
*/ */
declare interface Headers extends DomIterable<string, string> { declare interface Headers extends DomIterable<string, string> {
/** Appends a new value onto an existing header inside a `Headers` object, or /** 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 * methods of this interface, header names are matched by case-insensitive byte
* sequence. * sequence.
* *
* @category Fetch API * @category Fetch
*/ */
declare var Headers: { declare var Headers: {
readonly prototype: Headers; readonly prototype: Headers;
new (init?: HeadersInit): Headers; new (init?: HeadersInit): Headers;
}; };
/** @category Fetch API */ /** @category Fetch */
declare type RequestInfo = Request | string; declare type RequestInfo = Request | string;
/** @category Fetch API */ /** @category Fetch */
declare type RequestCache = declare type RequestCache =
| "default" | "default"
| "force-cache" | "force-cache"
@ -135,13 +135,13 @@ declare type RequestCache =
| "no-store" | "no-store"
| "only-if-cached" | "only-if-cached"
| "reload"; | "reload";
/** @category Fetch API */ /** @category Fetch */
declare type RequestCredentials = "include" | "omit" | "same-origin"; declare type RequestCredentials = "include" | "omit" | "same-origin";
/** @category Fetch API */ /** @category Fetch */
declare type RequestMode = "cors" | "navigate" | "no-cors" | "same-origin"; declare type RequestMode = "cors" | "navigate" | "no-cors" | "same-origin";
/** @category Fetch API */ /** @category Fetch */
declare type RequestRedirect = "error" | "follow" | "manual"; declare type RequestRedirect = "error" | "follow" | "manual";
/** @category Fetch API */ /** @category Fetch */
declare type ReferrerPolicy = declare type ReferrerPolicy =
| "" | ""
| "no-referrer" | "no-referrer"
@ -152,7 +152,7 @@ declare type ReferrerPolicy =
| "strict-origin" | "strict-origin"
| "strict-origin-when-cross-origin" | "strict-origin-when-cross-origin"
| "unsafe-url"; | "unsafe-url";
/** @category Fetch API */ /** @category Fetch */
declare type BodyInit = declare type BodyInit =
| Blob | Blob
| BufferSource | BufferSource
@ -160,7 +160,7 @@ declare type BodyInit =
| URLSearchParams | URLSearchParams
| ReadableStream<Uint8Array> | ReadableStream<Uint8Array>
| string; | string;
/** @category Fetch API */ /** @category Fetch */
declare type RequestDestination = declare type RequestDestination =
| "" | ""
| "audio" | "audio"
@ -181,7 +181,7 @@ declare type RequestDestination =
| "worker" | "worker"
| "xslt"; | "xslt";
/** @category Fetch API */ /** @category Fetch */
declare interface RequestInit { declare interface RequestInit {
/** /**
* A BodyInit object or null to set request's body. * 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. /** This Fetch API interface represents a resource request.
* *
* @category Fetch API * @category Fetch
*/ */
declare interface Request extends Body { declare interface Request extends Body {
/** /**
@ -338,21 +338,21 @@ declare interface Request extends Body {
/** This Fetch API interface represents a resource request. /** This Fetch API interface represents a resource request.
* *
* @category Fetch API * @category Fetch
*/ */
declare var Request: { declare var Request: {
readonly prototype: Request; readonly prototype: Request;
new (input: RequestInfo | URL, init?: RequestInit): Request; new (input: RequestInfo | URL, init?: RequestInit): Request;
}; };
/** @category Fetch API */ /** @category Fetch */
declare interface ResponseInit { declare interface ResponseInit {
headers?: HeadersInit; headers?: HeadersInit;
status?: number; status?: number;
statusText?: string; statusText?: string;
} }
/** @category Fetch API */ /** @category Fetch */
declare type ResponseType = declare type ResponseType =
| "basic" | "basic"
| "cors" | "cors"
@ -363,7 +363,7 @@ declare type ResponseType =
/** This Fetch API interface represents the response to a request. /** This Fetch API interface represents the response to a request.
* *
* @category Fetch API * @category Fetch
*/ */
declare interface Response extends Body { declare interface Response extends Body {
readonly headers: Headers; readonly headers: Headers;
@ -378,7 +378,7 @@ declare interface Response extends Body {
/** This Fetch API interface represents the response to a request. /** This Fetch API interface represents the response to a request.
* *
* @category Fetch API * @category Fetch
*/ */
declare var Response: { declare var Response: {
readonly prototype: Response; readonly prototype: Response;
@ -399,7 +399,7 @@ declare var Response: {
* ``` * ```
* *
* @tags allow-net, allow-read * @tags allow-net, allow-read
* @category Fetch API * @category Fetch
*/ */
declare function fetch( declare function fetch(
input: URL | Request | string, input: URL | Request | string,
@ -407,14 +407,14 @@ declare function fetch(
): Promise<Response>; ): Promise<Response>;
/** /**
* @category Fetch API * @category Fetch
*/ */
declare interface EventSourceInit { declare interface EventSourceInit {
withCredentials?: boolean; withCredentials?: boolean;
} }
/** /**
* @category Fetch API * @category Fetch
*/ */
declare interface EventSourceEventMap { declare interface EventSourceEventMap {
"error": Event; "error": Event;
@ -423,7 +423,7 @@ declare interface EventSourceEventMap {
} }
/** /**
* @category Fetch API * @category Fetch
*/ */
declare interface EventSource extends EventTarget { declare interface EventSource extends EventTarget {
onerror: ((this: EventSource, ev: Event) => any) | null; onerror: ((this: EventSource, ev: Event) => any) | null;
@ -481,7 +481,7 @@ declare interface EventSource extends EventTarget {
} }
/** /**
* @category Fetch API * @category Fetch
*/ */
declare var EventSource: { declare var EventSource: {
prototype: EventSource; prototype: EventSource;

20
ext/url/lib.deno_url.d.ts vendored
View file

@ -5,7 +5,7 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Web APIs */ /** @category URL */
declare interface URLSearchParams { declare interface URLSearchParams {
/** Appends a specified key/value pair as a new search parameter. /** Appends a specified key/value pair as a new search parameter.
* *
@ -157,7 +157,7 @@ declare interface URLSearchParams {
size: number; size: number;
} }
/** @category Web APIs */ /** @category URL */
declare var URLSearchParams: { declare var URLSearchParams: {
readonly prototype: URLSearchParams; readonly prototype: URLSearchParams;
new ( new (
@ -168,7 +168,7 @@ declare var URLSearchParams: {
/** The URL interface represents an object providing static methods used for /** The URL interface represents an object providing static methods used for
* creating object URLs. * creating object URLs.
* *
* @category Web APIs * @category URL
*/ */
declare interface URL { declare interface URL {
hash: string; hash: string;
@ -190,7 +190,7 @@ declare interface URL {
/** The URL interface represents an object providing static methods used for /** The URL interface represents an object providing static methods used for
* creating object URLs. * creating object URLs.
* *
* @category Web APIs * @category URL
*/ */
declare var URL: { declare var URL: {
readonly prototype: URL; readonly prototype: URL;
@ -201,7 +201,7 @@ declare var URL: {
revokeObjectURL(url: string): void; revokeObjectURL(url: string): void;
}; };
/** @category Web APIs */ /** @category URL */
declare interface URLPatternInit { declare interface URLPatternInit {
protocol?: string; protocol?: string;
username?: string; username?: string;
@ -214,10 +214,10 @@ declare interface URLPatternInit {
baseURL?: string; baseURL?: string;
} }
/** @category Web APIs */ /** @category URL */
declare type URLPatternInput = string | URLPatternInit; declare type URLPatternInput = string | URLPatternInit;
/** @category Web APIs */ /** @category URL */
declare interface URLPatternComponentResult { declare interface URLPatternComponentResult {
input: string; input: string;
groups: Record<string, string | undefined>; groups: Record<string, string | undefined>;
@ -225,7 +225,7 @@ declare interface URLPatternComponentResult {
/** `URLPatternResult` is the object returned from `URLPattern.exec`. /** `URLPatternResult` is the object returned from `URLPattern.exec`.
* *
* @category Web APIs * @category URL
*/ */
declare interface URLPatternResult { declare interface URLPatternResult {
/** The inputs provided when matching. */ /** The inputs provided when matching. */
@ -277,7 +277,7 @@ declare interface URLPatternResult {
* console.log(pattern.test("https://blog.example.com/article/123")); // true * console.log(pattern.test("https://blog.example.com/article/123")); // true
* ``` * ```
* *
* @category Web APIs * @category URL
*/ */
declare interface URLPattern { declare interface URLPattern {
/** /**
@ -373,7 +373,7 @@ declare interface URLPattern {
* console.log(pattern.test("https://blog.example.com/article/123")); // true * console.log(pattern.test("https://blog.example.com/article/123")); // true
* ``` * ```
* *
* @category Web APIs * @category URL
*/ */
declare var URLPattern: { declare var URLPattern: {
readonly prototype: URLPattern; readonly prototype: URLPattern;

226
ext/web/lib.deno_web.d.ts vendored
View file

@ -5,7 +5,7 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Web APIs */ /** @category Platform */
declare interface DOMException extends Error { declare interface DOMException extends Error {
readonly name: string; readonly name: string;
readonly message: string; readonly message: string;
@ -37,7 +37,7 @@ declare interface DOMException extends Error {
readonly DATA_CLONE_ERR: 25; readonly DATA_CLONE_ERR: 25;
} }
/** @category Web APIs */ /** @category Platform */
declare var DOMException: { declare var DOMException: {
readonly prototype: DOMException; readonly prototype: DOMException;
new (message?: string, name?: string): DOMException; new (message?: string, name?: string): DOMException;
@ -68,7 +68,7 @@ declare var DOMException: {
readonly DATA_CLONE_ERR: 25; readonly DATA_CLONE_ERR: 25;
}; };
/** @category DOM Events */ /** @category Events */
declare interface EventInit { declare interface EventInit {
bubbles?: boolean; bubbles?: boolean;
cancelable?: boolean; cancelable?: boolean;
@ -77,7 +77,7 @@ declare interface EventInit {
/** An event which takes place in the DOM. /** An event which takes place in the DOM.
* *
* @category DOM Events * @category Events
*/ */
declare interface Event { declare interface Event {
/** Returns true or false depending on how event was initialized. True if /** 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. /** An event which takes place in the DOM.
* *
* @category DOM Events * @category Events
*/ */
declare var Event: { declare var Event: {
readonly prototype: Event; readonly prototype: Event;
@ -153,7 +153,7 @@ declare var Event: {
* EventTarget is a DOM interface implemented by objects that can receive events * EventTarget is a DOM interface implemented by objects that can receive events
* and may have listeners for them. * and may have listeners for them.
* *
* @category DOM Events * @category Events
*/ */
declare interface EventTarget { declare interface EventTarget {
/** Appends an event listener for events whose type attribute value is type. /** 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 * EventTarget is a DOM interface implemented by objects that can receive events
* and may have listeners for them. * and may have listeners for them.
* *
* @category DOM Events * @category Events
*/ */
declare var EventTarget: { declare var EventTarget: {
readonly prototype: EventTarget; readonly prototype: EventTarget;
new (): EventTarget; new (): EventTarget;
}; };
/** @category DOM Events */ /** @category Events */
declare interface EventListener { declare interface EventListener {
(evt: Event): void | Promise<void>; (evt: Event): void | Promise<void>;
} }
/** @category DOM Events */ /** @category Events */
declare interface EventListenerObject { declare interface EventListenerObject {
handleEvent(evt: Event): void | Promise<void>; handleEvent(evt: Event): void | Promise<void>;
} }
/** @category DOM Events */ /** @category Events */
declare type EventListenerOrEventListenerObject = declare type EventListenerOrEventListenerObject =
| EventListener | EventListener
| EventListenerObject; | EventListenerObject;
/** @category DOM Events */ /** @category Events */
declare interface AddEventListenerOptions extends EventListenerOptions { declare interface AddEventListenerOptions extends EventListenerOptions {
once?: boolean; once?: boolean;
passive?: boolean; passive?: boolean;
signal?: AbortSignal; signal?: AbortSignal;
} }
/** @category DOM Events */ /** @category Events */
declare interface EventListenerOptions { declare interface EventListenerOptions {
capture?: boolean; capture?: boolean;
} }
/** @category DOM Events */ /** @category Events */
declare interface ProgressEventInit extends EventInit { declare interface ProgressEventInit extends EventInit {
lengthComputable?: boolean; lengthComputable?: boolean;
loaded?: number; loaded?: number;
@ -246,7 +246,7 @@ declare interface ProgressEventInit extends EventInit {
* (for an XMLHttpRequest, or the loading of the underlying resource of an * (for an XMLHttpRequest, or the loading of the underlying resource of an
* <img>, <audio>, <video>, <style> or <link>). * <img>, <audio>, <video>, <style> or <link>).
* *
* @category DOM Events * @category Events
*/ */
declare interface ProgressEvent<T extends EventTarget = EventTarget> declare interface ProgressEvent<T extends EventTarget = EventTarget>
extends Event { 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 * (for an XMLHttpRequest, or the loading of the underlying resource of an
* <img>, <audio>, <video>, <style> or <link>). * <img>, <audio>, <video>, <style> or <link>).
* *
* @category DOM Events * @category Events
*/ */
declare var ProgressEvent: { declare var ProgressEvent: {
readonly prototype: ProgressEvent; readonly prototype: ProgressEvent;
@ -273,7 +273,7 @@ declare var ProgressEvent: {
* console.log(atob("aGVsbG8gd29ybGQ=")); // outputs 'hello world' * console.log(atob("aGVsbG8gd29ybGQ=")); // outputs 'hello world'
* ``` * ```
* *
* @category Encoding API * @category Encoding
*/ */
declare function atob(s: string): string; declare function atob(s: string): string;
@ -283,22 +283,22 @@ declare function atob(s: string): string;
* console.log(btoa("hello world")); // outputs "aGVsbG8gd29ybGQ=" * console.log(btoa("hello world")); // outputs "aGVsbG8gd29ybGQ="
* ``` * ```
* *
* @category Encoding API * @category Encoding
*/ */
declare function btoa(s: string): string; declare function btoa(s: string): string;
/** @category Encoding API */ /** @category Encoding */
declare interface TextDecoderOptions { declare interface TextDecoderOptions {
fatal?: boolean; fatal?: boolean;
ignoreBOM?: boolean; ignoreBOM?: boolean;
} }
/** @category Encoding API */ /** @category Encoding */
declare interface TextDecodeOptions { declare interface TextDecodeOptions {
stream?: boolean; stream?: boolean;
} }
/** @category Encoding API */ /** @category Encoding */
declare interface TextDecoder { declare interface TextDecoder {
/** Returns encoding's name, lowercased. */ /** Returns encoding's name, lowercased. */
readonly encoding: string; readonly encoding: string;
@ -311,19 +311,19 @@ declare interface TextDecoder {
decode(input?: BufferSource, options?: TextDecodeOptions): string; decode(input?: BufferSource, options?: TextDecodeOptions): string;
} }
/** @category Encoding API */ /** @category Encoding */
declare var TextDecoder: { declare var TextDecoder: {
readonly prototype: TextDecoder; readonly prototype: TextDecoder;
new (label?: string, options?: TextDecoderOptions): TextDecoder; new (label?: string, options?: TextDecoderOptions): TextDecoder;
}; };
/** @category Encoding API */ /** @category Encoding */
declare interface TextEncoderEncodeIntoResult { declare interface TextEncoderEncodeIntoResult {
read: number; read: number;
written: number; written: number;
} }
/** @category Encoding API */ /** @category Encoding */
declare interface TextEncoder { declare interface TextEncoder {
/** Returns "utf-8". */ /** Returns "utf-8". */
readonly encoding: "utf-8"; readonly encoding: "utf-8";
@ -332,13 +332,13 @@ declare interface TextEncoder {
encodeInto(input: string, dest: Uint8Array): TextEncoderEncodeIntoResult; encodeInto(input: string, dest: Uint8Array): TextEncoderEncodeIntoResult;
} }
/** @category Encoding API */ /** @category Encoding */
declare var TextEncoder: { declare var TextEncoder: {
readonly prototype: TextEncoder; readonly prototype: TextEncoder;
new (): TextEncoder; new (): TextEncoder;
}; };
/** @category Encoding API */ /** @category Encoding */
declare interface TextDecoderStream { declare interface TextDecoderStream {
/** Returns encoding's name, lowercased. */ /** Returns encoding's name, lowercased. */
readonly encoding: string; readonly encoding: string;
@ -351,13 +351,13 @@ declare interface TextDecoderStream {
readonly [Symbol.toStringTag]: string; readonly [Symbol.toStringTag]: string;
} }
/** @category Encoding API */ /** @category Encoding */
declare var TextDecoderStream: { declare var TextDecoderStream: {
readonly prototype: TextDecoderStream; readonly prototype: TextDecoderStream;
new (label?: string, options?: TextDecoderOptions): TextDecoderStream; new (label?: string, options?: TextDecoderOptions): TextDecoderStream;
}; };
/** @category Encoding API */ /** @category Encoding */
declare interface TextEncoderStream { declare interface TextEncoderStream {
/** Returns "utf-8". */ /** Returns "utf-8". */
readonly encoding: "utf-8"; readonly encoding: "utf-8";
@ -366,7 +366,7 @@ declare interface TextEncoderStream {
readonly [Symbol.toStringTag]: string; readonly [Symbol.toStringTag]: string;
} }
/** @category Encoding API */ /** @category Encoding */
declare var TextEncoderStream: { declare var TextEncoderStream: {
readonly prototype: TextEncoderStream; readonly prototype: TextEncoderStream;
new (): 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 /** A controller object that allows you to abort one or more DOM requests as and
* when desired. * when desired.
* *
* @category Web APIs * @category Platform
*/ */
declare interface AbortController { declare interface AbortController {
/** Returns the AbortSignal object associated with this object. */ /** 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 /** A controller object that allows you to abort one or more DOM requests as and
* when desired. * when desired.
* *
* @category Web APIs * @category Platform
*/ */
declare var AbortController: { declare var AbortController: {
readonly prototype: AbortController; readonly prototype: AbortController;
new (): AbortController; new (): AbortController;
}; };
/** @category Web APIs */ /** @category Platform */
declare interface AbortSignalEventMap { declare interface AbortSignalEventMap {
abort: Event; abort: Event;
} }
@ -403,7 +403,7 @@ declare interface AbortSignalEventMap {
/** A signal object that allows you to communicate with a DOM request (such as a /** 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. * Fetch) and abort it if required via an AbortController object.
* *
* @category Web APIs * @category Platform
*/ */
declare interface AbortSignal extends EventTarget { declare interface AbortSignal extends EventTarget {
/** Returns true if this AbortSignal's AbortController has signaled to abort, /** Returns true if this AbortSignal's AbortController has signaled to abort,
@ -437,7 +437,7 @@ declare interface AbortSignal extends EventTarget {
throwIfAborted(): void; throwIfAborted(): void;
} }
/** @category Web APIs */ /** @category Platform */
declare var AbortSignal: { declare var AbortSignal: {
readonly prototype: AbortSignal; readonly prototype: AbortSignal;
new (): never; new (): never;
@ -446,7 +446,7 @@ declare var AbortSignal: {
timeout(milliseconds: number): AbortSignal; timeout(milliseconds: number): AbortSignal;
}; };
/** @category Web File API */ /** @category File */
declare interface FileReaderEventMap { declare interface FileReaderEventMap {
"abort": ProgressEvent<FileReader>; "abort": ProgressEvent<FileReader>;
"error": 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 * buffers) stored on the user's computer, using File or Blob objects to specify
* the file or data to read. * the file or data to read.
* *
* @category Web File API * @category File
*/ */
declare interface FileReader extends EventTarget { declare interface FileReader extends EventTarget {
readonly error: DOMException | null; readonly error: DOMException | null;
@ -504,7 +504,7 @@ declare interface FileReader extends EventTarget {
): void; ): void;
} }
/** @category Web File API */ /** @category File */
declare var FileReader: { declare var FileReader: {
readonly prototype: FileReader; readonly prototype: FileReader;
new (): FileReader; new (): FileReader;
@ -513,10 +513,10 @@ declare var FileReader: {
readonly LOADING: number; readonly LOADING: number;
}; };
/** @category Web File API */ /** @category File */
declare type BlobPart = BufferSource | Blob | string; declare type BlobPart = BufferSource | Blob | string;
/** @category Web File API */ /** @category File */
declare interface BlobPropertyBag { declare interface BlobPropertyBag {
type?: string; type?: string;
endings?: "transparent" | "native"; endings?: "transparent" | "native";
@ -527,7 +527,7 @@ declare interface BlobPropertyBag {
* Blob, inheriting blob functionality and expanding it to support files on the * Blob, inheriting blob functionality and expanding it to support files on the
* user's system. * user's system.
* *
* @category Web File API * @category File
*/ */
declare interface Blob { declare interface Blob {
readonly size: number; readonly size: number;
@ -543,14 +543,14 @@ declare interface Blob {
* Blob, inheriting blob functionality and expanding it to support files on the * Blob, inheriting blob functionality and expanding it to support files on the
* user's system. * user's system.
* *
* @category Web File API * @category File
*/ */
declare var Blob: { declare var Blob: {
readonly prototype: Blob; readonly prototype: Blob;
new (blobParts?: BlobPart[], options?: BlobPropertyBag): Blob; new (blobParts?: BlobPart[], options?: BlobPropertyBag): Blob;
}; };
/** @category Web File API */ /** @category File */
declare interface FilePropertyBag extends BlobPropertyBag { declare interface FilePropertyBag extends BlobPropertyBag {
lastModified?: number; lastModified?: number;
} }
@ -558,7 +558,7 @@ declare interface FilePropertyBag extends BlobPropertyBag {
/** Provides information about files and allows JavaScript in a web page to /** Provides information about files and allows JavaScript in a web page to
* access their content. * access their content.
* *
* @category Web File API * @category File
*/ */
declare interface File extends Blob { declare interface File extends Blob {
readonly lastModified: number; readonly lastModified: number;
@ -568,31 +568,31 @@ declare interface File extends Blob {
/** Provides information about files and allows JavaScript in a web page to /** Provides information about files and allows JavaScript in a web page to
* access their content. * access their content.
* *
* @category Web File API * @category File
*/ */
declare var File: { declare var File: {
readonly prototype: File; readonly prototype: File;
new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag): File; new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag): File;
}; };
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamDefaultReadDoneResult { declare interface ReadableStreamDefaultReadDoneResult {
done: true; done: true;
value?: undefined; value?: undefined;
} }
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamDefaultReadValueResult<T> { declare interface ReadableStreamDefaultReadValueResult<T> {
done: false; done: false;
value: T; value: T;
} }
/** @category Streams API */ /** @category Streams */
declare type ReadableStreamDefaultReadResult<T> = declare type ReadableStreamDefaultReadResult<T> =
| ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadValueResult<T>
| ReadableStreamDefaultReadDoneResult; | ReadableStreamDefaultReadDoneResult;
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamDefaultReader<R = any> { declare interface ReadableStreamDefaultReader<R = any> {
readonly closed: Promise<void>; readonly closed: Promise<void>;
cancel(reason?: any): Promise<void>; cancel(reason?: any): Promise<void>;
@ -600,35 +600,35 @@ declare interface ReadableStreamDefaultReader<R = any> {
releaseLock(): void; releaseLock(): void;
} }
/** @category Streams API */ /** @category Streams */
declare var ReadableStreamDefaultReader: { declare var ReadableStreamDefaultReader: {
readonly prototype: ReadableStreamDefaultReader; readonly prototype: ReadableStreamDefaultReader;
new <R>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>; new <R>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
}; };
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamBYOBReadDoneResult<V extends ArrayBufferView> { declare interface ReadableStreamBYOBReadDoneResult<V extends ArrayBufferView> {
done: true; done: true;
value?: V; value?: V;
} }
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamBYOBReadValueResult<V extends ArrayBufferView> { declare interface ReadableStreamBYOBReadValueResult<V extends ArrayBufferView> {
done: false; done: false;
value: V; value: V;
} }
/** @category Streams API */ /** @category Streams */
declare type ReadableStreamBYOBReadResult<V extends ArrayBufferView> = declare type ReadableStreamBYOBReadResult<V extends ArrayBufferView> =
| ReadableStreamBYOBReadDoneResult<V> | ReadableStreamBYOBReadDoneResult<V>
| ReadableStreamBYOBReadValueResult<V>; | ReadableStreamBYOBReadValueResult<V>;
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamBYOBReaderReadOptions { declare interface ReadableStreamBYOBReaderReadOptions {
min?: number; min?: number;
} }
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamBYOBReader { declare interface ReadableStreamBYOBReader {
readonly closed: Promise<void>; readonly closed: Promise<void>;
cancel(reason?: any): Promise<void>; cancel(reason?: any): Promise<void>;
@ -639,31 +639,31 @@ declare interface ReadableStreamBYOBReader {
releaseLock(): void; releaseLock(): void;
} }
/** @category Streams API */ /** @category Streams */
declare var ReadableStreamBYOBReader: { declare var ReadableStreamBYOBReader: {
readonly prototype: ReadableStreamBYOBReader; readonly prototype: ReadableStreamBYOBReader;
new (stream: ReadableStream<Uint8Array>): ReadableStreamBYOBReader; new (stream: ReadableStream<Uint8Array>): ReadableStreamBYOBReader;
}; };
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamBYOBRequest { declare interface ReadableStreamBYOBRequest {
readonly view: ArrayBufferView | null; readonly view: ArrayBufferView | null;
respond(bytesWritten: number): void; respond(bytesWritten: number): void;
respondWithNewView(view: ArrayBufferView): void; respondWithNewView(view: ArrayBufferView): void;
} }
/** @category Streams API */ /** @category Streams */
declare var ReadableStreamBYOBRequest: { declare var ReadableStreamBYOBRequest: {
readonly prototype: ReadableStreamBYOBRequest; readonly prototype: ReadableStreamBYOBRequest;
new (): never; new (): never;
}; };
/** @category Streams API */ /** @category Streams */
declare interface ReadableByteStreamControllerCallback { declare interface ReadableByteStreamControllerCallback {
(controller: ReadableByteStreamController): void | PromiseLike<void>; (controller: ReadableByteStreamController): void | PromiseLike<void>;
} }
/** @category Streams API */ /** @category Streams */
declare interface UnderlyingByteSource { declare interface UnderlyingByteSource {
autoAllocateChunkSize?: number; autoAllocateChunkSize?: number;
cancel?: ReadableStreamErrorCallback; cancel?: ReadableStreamErrorCallback;
@ -672,7 +672,7 @@ declare interface UnderlyingByteSource {
type: "bytes"; type: "bytes";
} }
/** @category Streams API */ /** @category Streams */
declare interface UnderlyingSink<W = any> { declare interface UnderlyingSink<W = any> {
abort?: WritableStreamErrorCallback; abort?: WritableStreamErrorCallback;
close?: WritableStreamDefaultControllerCloseCallback; close?: WritableStreamDefaultControllerCloseCallback;
@ -681,7 +681,7 @@ declare interface UnderlyingSink<W = any> {
write?: WritableStreamDefaultControllerWriteCallback<W>; write?: WritableStreamDefaultControllerWriteCallback<W>;
} }
/** @category Streams API */ /** @category Streams */
declare interface UnderlyingSource<R = any> { declare interface UnderlyingSource<R = any> {
cancel?: ReadableStreamErrorCallback; cancel?: ReadableStreamErrorCallback;
pull?: ReadableStreamDefaultControllerCallback<R>; pull?: ReadableStreamDefaultControllerCallback<R>;
@ -689,17 +689,17 @@ declare interface UnderlyingSource<R = any> {
type?: undefined; type?: undefined;
} }
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamErrorCallback { declare interface ReadableStreamErrorCallback {
(reason: any): void | PromiseLike<void>; (reason: any): void | PromiseLike<void>;
} }
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamDefaultControllerCallback<R> { declare interface ReadableStreamDefaultControllerCallback<R> {
(controller: ReadableStreamDefaultController<R>): void | PromiseLike<void>; (controller: ReadableStreamDefaultController<R>): void | PromiseLike<void>;
} }
/** @category Streams API */ /** @category Streams */
declare interface ReadableStreamDefaultController<R = any> { declare interface ReadableStreamDefaultController<R = any> {
readonly desiredSize: number | null; readonly desiredSize: number | null;
close(): void; close(): void;
@ -707,13 +707,13 @@ declare interface ReadableStreamDefaultController<R = any> {
error(error?: any): void; error(error?: any): void;
} }
/** @category Streams API */ /** @category Streams */
declare var ReadableStreamDefaultController: { declare var ReadableStreamDefaultController: {
readonly prototype: ReadableStreamDefaultController; readonly prototype: ReadableStreamDefaultController;
new (): never; new (): never;
}; };
/** @category Streams API */ /** @category Streams */
declare interface ReadableByteStreamController { declare interface ReadableByteStreamController {
readonly byobRequest: ReadableStreamBYOBRequest | null; readonly byobRequest: ReadableStreamBYOBRequest | null;
readonly desiredSize: number | null; readonly desiredSize: number | null;
@ -722,13 +722,13 @@ declare interface ReadableByteStreamController {
error(error?: any): void; error(error?: any): void;
} }
/** @category Streams API */ /** @category Streams */
declare var ReadableByteStreamController: { declare var ReadableByteStreamController: {
readonly prototype: ReadableByteStreamController; readonly prototype: ReadableByteStreamController;
new (): never; new (): never;
}; };
/** @category Streams API */ /** @category Streams */
declare interface PipeOptions { declare interface PipeOptions {
preventAbort?: boolean; preventAbort?: boolean;
preventCancel?: boolean; preventCancel?: boolean;
@ -736,12 +736,12 @@ declare interface PipeOptions {
signal?: AbortSignal; signal?: AbortSignal;
} }
/** @category Streams API */ /** @category Streams */
declare interface QueuingStrategySizeCallback<T = any> { declare interface QueuingStrategySizeCallback<T = any> {
(chunk: T): number; (chunk: T): number;
} }
/** @category Streams API */ /** @category Streams */
declare interface QueuingStrategy<T = any> { declare interface QueuingStrategy<T = any> {
highWaterMark?: number; highWaterMark?: number;
size?: QueuingStrategySizeCallback<T>; size?: QueuingStrategySizeCallback<T>;
@ -750,27 +750,27 @@ declare interface QueuingStrategy<T = any> {
/** This Streams API interface provides a built-in byte length queuing strategy /** This Streams API interface provides a built-in byte length queuing strategy
* that can be used when constructing streams. * that can be used when constructing streams.
* *
* @category Streams API * @category Streams
*/ */
declare interface CountQueuingStrategy extends QueuingStrategy { declare interface CountQueuingStrategy extends QueuingStrategy {
highWaterMark: number; highWaterMark: number;
size(chunk: any): 1; size(chunk: any): 1;
} }
/** @category Streams API */ /** @category Streams */
declare var CountQueuingStrategy: { declare var CountQueuingStrategy: {
readonly prototype: CountQueuingStrategy; readonly prototype: CountQueuingStrategy;
new (options: { highWaterMark: number }): CountQueuingStrategy; new (options: { highWaterMark: number }): CountQueuingStrategy;
}; };
/** @category Streams API */ /** @category Streams */
declare interface ByteLengthQueuingStrategy declare interface ByteLengthQueuingStrategy
extends QueuingStrategy<ArrayBufferView> { extends QueuingStrategy<ArrayBufferView> {
highWaterMark: number; highWaterMark: number;
size(chunk: ArrayBufferView): number; size(chunk: ArrayBufferView): number;
} }
/** @category Streams API */ /** @category Streams */
declare var ByteLengthQueuingStrategy: { declare var ByteLengthQueuingStrategy: {
readonly prototype: ByteLengthQueuingStrategy; readonly prototype: ByteLengthQueuingStrategy;
new (options: { highWaterMark: number }): 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 * Fetch API offers a concrete instance of a ReadableStream through the body
* property of a Response object. * property of a Response object.
* *
* @category Streams API * @category Streams
*/ */
declare interface ReadableStream<R = any> { declare interface ReadableStream<R = any> {
readonly locked: boolean; readonly locked: boolean;
@ -801,7 +801,7 @@ declare interface ReadableStream<R = any> {
}): AsyncIterableIterator<R>; }): AsyncIterableIterator<R>;
} }
/** @category Streams API */ /** @category Streams */
declare var ReadableStream: { declare var ReadableStream: {
readonly prototype: ReadableStream; readonly prototype: ReadableStream;
new ( new (
@ -817,17 +817,17 @@ declare var ReadableStream: {
): ReadableStream<R>; ): ReadableStream<R>;
}; };
/** @category Streams API */ /** @category Streams */
declare interface WritableStreamDefaultControllerCloseCallback { declare interface WritableStreamDefaultControllerCloseCallback {
(): void | PromiseLike<void>; (): void | PromiseLike<void>;
} }
/** @category Streams API */ /** @category Streams */
declare interface WritableStreamDefaultControllerStartCallback { declare interface WritableStreamDefaultControllerStartCallback {
(controller: WritableStreamDefaultController): void | PromiseLike<void>; (controller: WritableStreamDefaultController): void | PromiseLike<void>;
} }
/** @category Streams API */ /** @category Streams */
declare interface WritableStreamDefaultControllerWriteCallback<W> { declare interface WritableStreamDefaultControllerWriteCallback<W> {
(chunk: W, controller: WritableStreamDefaultController): (chunk: W, controller: WritableStreamDefaultController):
| void | void
@ -836,7 +836,7 @@ declare interface WritableStreamDefaultControllerWriteCallback<W> {
>; >;
} }
/** @category Streams API */ /** @category Streams */
declare interface WritableStreamErrorCallback { declare interface WritableStreamErrorCallback {
(reason: any): void | PromiseLike<void>; (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 * streaming data to a destination, known as a sink. This object comes with
* built-in backpressure and queuing. * built-in backpressure and queuing.
* *
* @category Streams API * @category Streams
*/ */
declare interface WritableStream<W = any> { declare interface WritableStream<W = any> {
readonly locked: boolean; readonly locked: boolean;
@ -854,7 +854,7 @@ declare interface WritableStream<W = any> {
getWriter(): WritableStreamDefaultWriter<W>; getWriter(): WritableStreamDefaultWriter<W>;
} }
/** @category Streams API */ /** @category Streams */
declare var WritableStream: { declare var WritableStream: {
readonly prototype: WritableStream; readonly prototype: WritableStream;
new <W = any>( new <W = any>(
@ -868,14 +868,14 @@ declare var WritableStream: {
* sink is given a corresponding WritableStreamDefaultController instance to * sink is given a corresponding WritableStreamDefaultController instance to
* manipulate. * manipulate.
* *
* @category Streams API * @category Streams
*/ */
declare interface WritableStreamDefaultController { declare interface WritableStreamDefaultController {
signal: AbortSignal; signal: AbortSignal;
error(error?: any): void; error(error?: any): void;
} }
/** @category Streams API */ /** @category Streams */
declare var WritableStreamDefaultController: { declare var WritableStreamDefaultController: {
readonly prototype: WritableStreamDefaultController; readonly prototype: WritableStreamDefaultController;
new (): never; new (): never;
@ -886,7 +886,7 @@ declare var WritableStreamDefaultController: {
* WritableStream ensuring that no other streams can write to the underlying * WritableStream ensuring that no other streams can write to the underlying
* sink. * sink.
* *
* @category Streams API * @category Streams
*/ */
declare interface WritableStreamDefaultWriter<W = any> { declare interface WritableStreamDefaultWriter<W = any> {
readonly closed: Promise<void>; readonly closed: Promise<void>;
@ -898,19 +898,19 @@ declare interface WritableStreamDefaultWriter<W = any> {
write(chunk: W): Promise<void>; write(chunk: W): Promise<void>;
} }
/** @category Streams API */ /** @category Streams */
declare var WritableStreamDefaultWriter: { declare var WritableStreamDefaultWriter: {
readonly prototype: WritableStreamDefaultWriter; readonly prototype: WritableStreamDefaultWriter;
new <W>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>; new <W>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>;
}; };
/** @category Streams API */ /** @category Streams */
declare interface TransformStream<I = any, O = any> { declare interface TransformStream<I = any, O = any> {
readonly readable: ReadableStream<O>; readonly readable: ReadableStream<O>;
readonly writable: WritableStream<I>; readonly writable: WritableStream<I>;
} }
/** @category Streams API */ /** @category Streams */
declare var TransformStream: { declare var TransformStream: {
readonly prototype: TransformStream; readonly prototype: TransformStream;
new <I = any, O = any>( new <I = any, O = any>(
@ -920,7 +920,7 @@ declare var TransformStream: {
): TransformStream<I, O>; ): TransformStream<I, O>;
}; };
/** @category Streams API */ /** @category Streams */
declare interface TransformStreamDefaultController<O = any> { declare interface TransformStreamDefaultController<O = any> {
readonly desiredSize: number | null; readonly desiredSize: number | null;
enqueue(chunk: O): void; enqueue(chunk: O): void;
@ -928,13 +928,13 @@ declare interface TransformStreamDefaultController<O = any> {
terminate(): void; terminate(): void;
} }
/** @category Streams API */ /** @category Streams */
declare var TransformStreamDefaultController: { declare var TransformStreamDefaultController: {
readonly prototype: TransformStreamDefaultController; readonly prototype: TransformStreamDefaultController;
new (): never; new (): never;
}; };
/** @category Streams API */ /** @category Streams */
declare interface Transformer<I = any, O = any> { declare interface Transformer<I = any, O = any> {
flush?: TransformStreamDefaultControllerCallback<O>; flush?: TransformStreamDefaultControllerCallback<O>;
readableType?: undefined; readableType?: undefined;
@ -944,12 +944,12 @@ declare interface Transformer<I = any, O = any> {
writableType?: undefined; writableType?: undefined;
} }
/** @category Streams API */ /** @category Streams */
declare interface TransformStreamDefaultControllerCallback<O> { declare interface TransformStreamDefaultControllerCallback<O> {
(controller: TransformStreamDefaultController<O>): void | PromiseLike<void>; (controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
} }
/** @category Streams API */ /** @category Streams */
declare interface TransformStreamDefaultControllerTransformCallback<I, O> { declare interface TransformStreamDefaultControllerTransformCallback<I, O> {
( (
chunk: I, chunk: I,
@ -957,14 +957,14 @@ declare interface TransformStreamDefaultControllerTransformCallback<I, O> {
): void | PromiseLike<void>; ): void | PromiseLike<void>;
} }
/** @category DOM APIs */ /** @category Events */
declare interface MessageEventInit<T = any> extends EventInit { declare interface MessageEventInit<T = any> extends EventInit {
data?: T; data?: T;
origin?: string; origin?: string;
lastEventId?: string; lastEventId?: string;
} }
/** @category DOM APIs */ /** @category Events */
declare interface MessageEvent<T = any> extends Event { declare interface MessageEvent<T = any> extends Event {
/** /**
* Returns the data of the message. * Returns the data of the message.
@ -985,13 +985,13 @@ declare interface MessageEvent<T = any> extends Event {
readonly ports: ReadonlyArray<MessagePort>; readonly ports: ReadonlyArray<MessagePort>;
} }
/** @category DOM APIs */ /** @category Events */
declare var MessageEvent: { declare var MessageEvent: {
readonly prototype: MessageEvent; readonly prototype: MessageEvent;
new <T>(type: string, eventInitDict?: MessageEventInit<T>): MessageEvent<T>; new <T>(type: string, eventInitDict?: MessageEventInit<T>): MessageEvent<T>;
}; };
/** @category DOM APIs */ /** @category Events */
declare type Transferable = ArrayBuffer | MessagePort; declare type Transferable = ArrayBuffer | MessagePort;
/** /**
@ -999,11 +999,11 @@ declare type Transferable = ArrayBuffer | MessagePort;
* new code. * new code.
* *
* @deprecated use `StructuredSerializeOptions` instead. * @deprecated use `StructuredSerializeOptions` instead.
* @category DOM APIs * @category Events
*/ */
declare type PostMessageOptions = StructuredSerializeOptions; declare type PostMessageOptions = StructuredSerializeOptions;
/** @category DOM APIs */ /** @category Platform */
declare interface StructuredSerializeOptions { declare interface StructuredSerializeOptions {
transfer?: Transferable[]; transfer?: Transferable[];
} }
@ -1012,7 +1012,7 @@ declare interface StructuredSerializeOptions {
* create a new message channel and send data through it via its two MessagePort * create a new message channel and send data through it via its two MessagePort
* properties. * properties.
* *
* @category DOM APIs * @category Messaging
*/ */
declare interface MessageChannel { declare interface MessageChannel {
readonly port1: MessagePort; readonly port1: MessagePort;
@ -1023,14 +1023,14 @@ declare interface MessageChannel {
* create a new message channel and send data through it via its two MessagePort * create a new message channel and send data through it via its two MessagePort
* properties. * properties.
* *
* @category DOM APIs * @category Messaging
*/ */
declare var MessageChannel: { declare var MessageChannel: {
readonly prototype: MessageChannel; readonly prototype: MessageChannel;
new (): MessageChannel; new (): MessageChannel;
}; };
/** @category DOM APIs */ /** @category Messaging */
declare interface MessagePortEventMap { declare interface MessagePortEventMap {
"message": MessageEvent; "message": MessageEvent;
"messageerror": MessageEvent; "messageerror": MessageEvent;
@ -1040,7 +1040,7 @@ declare interface MessagePortEventMap {
* two ports of a MessageChannel, allowing messages to be sent from one port and * two ports of a MessageChannel, allowing messages to be sent from one port and
* listening out for them arriving at the other. * listening out for them arriving at the other.
* *
* @category DOM APIs * @category Messaging
*/ */
declare interface MessagePort extends EventTarget { declare interface MessagePort extends EventTarget {
onmessage: ((this: MessagePort, ev: MessageEvent) => any) | null; 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 * two ports of a MessageChannel, allowing messages to be sent from one port and
* listening out for them arriving at the other. * listening out for them arriving at the other.
* *
* @category DOM APIs * @category Messaging
*/ */
declare var MessagePort: { declare var MessagePort: {
readonly prototype: MessagePort; readonly prototype: MessagePort;
@ -1122,7 +1122,7 @@ declare var MessagePort: {
* console.log(shallowCopy.x, object.x); // 1 1 * console.log(shallowCopy.x, object.x); // 1 1
* ``` * ```
* *
* @category DOM APIs * @category Platform
*/ */
declare function structuredClone<T = any>( declare function structuredClone<T = any>(
value: T, value: T,
@ -1139,7 +1139,7 @@ declare function structuredClone<T = any>(
* .pipeTo(Deno.stdout.writable); * .pipeTo(Deno.stdout.writable);
* ``` * ```
* *
* @category Compression Streams API * @category Streams
*/ */
declare interface CompressionStream { declare interface CompressionStream {
readonly readable: ReadableStream<Uint8Array>; readonly readable: ReadableStream<Uint8Array>;
@ -1156,7 +1156,7 @@ declare interface CompressionStream {
* .pipeTo(Deno.stdout.writable); * .pipeTo(Deno.stdout.writable);
* ``` * ```
* *
* @category Compression Streams API * @category Streams
*/ */
declare var CompressionStream: { declare var CompressionStream: {
readonly prototype: CompressionStream; readonly prototype: CompressionStream;
@ -1183,7 +1183,7 @@ declare var CompressionStream: {
* .pipeTo(output.writable); * .pipeTo(output.writable);
* ``` * ```
* *
* @category Compression Streams API * @category Streams
*/ */
declare interface DecompressionStream { declare interface DecompressionStream {
readonly readable: ReadableStream<Uint8Array>; readonly readable: ReadableStream<Uint8Array>;
@ -1203,7 +1203,7 @@ declare interface DecompressionStream {
* .pipeTo(output.writable); * .pipeTo(output.writable);
* ``` * ```
* *
* @category Compression Streams API * @category Streams
*/ */
declare var DecompressionStream: { declare var DecompressionStream: {
readonly prototype: DecompressionStream; readonly prototype: DecompressionStream;
@ -1232,21 +1232,21 @@ declare var DecompressionStream: {
* ``` * ```
* In Deno, this error will terminate the process if not intercepted like above. * In Deno, this error will terminate the process if not intercepted like above.
* *
* @category Web APIs * @category Platform
*/ */
declare function reportError( declare function reportError(
error: any, error: any,
): void; ): void;
/** @category Web APIs */ /** @category Platform */
declare type PredefinedColorSpace = "srgb" | "display-p3"; declare type PredefinedColorSpace = "srgb" | "display-p3";
/** @category Web APIs */ /** @category Platform */
declare interface ImageDataSettings { declare interface ImageDataSettings {
readonly colorSpace?: PredefinedColorSpace; readonly colorSpace?: PredefinedColorSpace;
} }
/** @category Web APIs */ /** @category Platform */
declare interface ImageData { declare interface ImageData {
readonly colorSpace: PredefinedColorSpace; readonly colorSpace: PredefinedColorSpace;
readonly data: Uint8ClampedArray; readonly data: Uint8ClampedArray;
@ -1254,7 +1254,7 @@ declare interface ImageData {
readonly width: number; readonly width: number;
} }
/** @category Web APIs */ /** @category Platform */
declare var ImageData: { declare var ImageData: {
prototype: ImageData; prototype: ImageData;
new (sw: number, sh: number, settings?: ImageDataSettings): ImageData; new (sw: number, sh: number, settings?: ImageDataSettings): ImageData;

14
ext/websocket/lib.deno_websocket.d.ts vendored
View file

@ -5,14 +5,14 @@
/// <reference no-default-lib="true" /> /// <reference no-default-lib="true" />
/// <reference lib="esnext" /> /// <reference lib="esnext" />
/** @category Web Sockets */ /** @category WebSockets */
declare interface CloseEventInit extends EventInit { declare interface CloseEventInit extends EventInit {
code?: number; code?: number;
reason?: string; reason?: string;
wasClean?: boolean; wasClean?: boolean;
} }
/** @category Web Sockets */ /** @category WebSockets */
declare interface CloseEvent extends Event { declare interface CloseEvent extends Event {
/** /**
* Returns the WebSocket connection close code provided by the server. * Returns the WebSocket connection close code provided by the server.
@ -28,13 +28,13 @@ declare interface CloseEvent extends Event {
readonly wasClean: boolean; readonly wasClean: boolean;
} }
/** @category Web Sockets */ /** @category WebSockets */
declare var CloseEvent: { declare var CloseEvent: {
readonly prototype: CloseEvent; readonly prototype: CloseEvent;
new (type: string, eventInitDict?: CloseEventInit): CloseEvent; new (type: string, eventInitDict?: CloseEventInit): CloseEvent;
}; };
/** @category Web Sockets */ /** @category WebSockets */
declare interface WebSocketEventMap { declare interface WebSocketEventMap {
close: CloseEvent; close: CloseEvent;
error: Event; error: Event;
@ -50,7 +50,7 @@ declare interface WebSocketEventMap {
* `Deno.upgradeWebSocket()`. * `Deno.upgradeWebSocket()`.
* *
* @tags allow-net * @tags allow-net
* @category Web Sockets * @category WebSockets
*/ */
declare interface WebSocket extends EventTarget { declare interface WebSocket extends EventTarget {
/** /**
@ -119,7 +119,7 @@ declare interface WebSocket extends EventTarget {
): void; ): void;
} }
/** @category Web Sockets */ /** @category WebSockets */
declare var WebSocket: { declare var WebSocket: {
readonly prototype: WebSocket; readonly prototype: WebSocket;
new (url: string | URL, protocols?: string | string[]): WebSocket; new (url: string | URL, protocols?: string | string[]): WebSocket;
@ -129,5 +129,5 @@ declare var WebSocket: {
readonly OPEN: number; readonly OPEN: number;
}; };
/** @category Web Sockets */ /** @category WebSockets */
declare type BinaryType = "arraybuffer" | "blob"; declare type BinaryType = "arraybuffer" | "blob";

4
ext/webstorage/lib.deno_webstorage.d.ts vendored
View file

@ -9,7 +9,7 @@
* session or local storage. It allows, for example, the addition, modification, * session or local storage. It allows, for example, the addition, modification,
* or deletion of stored data items. * or deletion of stored data items.
* *
* @category Web Storage API * @category Storage
*/ */
declare interface Storage { declare interface Storage {
/** /**
@ -41,7 +41,7 @@ declare interface Storage {
[name: string]: any; [name: string]: any;
} }
/** @category Web Storage API */ /** @category Storage */
declare var Storage: { declare var Storage: {
readonly prototype: Storage; readonly prototype: Storage;
new (): never; new (): never;

4
tests/integration/lsp_tests.rs
View file

@ -1401,7 +1401,7 @@ fn lsp_hover() {
"value": "const Deno.args: string[]" "value": "const Deno.args: string[]"
}, },
"Returns the script arguments to the program.\n\nGive the following command line invocation of Deno:\n\n```sh\ndeno run --allow-read https://examples.deno.land/command-line-arguments.ts Sushi\n```\n\nThen `Deno.args` will contain:\n\n```ts\n[ \"Sushi\" ]\n```\n\nIf you are looking for a structured way to parse arguments, there is\n[`parseArgs()`](https://jsr.io/@std/cli/doc/parse-args/~/parseArgs) from\nthe Deno Standard Library.", "Returns the script arguments to the program.\n\nGive the following command line invocation of Deno:\n\n```sh\ndeno run --allow-read https://examples.deno.land/command-line-arguments.ts Sushi\n```\n\nThen `Deno.args` will contain:\n\n```ts\n[ \"Sushi\" ]\n```\n\nIf you are looking for a structured way to parse arguments, there is\n[`parseArgs()`](https://jsr.io/@std/cli/doc/parse-args/~/parseArgs) from\nthe Deno Standard Library.",
"\n\n*@category* - Runtime Environment", "\n\n*@category* - Runtime",
], ],
"range": { "range": {
"start": { "line": 0, "character": 17 }, "start": { "line": 0, "character": 17 },
@ -6610,7 +6610,7 @@ fn lsp_completions() {
"detail": "const Deno.build: {\n target: string;\n arch: \"x86_64\" | \"aarch64\";\n os: \"darwin\" | \"linux\" | \"android\" | \"windows\" | \"freebsd\" | \"netbsd\" | \"aix\" | \"solaris\" | \"illumos\";\n vendor: string;\n env?: string | undefined;\n}", "detail": "const Deno.build: {\n target: string;\n arch: \"x86_64\" | \"aarch64\";\n os: \"darwin\" | \"linux\" | \"android\" | \"windows\" | \"freebsd\" | \"netbsd\" | \"aix\" | \"solaris\" | \"illumos\";\n vendor: string;\n env?: string | undefined;\n}",
"documentation": { "documentation": {
"kind": "markdown", "kind": "markdown",
"value": "Information related to the build of the current Deno runtime.\n\nUsers are discouraged from code branching based on this information, as\nassumptions about what is available in what build environment might change\nover time. Developers should specifically sniff out the features they\nintend to use.\n\nThe intended use for the information is for logging and debugging purposes.\n\n*@category* - Runtime Environment" "value": "Information related to the build of the current Deno runtime.\n\nUsers are discouraged from code branching based on this information, as\nassumptions about what is available in what build environment might change\nover time. Developers should specifically sniff out the features they\nintend to use.\n\nThe intended use for the information is for logging and debugging purposes.\n\n*@category* - Runtime"
}, },
"sortText": "1", "sortText": "1",
"insertTextFormat": 1 "insertTextFormat": 1