From 7ab7a14db74b037ca8b035a04c28ac0b6e30e716 Mon Sep 17 00:00:00 2001 From: Leo Kettmeir Date: Wed, 22 May 2024 04:31:51 -0700 Subject: [PATCH] refactor(docs): use `@experimental` instead of `@tags unstable` (#23884) --- cli/tsc/dts/lib.deno.unstable.d.ts | 366 +++++++++--------- cli/tsc/dts/lib.deno_webgpu.d.ts | 280 +++++++------- .../lib.deno_broadcast_channel.d.ts | 6 +- tests/integration/lsp_tests.rs | 6 +- tools/jsdoc_checker.js | 10 +- 5 files changed, 336 insertions(+), 332 deletions(-) diff --git a/cli/tsc/dts/lib.deno.unstable.d.ts b/cli/tsc/dts/lib.deno.unstable.d.ts index 488780ff79..f4588a23c7 100644 --- a/cli/tsc/dts/lib.deno.unstable.d.ts +++ b/cli/tsc/dts/lib.deno.unstable.d.ts @@ -13,7 +13,7 @@ declare namespace Deno { /** Information for a HTTP request. * * @category HTTP Server - * @tags unstable + * @experimental */ export interface ServeHandlerInfo { /** The remote address of the connection. */ @@ -39,7 +39,7 @@ declare namespace Deno { * *Note*: This API is not implemented on Windows * * @category File System - * @tags unstable + * @experimental */ export function umask(mask?: number): number; @@ -48,7 +48,7 @@ declare namespace Deno { * All plain number types for interfacing with foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeNumberType = | "u8" @@ -65,7 +65,7 @@ declare namespace Deno { * All BigInt number types for interfacing with foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeBigIntType = | "u64" @@ -78,7 +78,7 @@ declare namespace Deno { * The native boolean type for interfacing to foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeBooleanType = "bool"; @@ -87,7 +87,7 @@ declare namespace Deno { * The native pointer type for interfacing to foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativePointerType = "pointer"; @@ -96,7 +96,7 @@ declare namespace Deno { * The native buffer type for interfacing to foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeBufferType = "buffer"; @@ -105,7 +105,7 @@ declare namespace Deno { * The native function type for interfacing with foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeFunctionType = "function"; @@ -114,7 +114,7 @@ declare namespace Deno { * The native void type for interfacing with foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeVoidType = "void"; @@ -123,56 +123,56 @@ declare namespace Deno { * The native struct type for interfacing with foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeStructType = { readonly struct: readonly NativeType[] }; /** * @category FFI - * @tags unstable + * @experimental */ export const brand: unique symbol; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeU8Enum = "u8" & { [brand]: T }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeI8Enum = "i8" & { [brand]: T }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeU16Enum = "u16" & { [brand]: T }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeI16Enum = "i16" & { [brand]: T }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeU32Enum = "u32" & { [brand]: T }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeI32Enum = "i32" & { [brand]: T }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeTypedPointer = "pointer" & { [brand]: T; }; /** * @category FFI - * @tags unstable + * @experimental */ export type NativeTypedFunction = & "function" @@ -185,7 +185,7 @@ declare namespace Deno { * All supported types for interfacing with foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type NativeType = | NativeNumberType @@ -199,7 +199,7 @@ declare namespace Deno { /** **UNSTABLE**: New API, yet to be vetted. * * @category FFI - * @tags unstable + * @experimental */ export type NativeResultType = NativeType | NativeVoidType; @@ -209,7 +209,7 @@ declare namespace Deno { * types. * * @category FFI - * @tags unstable + * @experimental */ export type ToNativeType = T extends NativeStructType ? BufferSource @@ -235,7 +235,7 @@ declare namespace Deno { * Type conversion for unsafe callback return types. * * @category FFI - * @tags unstable + * @experimental */ export type ToNativeResultType< T extends NativeResultType = NativeResultType, @@ -263,7 +263,7 @@ declare namespace Deno { * A utility type for conversion of parameter types of foreign functions. * * @category FFI - * @tags unstable + * @experimental */ export type ToNativeParameterTypes = // @@ -281,7 +281,7 @@ declare namespace Deno { * parameters. * * @category FFI - * @tags unstable + * @experimental */ export type FromNativeType = T extends NativeStructType ? Uint8Array @@ -307,7 +307,7 @@ declare namespace Deno { * Type conversion for foreign symbol return types. * * @category FFI - * @tags unstable + * @experimental */ export type FromNativeResultType< T extends NativeResultType = NativeResultType, @@ -333,7 +333,7 @@ declare namespace Deno { /** **UNSTABLE**: New API, yet to be vetted. * * @category FFI - * @tags unstable + * @experimental */ export type FromNativeParameterTypes< T extends readonly NativeType[], @@ -353,7 +353,7 @@ declare namespace Deno { * types. * * @category FFI - * @tags unstable + * @experimental */ export interface ForeignFunction< Parameters extends readonly NativeType[] = readonly NativeType[], @@ -386,7 +386,7 @@ declare namespace Deno { /** **UNSTABLE**: New API, yet to be vetted. * * @category FFI - * @tags unstable + * @experimental */ export interface ForeignStatic { /** Name of the symbol, defaults to the key name in symbols object. */ @@ -405,7 +405,7 @@ declare namespace Deno { * A foreign library interface descriptor. * * @category FFI - * @tags unstable + * @experimental */ export interface ForeignLibraryInterface { [name: string]: ForeignFunction | ForeignStatic; @@ -416,7 +416,7 @@ declare namespace Deno { * A utility type that infers a foreign symbol. * * @category FFI - * @tags unstable + * @experimental */ export type StaticForeignSymbol = T extends ForeignFunction ? FromForeignFunction @@ -426,7 +426,7 @@ declare namespace Deno { /** **UNSTABLE**: New API, yet to be vetted. * * @category FFI - * @tags unstable + * @experimental */ export type FromForeignFunction = T["parameters"] extends readonly [] ? () => StaticForeignSymbolReturnType @@ -437,7 +437,7 @@ declare namespace Deno { /** **UNSTABLE**: New API, yet to be vetted. * * @category FFI - * @tags unstable + * @experimental */ export type StaticForeignSymbolReturnType = ConditionalAsync>; @@ -445,7 +445,7 @@ declare namespace Deno { /** **UNSTABLE**: New API, yet to be vetted. * * @category FFI - * @tags unstable + * @experimental */ export type ConditionalAsync = IsAsync extends true ? Promise : T; @@ -455,7 +455,7 @@ declare namespace Deno { * A utility type that infers a foreign library interface. * * @category FFI - * @tags unstable + * @experimental */ export type StaticForeignLibraryInterface = { @@ -478,7 +478,7 @@ declare namespace Deno { * {@linkcode UnsafePointer} class. * * @category FFI - * @tags unstable + * @experimental */ export type PointerObject = { [brand]: T }; @@ -488,7 +488,7 @@ declare namespace Deno { * object or a `null` if the pointer is null. * * @category FFI - * @tags unstable + * @experimental */ export type PointerValue = null | PointerObject; @@ -497,7 +497,7 @@ declare namespace Deno { * A collection of static functions for interacting with pointer objects. * * @category FFI - * @tags unstable + * @experimental */ export class UnsafePointer { /** Create a pointer from a numeric value. This one is really dangerous! */ @@ -525,7 +525,7 @@ declare namespace Deno { * location (numbers, strings and raw bytes). * * @category FFI - * @tags unstable + * @experimental */ export class UnsafePointerView { constructor(pointer: PointerObject); @@ -609,7 +609,7 @@ declare namespace Deno { * as symbols. * * @category FFI - * @tags unstable + * @experimental */ export class UnsafeFnPointer { /** The pointer to the function. */ @@ -630,7 +630,7 @@ declare namespace Deno { * Definition of a unsafe callback function. * * @category FFI - * @tags unstable + * @experimental */ export interface UnsafeCallbackDefinition< Parameters extends readonly NativeType[] = readonly NativeType[], @@ -647,7 +647,7 @@ declare namespace Deno { * An unsafe callback function. * * @category FFI - * @tags unstable + * @experimental */ export type UnsafeCallbackFunction< Parameters extends readonly NativeType[] = readonly NativeType[], @@ -678,7 +678,7 @@ declare namespace Deno { * called from foreign threads. * * @category FFI - * @tags unstable + * @experimental */ export class UnsafeCallback< const Definition extends UnsafeCallbackDefinition = @@ -762,7 +762,7 @@ declare namespace Deno { * library and return this interface. * * @category FFI - * @tags unstable + * @experimental */ export interface DynamicLibrary { /** All of the registered library along with functions for calling them. */ @@ -821,8 +821,9 @@ declare namespace Deno { * console.log(`Result from external addition of 35 and 34: ${result}`); * ``` * - * @tags allow-ffi, unstable + * @tags allow-ffi * @category FFI + * @experimental */ export function dlopen( filename: string | URL, @@ -844,7 +845,7 @@ declare namespace Deno { * | "wayland" (Linux) | `wl_surface*` | `wl_display*` | * * @category GPU - * @tags unstable + * @experimental */ export class UnsafeWindowSurface { constructor( @@ -861,7 +862,7 @@ declare namespace Deno { * These are unstable options which can be used with {@linkcode Deno.run}. * * @category Sub Process - * @tags unstable + * @experimental */ export interface UnstableRunOptions extends RunOptions { /** If `true`, clears the environment variables before executing the @@ -922,8 +923,9 @@ declare namespace Deno { * * Requires `allow-run` permission. * - * @tags allow-run, unstable + * @tags allow-run * @category Sub Process + * @experimental */ export function run( opt: T, @@ -941,7 +943,7 @@ declare namespace Deno { * ``` * * @category Fetch - * @tags unstable + * @experimental */ export interface HttpClient extends Disposable { /** Close the HTTP client. */ @@ -953,7 +955,7 @@ declare namespace Deno { * The options used when creating a {@linkcode Deno.HttpClient}. * * @category Fetch - * @tags unstable + * @experimental */ export interface CreateHttpClientOptions { /** A list of root certificates that will be used in addition to the @@ -992,7 +994,7 @@ declare namespace Deno { * {@linkcode Deno.CreateHttpClientOptions}. * * @category Fetch - * @tags unstable + * @experimental */ export interface Proxy { /** The string URL of the proxy server to use. */ @@ -1007,7 +1009,7 @@ declare namespace Deno { * server when specifying {@linkcode Deno.CreateHttpClientOptions}. * * @category Fetch - * @tags unstable + * @experimental */ export interface BasicAuth { /** The username to be used against the proxy server. */ @@ -1036,7 +1038,7 @@ declare namespace Deno { * ``` * * @category Fetch - * @tags unstable + * @experimental */ export function createHttpClient( options: CreateHttpClientOptions, @@ -1058,7 +1060,7 @@ declare namespace Deno { * ``` * * @category Fetch - * @tags unstable + * @experimental */ export function createHttpClient( options: CreateHttpClientOptions & TlsCertifiedKeyOptions, @@ -1069,7 +1071,7 @@ declare namespace Deno { * Represents membership of a IPv4 multicast group. * * @category Network - * @tags unstable + * @experimental */ export interface MulticastV4Membership { /** Leaves the multicast group. */ @@ -1085,7 +1087,7 @@ declare namespace Deno { * Represents membership of a IPv6 multicast group. * * @category Network - * @tags unstable + * @experimental */ export interface MulticastV6Membership { /** Leaves the multicast group. */ @@ -1099,7 +1101,7 @@ declare namespace Deno { * A generic transport listener for message-oriented protocols. * * @category Network - * @tags unstable + * @experimental */ export interface DatagramConn extends AsyncIterable<[Uint8Array, Addr]> { /** Joins an IPv4 multicast group. */ @@ -1133,7 +1135,7 @@ declare namespace Deno { /** * @category Network - * @tags unstable + * @experimental */ export interface TcpListenOptions extends ListenOptions { /** When `true` the SO_REUSEPORT flag will be set on the listener. This @@ -1156,7 +1158,7 @@ declare namespace Deno { * {@linkcode Deno.listenDatagram}. * * @category Network - * @tags unstable + * @experimental */ export interface UdpListenOptions extends ListenOptions { /** When `true` the specified address will be reused, even if another @@ -1190,8 +1192,9 @@ declare namespace Deno { * * Requires `allow-net` permission. * - * @tags allow-net, unstable + * @tags allow-net * @category Network + * @experimental */ export function listenDatagram( options: UdpListenOptions & { transport: "udp" }, @@ -1210,8 +1213,9 @@ declare namespace Deno { * * Requires `allow-read` and `allow-write` permission. * - * @tags allow-read, allow-write, unstable + * @tags allow-read, allow-write * @category Network + * @experimental */ export function listenDatagram( options: UnixListenOptions & { transport: "unixpacket" }, @@ -1223,7 +1227,7 @@ declare namespace Deno { * * @param [exclusive=false] * @category File System - * @tags unstable + * @experimental */ export function flock(rid: number, exclusive?: boolean): Promise; @@ -1233,7 +1237,7 @@ declare namespace Deno { * * @param [exclusive=false] * @category File System - * @tags unstable + * @experimental */ export function flockSync(rid: number, exclusive?: boolean): void; @@ -1242,7 +1246,7 @@ declare namespace Deno { * Release an advisory file-system lock for the provided file. * * @category File System - * @tags unstable + * @experimental */ export function funlock(rid: number): Promise; @@ -1251,7 +1255,7 @@ declare namespace Deno { * Release an advisory file-system lock for the provided file synchronously. * * @category File System - * @tags unstable + * @experimental */ export function funlockSync(rid: number): void; @@ -1268,8 +1272,9 @@ declare namespace Deno { * `localStorage` persistence). More information about the origin storage key * can be found in the Deno Manual. * - * @tags allow-read, allow-write, unstable + * @tags allow-read, allow-write * @category Cloud + * @experimental */ export function openKv(path?: string): Promise; @@ -1278,7 +1283,7 @@ declare namespace Deno { * CronScheduleExpression is used as the type of `minute`, `hour`, * `dayOfMonth`, `month`, and `dayOfWeek` in {@linkcode CronSchedule}. * @category Cloud - * @tags unstable + * @experimental */ export type CronScheduleExpression = number | { exact: number | number[] } | { start?: number; @@ -1291,7 +1296,7 @@ declare namespace Deno { * CronSchedule is the interface used for JSON format * cron `schedule`. * @category Cloud - * @tags unstable + * @experimental */ export interface CronSchedule { minute?: CronScheduleExpression; @@ -1323,7 +1328,7 @@ declare namespace Deno { * using UTC time zone. * * @category Cloud - * @tags unstable + * @experimental */ export function cron( name: string, @@ -1355,7 +1360,7 @@ declare namespace Deno { * second, 5 seconds, and 10 seconds delay between each retry. * * @category Cloud - * @tags unstable + * @experimental */ export function cron( name: string, @@ -1380,7 +1385,7 @@ declare namespace Deno { * was passed to. * * @category Cloud - * @tags unstable + * @experimental */ export type KvKey = readonly KvKeyPart[]; @@ -1417,7 +1422,7 @@ declare namespace Deno { * over the ordering of values within a type. * * @category Cloud - * @tags unstable + * @experimental */ export type KvKeyPart = | Uint8Array @@ -1435,7 +1440,7 @@ declare namespace Deno { * - `eventual` - Eventually-consistent behavior is allowed. * * @category Cloud - * @tags unstable + * @experimental */ export type KvConsistencyLevel = "strong" | "eventual"; @@ -1450,7 +1455,7 @@ declare namespace Deno { * lexicographically between the given start and end keys. * * @category Cloud - * @tags unstable + * @experimental */ export type KvListSelector = | { prefix: KvKey } @@ -1489,7 +1494,7 @@ declare namespace Deno { * the value is set to the given value. * * @category Cloud - * @tags unstable + * @experimental */ export type KvMutation = & { key: KvKey } @@ -1509,7 +1514,7 @@ declare namespace Deno { * iteration from the current position in the future. * * @category Cloud - * @tags unstable + * @experimental */ export class KvListIterator implements AsyncIterableIterator> { /** @@ -1532,7 +1537,7 @@ declare namespace Deno { * by passing it to the `check` method of a {@linkcode Deno.AtomicOperation}. * * @category Cloud - * @tags unstable + * @experimental */ export type KvEntry = { key: KvKey; value: T; versionstamp: string }; @@ -1545,7 +1550,7 @@ declare namespace Deno { * fields may be `null` if no value exists for the given key in the KV store. * * @category Cloud - * @tags unstable + * @experimental */ export type KvEntryMaybe = KvEntry | { key: KvKey; @@ -1558,7 +1563,7 @@ declare namespace Deno { * Options for listing key-value pairs in a {@linkcode Deno.Kv}. * * @category Cloud - * @tags unstable + * @experimental */ export interface KvListOptions { /** @@ -1613,7 +1618,7 @@ declare namespace Deno { /** * @category Cloud - * @tags unstable + * @experimental */ export interface KvCommitResult { ok: true; @@ -1623,7 +1628,7 @@ declare namespace Deno { /** * @category Cloud - * @tags unstable + * @experimental */ export interface KvCommitError { ok: false; @@ -1637,7 +1642,7 @@ declare namespace Deno { * that the key-value pair does not currently exist in the KV store. * * @category Cloud - * @tags unstable + * @experimental */ export interface AtomicCheck { key: KvKey; @@ -1679,7 +1684,7 @@ declare namespace Deno { * and the versionstamp of the value committed to KV. * * @category Cloud - * @tags unstable + * @experimental */ export class AtomicOperation { /** @@ -1796,7 +1801,7 @@ declare namespace Deno { * an exception will be thrown. * * @category Cloud - * @tags unstable + * @experimental */ export class Kv implements Disposable { /** @@ -2067,7 +2072,7 @@ declare namespace Deno { * {@linkcode Deno.Kv}. * * @category Cloud - * @tags unstable + * @experimental */ export class KvU64 { /** Create a new `KvU64` instance from the given bigint value. If the value @@ -2083,12 +2088,12 @@ declare namespace Deno { * When accessed outside of Jupyter notebook context an error will be thrown. * * @category Jupyter - * @tags unstable + * @experimental */ export namespace jupyter { /** * @category Jupyter - * @tags unstable + * @experimental */ export interface DisplayOptions { raw?: boolean; @@ -2098,7 +2103,7 @@ declare namespace Deno { /** * @category Jupyter - * @tags unstable + * @experimental */ export type VegaObject = { $schema: string; @@ -2109,7 +2114,7 @@ declare namespace Deno { * A collection of supported media types and data for Jupyter frontends. * * @category Jupyter - * @tags unstable + * @experimental */ export type MediaBundle = { "text/plain"?: string; @@ -2141,13 +2146,13 @@ declare namespace Deno { /** * @category Jupyter - * @tags unstable + * @experimental */ export const $display: unique symbol; /** * @category Jupyter - * @tags unstable + * @experimental */ export type Displayable = { [$display]: () => MediaBundle | Promise; @@ -2161,7 +2166,7 @@ declare namespace Deno { * @param obj - The object to be displayed * @param options - Display options with a default { raw: true } * @category Jupyter - * @tags unstable + * @experimental */ export function display(obj: unknown, options?: DisplayOptions): void; @@ -2186,7 +2191,7 @@ declare namespace Deno { * ``` * * @category Jupyter - * @tags unstable + * @experimental */ export function md( strings: TemplateStringsArray, @@ -2206,7 +2211,7 @@ declare namespace Deno { * ``` * * @category Jupyter - * @tags unstable + * @experimental */ export function html( strings: TemplateStringsArray, @@ -2225,7 +2230,7 @@ declare namespace Deno { * ` * * @category Jupyter - * @tags unstable + * @experimental */ export function svg( strings: TemplateStringsArray, @@ -2239,7 +2244,7 @@ declare namespace Deno { * @returns MediaBundle * * @category Jupyter - * @tags unstable + * @experimental */ export function format(obj: unknown): MediaBundle; @@ -2263,7 +2268,7 @@ declare namespace Deno { * ``` * * @category Jupyter - * @tags unstable + * @experimental */ export function broadcast( msgType: string, @@ -2282,8 +2287,9 @@ declare namespace Deno { * which also supports setting a {@linkcode Deno.HttpClient} which provides a * way to connect via proxies and use custom TLS certificates. * - * @tags allow-net, allow-read, unstable + * @tags allow-net, allow-read * @category Fetch + * @experimental */ declare function fetch( input: Request | URL | string, @@ -2293,7 +2299,7 @@ declare function fetch( /** **UNSTABLE**: New API, yet to be vetted. * * @category Workers - * @tags unstable + * @experimental */ declare interface WorkerOptions { /** **UNSTABLE**: New API, yet to be vetted. @@ -2334,7 +2340,7 @@ declare interface WorkerOptions { /** **UNSTABLE**: New API, yet to be vetted. * * @category WebSockets - * @tags unstable + * @experimental */ declare interface WebSocketStreamOptions { protocols?: string[]; @@ -2345,7 +2351,7 @@ declare interface WebSocketStreamOptions { /** **UNSTABLE**: New API, yet to be vetted. * * @category WebSockets - * @tags unstable + * @experimental */ declare interface WebSocketConnection { readable: ReadableStream; @@ -2357,7 +2363,7 @@ declare interface WebSocketConnection { /** **UNSTABLE**: New API, yet to be vetted. * * @category WebSockets - * @tags unstable + * @experimental */ declare interface WebSocketCloseInfo { code?: number; @@ -2366,8 +2372,9 @@ declare interface WebSocketCloseInfo { /** **UNSTABLE**: New API, yet to be vetted. * - * @tags allow-net, unstable + * @tags allow-net * @category WebSockets + * @experimental */ declare interface WebSocketStream { url: string; @@ -2378,8 +2385,9 @@ declare interface WebSocketStream { /** **UNSTABLE**: New API, yet to be vetted. * - * @tags allow-net, unstable + * @tags allow-net * @category WebSockets + * @experimental */ declare var WebSocketStream: { readonly prototype: WebSocketStream; @@ -2388,8 +2396,9 @@ declare var WebSocketStream: { /** **UNSTABLE**: New API, yet to be vetted. * - * @tags allow-net, unstable + * @tags allow-net * @category WebSockets + * @experimental */ declare interface WebSocketError extends DOMException { readonly closeCode: number; @@ -2398,8 +2407,9 @@ declare interface WebSocketError extends DOMException { /** **UNSTABLE**: New API, yet to be vetted. * - * @tags allow-net, unstable + * @tags allow-net * @category WebSockets + * @experimental */ declare var WebSocketError: { readonly prototype: WebSocketError; @@ -2412,17 +2422,17 @@ declare var WebSocketError: { * [Specification](https://tc39.es/proposal-temporal/docs/index.html) * * @category Temporal - * @tags unstable + * @experimental */ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type ComparisonResult = -1 | 0 | 1; /** * @category Temporal - * @tags unstable + * @experimental */ export type RoundingMode = | "ceil" @@ -2440,7 +2450,7 @@ declare namespace Temporal { * `from()`. * * @category Temporal - * @tags unstable + * @experimental */ export type AssignmentOptions = { /** @@ -2462,7 +2472,7 @@ declare namespace Temporal { * `Duration.prototype.add()` and `Duration.prototype.subtract()`. * * @category Temporal - * @tags unstable + * @experimental */ export type DurationOptions = { /** @@ -2482,7 +2492,7 @@ declare namespace Temporal { * Options for conversions of `Temporal.PlainDateTime` to `Temporal.Instant` * * @category Temporal - * @tags unstable + * @experimental */ export type ToInstantOptions = { /** @@ -2512,7 +2522,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type OffsetDisambiguationOptions = { /** @@ -2552,7 +2562,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type ZonedDateTimeAssignmentOptions = Partial< AssignmentOptions & ToInstantOptions & OffsetDisambiguationOptions @@ -2562,7 +2572,7 @@ declare namespace Temporal { * Options for arithmetic operations like `add()` and `subtract()` * * @category Temporal - * @tags unstable + * @experimental */ export type ArithmeticOptions = { /** @@ -2578,12 +2588,12 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type DateUnit = "year" | "month" | "week" | "day"; /** * @category Temporal - * @tags unstable + * @experimental */ export type TimeUnit = | "hour" @@ -2594,7 +2604,7 @@ declare namespace Temporal { | "nanosecond"; /** * @category Temporal - * @tags unstable + * @experimental */ export type DateTimeUnit = DateUnit | TimeUnit; @@ -2604,7 +2614,7 @@ declare namespace Temporal { * or 'hours' are aso accepted too. * * @category Temporal - * @tags unstable + * @experimental */ export type PluralUnit = { year: "years"; @@ -2621,17 +2631,17 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type LargestUnit = "auto" | T | PluralUnit; /** * @category Temporal - * @tags unstable + * @experimental */ export type SmallestUnit = T | PluralUnit; /** * @category Temporal - * @tags unstable + * @experimental */ export type TotalUnit = T | PluralUnit; @@ -2639,7 +2649,7 @@ declare namespace Temporal { * Options for outputting precision in toString() on types with seconds * * @category Temporal - * @tags unstable + * @experimental */ export type ToStringPrecisionOptions = { fractionalSecondDigits?: "auto" | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9; @@ -2666,7 +2676,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type ShowCalendarOption = { calendarName?: "auto" | "always" | "never" | "critical"; @@ -2674,7 +2684,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type CalendarTypeToStringOptions = Partial< ToStringPrecisionOptions & ShowCalendarOption @@ -2682,7 +2692,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type ZonedDateTimeToStringOptions = Partial< CalendarTypeToStringOptions & { @@ -2693,7 +2703,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type InstantToStringOptions = Partial< ToStringPrecisionOptions & { @@ -2706,7 +2716,7 @@ declare namespace Temporal { * `Temporal` types. * * @category Temporal - * @tags unstable + * @experimental */ export interface DifferenceOptions { /** @@ -2769,7 +2779,7 @@ declare namespace Temporal { * `smallestUnit` property value is that string. * * @category Temporal - * @tags unstable + * @experimental */ export type RoundTo = | SmallestUnit @@ -2815,7 +2825,7 @@ declare namespace Temporal { * object whose `smallestUnit` property value is that string. * * @category Temporal - * @tags unstable + * @experimental */ export type DurationRoundTo = | SmallestUnit @@ -2946,7 +2956,7 @@ declare namespace Temporal { * Options to control behavior of `Duration.prototype.total()` * * @category Temporal - * @tags unstable + * @experimental */ export type DurationTotalOf = | TotalUnit @@ -2991,7 +3001,7 @@ declare namespace Temporal { * `Duration.subtract()` * * @category Temporal - * @tags unstable + * @experimental */ export interface DurationArithmeticOptions { /** @@ -3024,7 +3034,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type DurationLike = { years?: number; @@ -3046,7 +3056,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/duration.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class Duration { static from( @@ -3119,7 +3129,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/instant.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class Instant { static fromEpochSeconds(epochSeconds: number): Temporal.Instant; @@ -3201,14 +3211,14 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type YearOrEraAndEraYear = { era: string; eraYear: number } | { year: number; }; /** * @category Temporal - * @tags unstable + * @experimental */ export type MonthCodeOrMonthAndYear = | (YearOrEraAndEraYear & { month: number }) @@ -3217,13 +3227,13 @@ declare namespace Temporal { }; /** * @category Temporal - * @tags unstable + * @experimental */ export type MonthOrMonthCode = { month: number } | { monthCode: string }; /** * @category Temporal - * @tags unstable + * @experimental */ export interface CalendarProtocol { id: string; @@ -3377,7 +3387,7 @@ declare namespace Temporal { * Any of these types can be passed to Temporal methods instead of a Temporal.Calendar. * * @category Temporal - * @tags unstable + * @experimental */ export type CalendarLike = | string @@ -3397,7 +3407,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/calendar.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class Calendar implements CalendarProtocol { static from(item: CalendarLike): Temporal.Calendar | CalendarProtocol; @@ -3552,7 +3562,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainDateLike = { era?: string | undefined; @@ -3566,7 +3576,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainDateISOFields = { isoYear: number; @@ -3585,7 +3595,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/date.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class PlainDate { static from( @@ -3668,7 +3678,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainDateTimeLike = { era?: string | undefined; @@ -3688,7 +3698,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainDateTimeISOFields = { isoYear: number; @@ -3714,7 +3724,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/datetime.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class PlainDateTime { static from( @@ -3842,7 +3852,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainMonthDayLike = { era?: string | undefined; @@ -3862,7 +3872,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/monthday.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class PlainMonthDay { static from( @@ -3898,7 +3908,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainTimeLike = { hour?: number; @@ -3911,7 +3921,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainTimeISOFields = { isoHour: number; @@ -3938,7 +3948,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/time.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class PlainTime { static from( @@ -4030,7 +4040,7 @@ declare namespace Temporal { * A plain object implementing the protocol for a custom time zone. * * @category Temporal - * @tags unstable + * @experimental */ export interface TimeZoneProtocol { id: string; @@ -4061,7 +4071,7 @@ declare namespace Temporal { * Any of these types can be passed to Temporal methods instead of a Temporal.TimeZone. * * @category Temporal - * @tags unstable + * @experimental */ export type TimeZoneLike = string | TimeZoneProtocol | ZonedDateTime; @@ -4080,7 +4090,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/timezone.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class TimeZone implements TimeZoneProtocol { static from(timeZone: TimeZoneLike): Temporal.TimeZone | TimeZoneProtocol; @@ -4113,7 +4123,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type PlainYearMonthLike = { era?: string | undefined; @@ -4132,7 +4142,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/yearmonth.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export class PlainYearMonth { static from( @@ -4197,7 +4207,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type ZonedDateTimeLike = { era?: string | undefined; @@ -4219,7 +4229,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export type ZonedDateTimeISOFields = { isoYear: number; @@ -4238,7 +4248,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ export class ZonedDateTime { static from( @@ -4373,7 +4383,7 @@ declare namespace Temporal { * See https://tc39.es/proposal-temporal/docs/now.html for more details. * * @category Temporal - * @tags unstable + * @experimental */ export const Now: { /** @@ -4529,7 +4539,7 @@ declare namespace Temporal { /** * @category Temporal - * @tags unstable + * @experimental */ declare interface Date { toTemporalInstant(): Temporal.Instant; @@ -4537,12 +4547,12 @@ declare interface Date { /** * @category Intl - * @tags unstable + * @experimental */ declare namespace Intl { /** * @category Intl - * @tags unstable + * @experimental */ export type Formattable = | Date @@ -4556,7 +4566,7 @@ declare namespace Intl { /** * @category Intl - * @tags unstable + * @experimental */ export interface DateTimeFormatRangePart { source: "shared" | "startRange" | "endRange"; @@ -4564,7 +4574,7 @@ declare namespace Intl { /** * @category Intl - * @tags unstable + * @experimental */ export interface DateTimeFormat { /** @@ -4616,7 +4626,7 @@ declare namespace Intl { /** * @category Intl - * @tags unstable + * @experimental */ export interface DateTimeFormatOptions { // TODO: remove the props below after TS lib declarations are updated @@ -4631,7 +4641,7 @@ declare namespace Intl { * of bytes could not be allocated an exception is raised. * * @category Platform - * @tags unstable + * @experimental */ declare interface Float16Array { /** @@ -4946,7 +4956,7 @@ declare interface Float16Array { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16ArrayConstructor { readonly prototype: Float16Array; @@ -4989,13 +4999,13 @@ declare interface Float16ArrayConstructor { } /** * @category Platform - * @tags unstable + * @experimental */ declare var Float16Array: Float16ArrayConstructor; /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16 { [Symbol.iterator](): IterableIterator; @@ -5015,7 +5025,7 @@ declare interface Float16 { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16Constructor { new (elements: Iterable): Float16; @@ -5035,7 +5045,7 @@ declare interface Float16Constructor { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16Array { readonly [Symbol.toStringTag]: "Float16Array"; @@ -5043,7 +5053,7 @@ declare interface Float16Array { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16Array { /** @@ -5056,7 +5066,7 @@ declare interface Float16Array { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16ArrayConstructor { new (): Float16Array; @@ -5064,7 +5074,7 @@ declare interface Float16ArrayConstructor { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16Array { /** @@ -5076,7 +5086,7 @@ declare interface Float16Array { /** * @category Platform - * @tags unstable + * @experimental */ declare interface Float16Array { /** @@ -5152,7 +5162,7 @@ declare interface Float16Array { /** * @category Platform - * @tags unstable + * @experimental */ declare interface DataView { /** diff --git a/cli/tsc/dts/lib.deno_webgpu.d.ts b/cli/tsc/dts/lib.deno_webgpu.d.ts index 8051a051b5..73d6d71c9a 100644 --- a/cli/tsc/dts/lib.deno_webgpu.d.ts +++ b/cli/tsc/dts/lib.deno_webgpu.d.ts @@ -7,7 +7,7 @@ /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUObjectBase { label: string; @@ -15,7 +15,7 @@ declare interface GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUObjectDescriptorBase { label?: string; @@ -23,7 +23,7 @@ declare interface GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUSupportedLimits { maxTextureDimension1D?: number; @@ -60,7 +60,7 @@ declare class GPUSupportedLimits { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUSupportedFeatures { forEach( @@ -81,7 +81,7 @@ declare class GPUSupportedFeatures { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUAdapterInfo { readonly vendor: string; @@ -92,7 +92,7 @@ declare class GPUAdapterInfo { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPU { requestAdapter( @@ -103,7 +103,7 @@ declare class GPU { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURequestAdapterOptions { powerPreference?: GPUPowerPreference; @@ -112,13 +112,13 @@ declare interface GPURequestAdapterOptions { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUPowerPreference = "low-power" | "high-performance"; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUAdapter { readonly features: GPUSupportedFeatures; @@ -131,7 +131,7 @@ declare class GPUAdapter { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUDeviceDescriptor extends GPUObjectDescriptorBase { requiredFeatures?: GPUFeatureName[]; @@ -140,7 +140,7 @@ declare interface GPUDeviceDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUFeatureName = | "depth-clip-control" @@ -171,7 +171,7 @@ declare type GPUFeatureName = /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUDevice extends EventTarget implements GPUObjectBase { label: string; @@ -224,7 +224,7 @@ declare class GPUDevice extends EventTarget implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUBuffer implements GPUObjectBase { label: string; @@ -246,13 +246,13 @@ declare class GPUBuffer implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUBufferMapState = "unmapped" | "pending" | "mapped"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBufferDescriptor extends GPUObjectDescriptorBase { size: number; @@ -262,19 +262,19 @@ declare interface GPUBufferDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUBufferUsageFlags = number; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUFlagsConstant = number; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUBufferUsage { static MAP_READ: 0x0001; @@ -291,13 +291,13 @@ declare class GPUBufferUsage { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUMapModeFlags = number; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUMapMode { static READ: 0x0001; @@ -306,7 +306,7 @@ declare class GPUMapMode { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUTexture implements GPUObjectBase { label: string; @@ -326,7 +326,7 @@ declare class GPUTexture implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUTextureDescriptor extends GPUObjectDescriptorBase { size: GPUExtent3D; @@ -340,19 +340,19 @@ declare interface GPUTextureDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUTextureDimension = "1d" | "2d" | "3d"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUTextureUsageFlags = number; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUTextureUsage { static COPY_SRC: 0x01; @@ -364,7 +364,7 @@ declare class GPUTextureUsage { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUTextureView implements GPUObjectBase { label: string; @@ -372,7 +372,7 @@ declare class GPUTextureView implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUTextureViewDescriptor extends GPUObjectDescriptorBase { format?: GPUTextureFormat; @@ -386,7 +386,7 @@ declare interface GPUTextureViewDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUTextureViewDimension = | "1d" @@ -398,13 +398,13 @@ declare type GPUTextureViewDimension = /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUTextureAspect = "all" | "stencil-only" | "depth-only"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUTextureFormat = | "r8unorm" @@ -505,7 +505,7 @@ declare type GPUTextureFormat = /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUSampler implements GPUObjectBase { label: string; @@ -513,7 +513,7 @@ declare class GPUSampler implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUSamplerDescriptor extends GPUObjectDescriptorBase { addressModeU?: GPUAddressMode; @@ -530,25 +530,25 @@ declare interface GPUSamplerDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUAddressMode = "clamp-to-edge" | "repeat" | "mirror-repeat"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUFilterMode = "nearest" | "linear"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUMipmapFilterMode = "nearest" | "linear"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUCompareFunction = | "never" @@ -562,7 +562,7 @@ declare type GPUCompareFunction = /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUBindGroupLayout implements GPUObjectBase { label: string; @@ -570,7 +570,7 @@ declare class GPUBindGroupLayout implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBindGroupLayoutDescriptor extends GPUObjectDescriptorBase { entries: GPUBindGroupLayoutEntry[]; @@ -578,7 +578,7 @@ declare interface GPUBindGroupLayoutDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBindGroupLayoutEntry { binding: number; @@ -592,13 +592,13 @@ declare interface GPUBindGroupLayoutEntry { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUShaderStageFlags = number; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUShaderStage { static VERTEX: 0x1; @@ -608,7 +608,7 @@ declare class GPUShaderStage { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBufferBindingLayout { type?: GPUBufferBindingType; @@ -618,13 +618,13 @@ declare interface GPUBufferBindingLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUBufferBindingType = "uniform" | "storage" | "read-only-storage"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUSamplerBindingLayout { type?: GPUSamplerBindingType; @@ -632,7 +632,7 @@ declare interface GPUSamplerBindingLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUSamplerBindingType = | "filtering" @@ -641,7 +641,7 @@ declare type GPUSamplerBindingType = /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUTextureBindingLayout { sampleType?: GPUTextureSampleType; @@ -651,7 +651,7 @@ declare interface GPUTextureBindingLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUTextureSampleType = | "float" @@ -662,7 +662,7 @@ declare type GPUTextureSampleType = /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUStorageTextureAccess = | "write-only" @@ -671,7 +671,7 @@ declare type GPUStorageTextureAccess = /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUStorageTextureBindingLayout { access: GPUStorageTextureAccess; @@ -681,7 +681,7 @@ declare interface GPUStorageTextureBindingLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUBindGroup implements GPUObjectBase { label: string; @@ -689,7 +689,7 @@ declare class GPUBindGroup implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBindGroupDescriptor extends GPUObjectDescriptorBase { layout: GPUBindGroupLayout; @@ -698,7 +698,7 @@ declare interface GPUBindGroupDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUBindingResource = | GPUSampler @@ -707,7 +707,7 @@ declare type GPUBindingResource = /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBindGroupEntry { binding: number; @@ -716,7 +716,7 @@ declare interface GPUBindGroupEntry { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBufferBinding { buffer: GPUBuffer; @@ -726,7 +726,7 @@ declare interface GPUBufferBinding { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUPipelineLayout implements GPUObjectBase { label: string; @@ -734,7 +734,7 @@ declare class GPUPipelineLayout implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUPipelineLayoutDescriptor extends GPUObjectDescriptorBase { bindGroupLayouts: GPUBindGroupLayout[]; @@ -742,13 +742,13 @@ declare interface GPUPipelineLayoutDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUCompilationMessageType = "error" | "warning" | "info"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUCompilationMessage { readonly message: string; @@ -759,7 +759,7 @@ declare interface GPUCompilationMessage { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUCompilationInfo { readonly messages: ReadonlyArray; @@ -767,7 +767,7 @@ declare interface GPUCompilationInfo { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUPipelineError extends DOMException { constructor(message?: string, options?: GPUPipelineErrorInit); @@ -777,7 +777,7 @@ declare class GPUPipelineError extends DOMException { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUPipelineErrorInit { reason: GPUPipelineErrorReason; @@ -785,13 +785,13 @@ declare interface GPUPipelineErrorInit { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUPipelineErrorReason = "validation" | "internal"; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUShaderModule implements GPUObjectBase { label: string; @@ -799,7 +799,7 @@ declare class GPUShaderModule implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUShaderModuleDescriptor extends GPUObjectDescriptorBase { code: string; @@ -808,13 +808,13 @@ declare interface GPUShaderModuleDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUAutoLayoutMode = "auto"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUPipelineDescriptorBase extends GPUObjectDescriptorBase { layout: GPUPipelineLayout | GPUAutoLayoutMode; @@ -822,7 +822,7 @@ declare interface GPUPipelineDescriptorBase extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUPipelineBase { getBindGroupLayout(index: number): GPUBindGroupLayout; @@ -830,7 +830,7 @@ declare interface GPUPipelineBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUProgrammableStage { module: GPUShaderModule; @@ -840,7 +840,7 @@ declare interface GPUProgrammableStage { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUComputePipeline implements GPUObjectBase, GPUPipelineBase { label: string; @@ -850,7 +850,7 @@ declare class GPUComputePipeline implements GPUObjectBase, GPUPipelineBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUComputePipelineDescriptor extends GPUPipelineDescriptorBase { @@ -859,7 +859,7 @@ declare interface GPUComputePipelineDescriptor /** * @category GPU - * @tags unstable + * @experimental */ declare class GPURenderPipeline implements GPUObjectBase, GPUPipelineBase { label: string; @@ -869,7 +869,7 @@ declare class GPURenderPipeline implements GPUObjectBase, GPUPipelineBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderPipelineDescriptor extends GPUPipelineDescriptorBase { @@ -882,7 +882,7 @@ declare interface GPURenderPipelineDescriptor /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUPrimitiveState { topology?: GPUPrimitiveTopology; @@ -894,7 +894,7 @@ declare interface GPUPrimitiveState { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUPrimitiveTopology = | "point-list" @@ -905,19 +905,19 @@ declare type GPUPrimitiveTopology = /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUFrontFace = "ccw" | "cw"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUCullMode = "none" | "front" | "back"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUMultisampleState { count?: number; @@ -927,7 +927,7 @@ declare interface GPUMultisampleState { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUFragmentState extends GPUProgrammableStage { targets: (GPUColorTargetState | null)[]; @@ -935,7 +935,7 @@ declare interface GPUFragmentState extends GPUProgrammableStage { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUColorTargetState { format: GPUTextureFormat; @@ -946,7 +946,7 @@ declare interface GPUColorTargetState { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBlendState { color: GPUBlendComponent; @@ -955,13 +955,13 @@ declare interface GPUBlendState { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUColorWriteFlags = number; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUColorWrite { static RED: 0x1; @@ -973,7 +973,7 @@ declare class GPUColorWrite { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUBlendComponent { operation?: GPUBlendOperation; @@ -983,7 +983,7 @@ declare interface GPUBlendComponent { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUBlendFactor = | "zero" @@ -1002,7 +1002,7 @@ declare type GPUBlendFactor = /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUBlendOperation = | "add" @@ -1013,7 +1013,7 @@ declare type GPUBlendOperation = /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUDepthStencilState { format: GPUTextureFormat; @@ -1034,7 +1034,7 @@ declare interface GPUDepthStencilState { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUStencilFaceState { compare?: GPUCompareFunction; @@ -1045,7 +1045,7 @@ declare interface GPUStencilFaceState { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUStencilOperation = | "keep" @@ -1059,13 +1059,13 @@ declare type GPUStencilOperation = /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUIndexFormat = "uint16" | "uint32"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUVertexFormat = | "uint8x2" @@ -1102,13 +1102,13 @@ declare type GPUVertexFormat = /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUVertexStepMode = "vertex" | "instance"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUVertexState extends GPUProgrammableStage { buffers?: (GPUVertexBufferLayout | null)[]; @@ -1116,7 +1116,7 @@ declare interface GPUVertexState extends GPUProgrammableStage { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUVertexBufferLayout { arrayStride: number; @@ -1126,7 +1126,7 @@ declare interface GPUVertexBufferLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUVertexAttribute { format: GPUVertexFormat; @@ -1137,7 +1137,7 @@ declare interface GPUVertexAttribute { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUImageDataLayout { offset?: number; @@ -1147,7 +1147,7 @@ declare interface GPUImageDataLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUCommandBuffer implements GPUObjectBase { label: string; @@ -1155,13 +1155,13 @@ declare class GPUCommandBuffer implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUCommandBufferDescriptor extends GPUObjectDescriptorBase {} /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUCommandEncoder implements GPUObjectBase { label: string; @@ -1222,13 +1222,13 @@ declare class GPUCommandEncoder implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUCommandEncoderDescriptor extends GPUObjectDescriptorBase {} /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUImageCopyBuffer extends GPUImageDataLayout { buffer: GPUBuffer; @@ -1236,7 +1236,7 @@ declare interface GPUImageCopyBuffer extends GPUImageDataLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUImageCopyTexture { texture: GPUTexture; @@ -1247,7 +1247,7 @@ declare interface GPUImageCopyTexture { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUProgrammablePassEncoder { setBindGroup( @@ -1271,7 +1271,7 @@ declare interface GPUProgrammablePassEncoder { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUComputePassEncoder implements GPUObjectBase, GPUProgrammablePassEncoder { @@ -1303,7 +1303,7 @@ declare class GPUComputePassEncoder /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUComputePassTimestampWrites { querySet: GPUQuerySet; @@ -1313,7 +1313,7 @@ declare interface GPUComputePassTimestampWrites { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUComputePassDescriptor extends GPUObjectDescriptorBase { timestampWrites?: GPUComputePassTimestampWrites; @@ -1321,7 +1321,7 @@ declare interface GPUComputePassDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderEncoderBase { setPipeline(pipeline: GPURenderPipeline): undefined; @@ -1362,7 +1362,7 @@ declare interface GPURenderEncoderBase { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPURenderPassEncoder implements GPUObjectBase, GPUProgrammablePassEncoder, GPURenderEncoderBase { @@ -1442,7 +1442,7 @@ declare class GPURenderPassEncoder /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderPassTimestampWrites { querySet: GPUQuerySet; @@ -1452,7 +1452,7 @@ declare interface GPURenderPassTimestampWrites { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderPassDescriptor extends GPUObjectDescriptorBase { colorAttachments: (GPURenderPassColorAttachment | null)[]; @@ -1463,7 +1463,7 @@ declare interface GPURenderPassDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderPassColorAttachment { view: GPUTextureView; @@ -1476,7 +1476,7 @@ declare interface GPURenderPassColorAttachment { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderPassDepthStencilAttachment { view: GPUTextureView; @@ -1494,19 +1494,19 @@ declare interface GPURenderPassDepthStencilAttachment { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPULoadOp = "load" | "clear"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUStoreOp = "store" | "discard"; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPURenderBundle implements GPUObjectBase { label: string; @@ -1514,13 +1514,13 @@ declare class GPURenderBundle implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderBundleDescriptor extends GPUObjectDescriptorBase {} /** * @category GPU - * @tags unstable + * @experimental */ declare class GPURenderBundleEncoder implements GPUObjectBase, GPUProgrammablePassEncoder, GPURenderEncoderBase { @@ -1577,7 +1577,7 @@ declare class GPURenderBundleEncoder /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderPassLayout extends GPUObjectDescriptorBase { colorFormats: (GPUTextureFormat | null)[]; @@ -1587,7 +1587,7 @@ declare interface GPURenderPassLayout extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPURenderBundleEncoderDescriptor extends GPURenderPassLayout { depthReadOnly?: boolean; @@ -1596,7 +1596,7 @@ declare interface GPURenderBundleEncoderDescriptor extends GPURenderPassLayout { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUQueue implements GPUObjectBase { label: string; @@ -1623,7 +1623,7 @@ declare class GPUQueue implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUQuerySet implements GPUObjectBase { label: string; @@ -1636,7 +1636,7 @@ declare class GPUQuerySet implements GPUObjectBase { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUQuerySetDescriptor extends GPUObjectDescriptorBase { type: GPUQueryType; @@ -1645,19 +1645,19 @@ declare interface GPUQuerySetDescriptor extends GPUObjectDescriptorBase { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUQueryType = "occlusion" | "timestamp"; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUDeviceLostReason = "destroyed"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUDeviceLostInfo { readonly reason: GPUDeviceLostReason; @@ -1666,7 +1666,7 @@ declare interface GPUDeviceLostInfo { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUError { readonly message: string; @@ -1674,7 +1674,7 @@ declare class GPUError { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUOutOfMemoryError extends GPUError { constructor(message: string); @@ -1682,7 +1682,7 @@ declare class GPUOutOfMemoryError extends GPUError { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUValidationError extends GPUError { constructor(message: string); @@ -1690,7 +1690,7 @@ declare class GPUValidationError extends GPUError { /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUInternalError extends GPUError { constructor(message: string); @@ -1698,13 +1698,13 @@ declare class GPUInternalError extends GPUError { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUErrorFilter = "out-of-memory" | "validation" | "internal"; /** * @category GPU - * @tags unstable + * @experimental */ declare class GPUUncapturedErrorEvent extends EventTarget { constructor( @@ -1717,7 +1717,7 @@ declare class GPUUncapturedErrorEvent extends EventTarget { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUUncapturedErrorEventInit extends EventInit { error: GPUError; @@ -1725,7 +1725,7 @@ declare interface GPUUncapturedErrorEventInit extends EventInit { /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUColorDict { r: number; @@ -1736,13 +1736,13 @@ declare interface GPUColorDict { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUColor = number[] | GPUColorDict; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUOrigin3DDict { x?: number; @@ -1752,13 +1752,13 @@ declare interface GPUOrigin3DDict { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUOrigin3D = number[] | GPUOrigin3DDict; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUExtent3DDict { width: number; @@ -1768,19 +1768,19 @@ declare interface GPUExtent3DDict { /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUExtent3D = number[] | GPUExtent3DDict; /** * @category GPU - * @tags unstable + * @experimental */ declare type GPUCanvasAlphaMode = "opaque" | "premultiplied"; /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUCanvasConfiguration { device: GPUDevice; @@ -1794,7 +1794,7 @@ declare interface GPUCanvasConfiguration { } /** * @category GPU - * @tags unstable + * @experimental */ declare interface GPUCanvasContext { configure(configuration: GPUCanvasConfiguration): undefined; diff --git a/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts b/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts index 035d9e1ce5..ed56de0094 100644 --- a/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts +++ b/ext/broadcast_channel/lib.deno_broadcast_channel.d.ts @@ -7,7 +7,7 @@ /** * @category Messaging - * @tags unstable + * @experimental */ declare interface BroadcastChannelEventMap { "message": MessageEvent; @@ -16,7 +16,7 @@ declare interface BroadcastChannelEventMap { /** * @category Messaging - * @tags unstable + * @experimental */ declare interface BroadcastChannel extends EventTarget { /** @@ -59,7 +59,7 @@ declare interface BroadcastChannel extends EventTarget { /** * @category Messaging - * @tags unstable + * @experimental */ declare var BroadcastChannel: { readonly prototype: BroadcastChannel; diff --git a/tests/integration/lsp_tests.rs b/tests/integration/lsp_tests.rs index 6a92ae00b4..042513456b 100644 --- a/tests/integration/lsp_tests.rs +++ b/tests/integration/lsp_tests.rs @@ -1463,7 +1463,7 @@ fn lsp_hover_asset() { "value": "interface Date", }, "Enables basic storage and retrieval of dates and times.", - "\n\n*@category* - Temporal \n\n*@tags* - unstable" + "\n\n*@category* - Temporal \n\n*@experimental*" ], "range": { "start": { "line": 111, "character": 10, }, @@ -2039,7 +2039,7 @@ fn lsp_hover_unstable_always_enabled() { "value":"interface Deno.ForeignLibraryInterface" }, "**UNSTABLE**: New API, yet to be vetted.\n\nA foreign library interface descriptor.", - "\n\n*@category* - FFI \n\n*@tags* - unstable", + "\n\n*@category* - FFI \n\n*@experimental*", ], "range":{ "start":{ "line":0, "character":14 }, @@ -2084,7 +2084,7 @@ fn lsp_hover_unstable_enabled() { "value":"interface Deno.ForeignLibraryInterface" }, "**UNSTABLE**: New API, yet to be vetted.\n\nA foreign library interface descriptor.", - "\n\n*@category* - FFI \n\n*@tags* - unstable", + "\n\n*@category* - FFI \n\n*@experimental*", ], "range":{ "start":{ "line":0, "character":14 }, diff --git a/tools/jsdoc_checker.js b/tools/jsdoc_checker.js index 733790c4e3..4cbccf5355 100755 --- a/tools/jsdoc_checker.js +++ b/tools/jsdoc_checker.js @@ -70,14 +70,8 @@ for (const file of project.getSourceFiles()) { } if (unstableFiles.includes(file)) { - const tagsTag = tags.find((tag) => tag.getTagName() === "tags"); - if ( - !(tagsTag?.getComment() && - tagsTag.getCommentText().includes("unstable")) - ) { - errors.push( - getErrorPrefix(node) + "JSDoc @tags tag with value 'unstable'", - ); + if (!tags.find((tag) => tag.getTagName() === "experimental")) { + errors.push(getErrorPrefix(node) + "JSDoc @experimental tag"); } } }