diff options
| -rw-r--r-- | cli/dts/lib.deno.unstable.d.ts | 449 |
1 files changed, 314 insertions, 135 deletions
diff --git a/cli/dts/lib.deno.unstable.d.ts b/cli/dts/lib.deno.unstable.d.ts index 974ea3cb2..49e02d375 100644 --- a/cli/dts/lib.deno.unstable.d.ts +++ b/cli/dts/lib.deno.unstable.d.ts @@ -6,7 +6,10 @@ declare namespace Deno { export {}; // stop default export type behavior - /** @category Testing */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Testing + */ export interface BenchDefinition { fn: () => void | Promise<void>; name: string; @@ -33,7 +36,9 @@ declare namespace Deno { permissions?: Deno.PermissionOptions; } - /** Register a bench which will be run when `deno bench` is used on the command + /** **UNSTABLE**: New API, yet to be vetted. + * + * Register a bench which will be run when `deno bench` is used on the command * line and the containing module looks like a bench module. * `fn` can be async if required. * ```ts @@ -68,7 +73,9 @@ declare namespace Deno { */ export function bench(t: BenchDefinition): void; - /** Register a bench which will be run when `deno bench` is used on the command + /** **UNSTABLE**: New API, yet to be vetted. + * + * Register a bench which will be run when `deno bench` is used on the command * line and the containing module looks like a bench module. * `fn` can be async if required. * @@ -93,7 +100,9 @@ declare namespace Deno { fn: () => void | Promise<void>, ): void; - /** Register a bench which will be run when `deno bench` is used on the command + /** **UNSTABLE**: New API, yet to be vetted. + * + * Register a bench which will be run when `deno bench` is used on the command * line and the containing module looks like a bench module. * `fn` can be async if required. Declared function must have a name. * @@ -115,7 +124,9 @@ declare namespace Deno { */ export function bench(fn: () => void | Promise<void>): void; - /** Register a bench which will be run when `deno bench` is used on the command + /** **UNSTABLE**: New API, yet to be vetted. + * + * Register a bench which will be run when `deno bench` is used on the command * line and the containing module looks like a bench module. * `fn` can be async if required. * @@ -141,7 +152,9 @@ declare namespace Deno { fn: () => void | Promise<void>, ): void; - /** Register a bench which will be run when `deno bench` is used on the command + /** **UNSTABLE**: New API, yet to be vetted. + * + * Register a bench which will be run when `deno bench` is used on the command * line and the containing module looks like a bench module. * `fn` can be async if required. * @@ -166,7 +179,9 @@ declare namespace Deno { fn: () => void | Promise<void>, ): void; - /** Register a bench which will be run when `deno bench` is used on the command + /** **UNSTABLE**: New API, yet to be vetted. + * + * Register a bench which will be run when `deno bench` is used on the command * line and the containing module looks like a bench module. * `fn` can be async if required. Declared function must have a name. * @@ -191,9 +206,7 @@ declare namespace Deno { fn: () => void | Promise<void>, ): void; - /** - * **UNSTABLE**: New API, yet to be vetted. This API is under consideration to - * determine if permissions are required to call it. + /** **UNSTABLE**: New API, yet to be vetted. * * Retrieve the process umask. If `mask` is provided, sets the process umask. * This call always returns what the umask was before the call. @@ -204,6 +217,9 @@ declare namespace Deno { * console.log(Deno.umask()); // e.g. 63 (0o077) * ``` * + * This API is under consideration to determine if permissions are required to + * call it. + * * NOTE: This API is not implemented on Windows * * @category File System @@ -227,8 +243,7 @@ declare namespace Deno { rows: number; }; - /** **Unstable** There are questions around which permission this needs. And - * maybe should be renamed (loadAverage?) + /** **UNSTABLE**: New API, yet to be vetted. * * Returns an array containing the 1, 5, and 15 minute load averages. The * load average is a measure of CPU and IO utilization of the last one, five, @@ -241,15 +256,15 @@ declare namespace Deno { * ``` * * Requires `allow-env` permission. + * There are questions around which permission this needs. And maybe should be + * renamed (loadAverage?). * * @tags allow-env * @category Observability */ export function loadavg(): number[]; - /** **Unstable** new API. yet to be vetted. Under consideration to possibly move to - * Deno.build or Deno.versions and if it should depend sys-info, which may not - * be desireable. + /** **UNSTABLE**: New API, yet to be vetted. * * Returns the release version of the Operating System. * @@ -258,13 +273,15 @@ declare namespace Deno { * ``` * * Requires `allow-env` permission. + * Under consideration to possibly move to Deno.build or Deno.versions and if + * it should depend sys-info, which may not be desirable. * * @tags allow-env * @category Runtime Environment */ export function osRelease(): string; - /** **Unstable** new API. yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Displays the total amount of free and used physical and swap memory in the * system, as well as the buffers and caches used by the kernel. @@ -282,7 +299,10 @@ declare namespace Deno { */ export function systemMemoryInfo(): SystemMemoryInfo; - /** @category Runtime Environment */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Runtime Environment + */ export interface SystemMemoryInfo { /** Total installed memory */ total: number; @@ -296,7 +316,7 @@ declare namespace Deno { available: number; /** Memory used by kernel buffers */ buffers: number; - /** Memory used by the page cache and slabs */ + /** Memory used by the page cache and slabs */ cached: number; /** Total swap memory */ swapTotal: number; @@ -304,7 +324,9 @@ declare namespace Deno { swapFree: number; } - /** The information of the network interface. + /** **UNSTABLE**: New API, yet to be vetted. + * + * The information of the network interface. * * @category Network */ @@ -325,9 +347,9 @@ declare namespace Deno { mac: string; } - /** **Unstable** new API. yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * - * Returns an array of the network interface informations. + * Returns an array of the network interface information. * * ```ts * console.log(Deno.networkInterfaces()); @@ -340,9 +362,9 @@ declare namespace Deno { */ export function networkInterfaces(): NetworkInterfaceInfo[]; - /** **Unstable** new API. yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * - * Returns the user id of the process on POSIX platforms. Returns null on windows. + * Returns the user id of the process on POSIX platforms. Returns null on Windows. * * ```ts * console.log(Deno.getUid()); @@ -355,7 +377,7 @@ declare namespace Deno { */ export function getUid(): number | null; - /** **Unstable** new API. yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Returns the group id of the process on POSIX platforms. Returns null on windows. * @@ -370,7 +392,9 @@ declare namespace Deno { */ export function getGid(): number | null; - /** All plain number types for interfacing with foreign functions. + /** **UNSTABLE**: New API, yet to be vetted. + * + * All plain number types for interfacing with foreign functions. * * @category FFI */ @@ -384,7 +408,9 @@ declare namespace Deno { | "f32" | "f64"; - /** All BigInt number types for interfacing with foreign functions. + /** **UNSTABLE**: New API, yet to be vetted. + * + * All BigInt number types for interfacing with foreign functions. * * @category FFI */ @@ -394,22 +420,39 @@ declare namespace Deno { | "usize" | "isize"; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type NativeBooleanType = "bool"; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type NativePointerType = "pointer"; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type NativeBufferType = "buffer"; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type NativeFunctionType = "function"; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type NativeVoidType = "void"; - /** All possible types for interfacing with foreign functions. + /** **UNSTABLE**: New API, yet to be vetted. + * + * All possible types for interfacing with foreign functions. * * @category FFI */ @@ -421,10 +464,16 @@ declare namespace Deno { | NativeBufferType | NativeFunctionType; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ export type NativeResultType = NativeType | NativeVoidType; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type ToNativeTypeMap = & Record<NativeNumberType, number> & Record<NativeBigIntType, PointerValue> @@ -433,24 +482,34 @@ declare namespace Deno { & Record<NativeFunctionType, PointerValue | null> & Record<NativeBufferType, TypedArray | null>; - /** Type conversion for foreign symbol parameters and unsafe callback return + /** **UNSTABLE**: New API, yet to be vetted. + * + * Type conversion for foreign symbol parameters and unsafe callback return * types. * * @category FFI */ type ToNativeType<T extends NativeType = NativeType> = ToNativeTypeMap[T]; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type ToNativeResultTypeMap = ToNativeTypeMap & Record<NativeVoidType, void>; - /** Type conversion for unsafe callback return types. + /** **UNSTABLE**: New API, yet to be vetted. + * + * Type conversion for unsafe callback return types. * * @category FFI */ type ToNativeResultType<T extends NativeResultType = NativeResultType> = ToNativeResultTypeMap[T]; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type ToNativeParameterTypes<T extends readonly NativeType[]> = // [(T[number])[]] extends [T] ? ToNativeType<T[number]>[] @@ -461,7 +520,10 @@ declare namespace Deno { } : never; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type FromNativeTypeMap = & Record<NativeNumberType, number> & Record<NativeBigIntType, PointerValue> @@ -470,26 +532,36 @@ declare namespace Deno { & Record<NativeBufferType, PointerValue> & Record<NativeFunctionType, PointerValue>; - /** Type conversion for foreign symbol return types and unsafe callback + /** **UNSTABLE**: New API, yet to be vetted. + * + * Type conversion for foreign symbol return types and unsafe callback * parameters. * * @category FFI */ type FromNativeType<T extends NativeType = NativeType> = FromNativeTypeMap[T]; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type FromNativeResultTypeMap = & FromNativeTypeMap & Record<NativeVoidType, void>; - /** Type conversion for foreign symbol return types. + /** **UNSTABLE**: New API, yet to be vetted. + * + * Type conversion for foreign symbol return types. * * @category FFI */ type FromNativeResultType<T extends NativeResultType = NativeResultType> = FromNativeResultTypeMap[T]; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type FromNativeParameterTypes< T extends readonly NativeType[], > = @@ -502,7 +574,9 @@ declare namespace Deno { } : never; - /** A foreign function as defined by its parameter and result types. + /** **UNSTABLE**: New API, yet to be vetted. + * + * A foreign function as defined by its parameter and result types. * * @category FFI */ @@ -521,14 +595,19 @@ declare namespace Deno { callback?: boolean; } - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ export interface ForeignStatic<Type extends NativeType = NativeType> { /** Name of the symbol, defaults to the key name in symbols object. */ name?: string; type: Type; } - /** A foreign library interface descriptor. + /** **UNSTABLE**: New API, yet to be vetted. + * + * A foreign library interface descriptor. * * @category FFI */ @@ -536,7 +615,9 @@ declare namespace Deno { [name: string]: ForeignFunction | ForeignStatic; } - /** Infers a foreign symbol. + /** **UNSTABLE**: New API, yet to be vetted. + * + * Infers a foreign symbol. * * @category FFI */ @@ -545,22 +626,33 @@ declare namespace Deno { : T extends ForeignStatic ? FromNativeType<T["type"]> : never; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type FromForeignFunction<T extends ForeignFunction> = T["parameters"] extends readonly [] ? () => StaticForeignSymbolReturnType<T> : ( ...args: ToNativeParameterTypes<T["parameters"]> ) => StaticForeignSymbolReturnType<T>; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type StaticForeignSymbolReturnType<T extends ForeignFunction> = ConditionalAsync<T["nonblocking"], FromNativeResultType<T["result"]>>; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type ConditionalAsync<IsAsync extends boolean | undefined, T> = IsAsync extends true ? Promise<T> : T; - /** Infers a foreign library interface. + /** **UNSTABLE**: New API, yet to be vetted. + * + * Infers a foreign library interface. * * @category FFI */ @@ -568,7 +660,10 @@ declare namespace Deno { [K in keyof T]: StaticForeignSymbol<T[K]>; }; - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type TypedArray = | Int8Array | Uint8Array @@ -582,7 +677,8 @@ declare namespace Deno { | BigInt64Array | BigUint64Array; - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * Pointer type depends on the architecture and actual pointer value. * * On a 32 bit system all pointer values are plain numbers. On a 64 bit @@ -593,7 +689,7 @@ declare namespace Deno { */ export type PointerValue = number | bigint; - /** **UNSTABLE**: Unsafe and new API, beware! + /** **UNSTABLE**: New API, yet to be vetted. * * An unsafe pointer to a memory location for passing and returning pointers * to and from the FFI. @@ -607,7 +703,7 @@ declare namespace Deno { static of(value: Deno.UnsafeCallback | TypedArray): PointerValue; } - /** **UNSTABLE**: Unsafe and new API, beware! + /** **UNSTABLE**: New API, yet to be vetted. * * An unsafe pointer view to a memory location as specified by the `pointer` * value. The `UnsafePointerView` API mimics the standard built in interface @@ -665,8 +761,7 @@ declare namespace Deno { ): void; } - /** - * **UNSTABLE**: Unsafe and new API, beware! + /** **UNSTABLE**: New API, yet to be vetted. * * An unsafe pointer to a function, for calling functions that are not * present as symbols. @@ -682,7 +777,10 @@ declare namespace Deno { call: FromForeignFunction<Fn>; } - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ export interface UnsafeCallbackDefinition< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, @@ -691,7 +789,10 @@ declare namespace Deno { result: Result; } - /** @category FFI */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category FFI + */ type UnsafeCallbackFunction< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, @@ -699,8 +800,7 @@ declare namespace Deno { ...args: FromNativeParameterTypes<Parameters> ) => ToNativeResultType<Result>; - /** - * **UNSTABLE**: Unsafe and new API, beware! + /** **UNSTABLE**: New API, yet to be vetted. * * An unsafe function pointer for passing JavaScript functions * as C function pointers to ffi calls. @@ -757,7 +857,8 @@ declare namespace Deno { close(): void; } - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * A dynamic library resource * * @category FFI @@ -768,7 +869,7 @@ declare namespace Deno { close(): void; } - /** **UNSTABLE**: Unsafe and new API, beware! + /** **UNSTABLE**: New API, yet to be vetted. * * Opens a dynamic library and registers symbols * @@ -779,12 +880,15 @@ declare namespace Deno { symbols: S, ): DynamicLibrary<S>; - /** @category I/O */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category I/O + */ export type SetRawOptions = { cbreak: boolean; }; - /** **UNSTABLE**: new API, yet to be vetted + /** **UNSTABLE**: New API, yet to be vetted. * * Set TTY to be under raw mode or not. In raw mode, characters are read and * returned as is, without being processed. All special processing of @@ -808,7 +912,7 @@ declare namespace Deno { options?: SetRawOptions, ): void; - /** **UNSTABLE**: needs investigation into high precision time. + /** **UNSTABLE**: New API, yet to be vetted. * * Synchronously changes the access (`atime`) and modification (`mtime`) times * of a file system object referenced by `path`. Given times are either in @@ -819,6 +923,7 @@ declare namespace Deno { * ``` * * Requires `allow-write` permission. + * Needs investigation into high precision time. * * @tags allow-write * @category File System @@ -829,7 +934,7 @@ declare namespace Deno { mtime: number | Date, ): void; - /** **UNSTABLE**: needs investigation into high precision time. + /** **UNSTABLE**: New API, yet to be vetted. * * Changes the access (`atime`) and modification (`mtime`) times of a file * system object referenced by `path`. Given times are either in seconds @@ -840,6 +945,7 @@ declare namespace Deno { * ``` * * Requires `allow-write` permission. + * Needs investigation into high precision time. * * @tags allow-write * @category File System @@ -850,7 +956,10 @@ declare namespace Deno { mtime: number | Date, ): Promise<void>; - /** @category Sub Process */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Sub Process + */ export function run< T extends RunOptions & { clearEnv?: boolean; @@ -863,8 +972,7 @@ declare namespace Deno { }, >(opt: T): Process<T>; - /** **UNSTABLE**: New API, yet to be vetted. Additional consideration is still - * necessary around the permissions required. + /** **UNSTABLE**: New API, yet to be vetted. * * Get the `hostname` of the machine the Deno process is running on. * @@ -872,7 +980,9 @@ declare namespace Deno { * console.log(Deno.hostname()); * ``` * - * Requires `allow-env` permission. + * Requires `allow-env` permission. + * Additional consideration is still necessary around the permissions + * required. * * @tags allow-env * @category Runtime Environment @@ -880,6 +990,7 @@ declare namespace Deno { export function hostname(): string; /** **UNSTABLE**: New API, yet to be vetted. + * * A custom HttpClient for use with `fetch`. * * ```ts @@ -896,6 +1007,7 @@ declare namespace Deno { } /** **UNSTABLE**: New API, yet to be vetted. + * * The options used when creating a [HttpClient]. * * @category Fetch API @@ -914,19 +1026,26 @@ declare namespace Deno { privateKey?: string; } - /** @category Fetch API */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Fetch API + */ export interface Proxy { url: string; basicAuth?: BasicAuth; } - /** @category Fetch API */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Fetch API + */ export interface BasicAuth { username: string; password: string; } /** **UNSTABLE**: New API, yet to be vetted. + * * Create a custom HttpClient for to use with `fetch`. * * ```ts @@ -946,7 +1065,7 @@ declare namespace Deno { options: CreateHttpClientOptions, ): HttpClient; - /** **UNSTABLE**: needs investigation into high precision time. + /** **UNSTABLE**: New API, yet to be vetted. * * Synchronously changes the access (`atime`) and modification (`mtime`) times * of a file stream resource referenced by `rid`. Given times are either in @@ -957,6 +1076,8 @@ declare namespace Deno { * Deno.futimeSync(file.rid, 1556495550, new Date()); * ``` * + * Needs investigation into high precision time. + * * @category File System */ export function futimeSync( @@ -965,7 +1086,7 @@ declare namespace Deno { mtime: number | Date, ): void; - /** **UNSTABLE**: needs investigation into high precision time. + /** **UNSTABLE**: New API, yet to be vetted. * * Changes the access (`atime`) and modification (`mtime`) times of a file * stream resource referenced by `rid`. Given times are either in seconds @@ -976,6 +1097,8 @@ declare namespace Deno { * await Deno.futime(file.rid, 1556495550, new Date()); * ``` * + * Needs investigation into high precision time. + * * @category File System */ export function futime( @@ -984,24 +1107,18 @@ declare namespace Deno { mtime: number | Date, ): Promise<void>; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * A generic transport listener for message-oriented protocols. * * @category Network */ export interface DatagramConn extends AsyncIterable<[Uint8Array, Addr]> { - /** **UNSTABLE**: new API, yet to be vetted. - * - * Waits for and resolves to the next message to the `UDPConn`. */ + /** Waits for and resolves to the next message to the `UDPConn`. */ receive(p?: Uint8Array): Promise<[Uint8Array, Addr]>; - /** UNSTABLE: new API, yet to be vetted. - * - * Sends a message to the target. */ + /** Sends a message to the target. */ send(p: Uint8Array, addr: Addr): Promise<number>; - /** UNSTABLE: new API, yet to be vetted. - * - * Close closes the socket. Any pending message promises will be rejected + /** Close closes the socket. Any pending message promises will be rejected * with errors. */ close(): void; /** Return the address of the `UDPConn`. */ @@ -1009,13 +1126,16 @@ declare namespace Deno { [Symbol.asyncIterator](): AsyncIterableIterator<[Uint8Array, Addr]>; } - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface UnixListenOptions { /** A Path to the Unix Socket. */ path: string; } - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Listen announces on the local transport address. * @@ -1032,7 +1152,7 @@ declare namespace Deno { options: UnixListenOptions & { transport: "unix" }, ): Listener; - /** **UNSTABLE**: new API, yet to be vetted + /** **UNSTABLE**: New API, yet to be vetted. * * Listen announces on the local transport address. * @@ -1057,7 +1177,7 @@ declare namespace Deno { options: ListenOptions & { transport: "udp" }, ): DatagramConn; - /** **UNSTABLE**: new API, yet to be vetted + /** **UNSTABLE**: New API, yet to be vetted. * * Listen announces on the local transport address. * @@ -1077,14 +1197,16 @@ declare namespace Deno { options: UnixListenOptions & { transport: "unixpacket" }, ): DatagramConn; - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface UnixConnectOptions { transport: "unix"; path: string; } - /** **UNSTABLE**: The unix socket transport is unstable as a new API yet to - * be vetted. The TCP transport is considered stable. + /** **UNSTABLE**: New API, yet to be vetted. * * Connects to the hostname (default is "127.0.0.1") and port on the named * transport (default is "tcp"), and resolves to the connection (`Conn`). @@ -1109,13 +1231,22 @@ declare namespace Deno { options: UnixConnectOptions, ): Promise<UnixConn>; - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface ConnectTlsOptions { - /** PEM formatted client certificate chain. */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * PEM formatted client certificate chain. + */ certChain?: string; - /** PEM formatted (RSA or PKCS8) private key of client certificate. */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * PEM formatted (RSA or PKCS8) private key of client certificate. + */ privateKey?: string; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Application-Layer Protocol Negotiation (ALPN) protocols supported by * the client. If not specified, no ALPN extension will be included in the @@ -1124,9 +1255,12 @@ declare namespace Deno { alpnProtocols?: string[]; } - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface TlsHandshakeInfo { - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Contains the ALPN protocol selected during negotiation with the server. * If no ALPN protocol selected, returns `null`. @@ -1134,15 +1268,21 @@ declare namespace Deno { alpnProtocol: string | null; } - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface TlsConn extends Conn { - /** Runs the client or server handshake protocol to completion if that has + /** **UNSTABLE**: New API, yet to be vetted. + * + * Runs the client or server handshake protocol to completion if that has * not happened yet. Calling this method is optional; the TLS handshake - * will be completed automatically as soon as data is sent or received. */ + * will be completed automatically as soon as data is sent or received. + */ handshake(): Promise<TlsHandshakeInfo>; } - /** **UNSTABLE** New API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Create a TLS connection with an attached client certificate. * @@ -1162,9 +1302,12 @@ declare namespace Deno { */ export function connectTls(options: ConnectTlsOptions): Promise<TlsConn>; - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface ListenTlsOptions { - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Application-Layer Protocol Negotiation (ALPN) protocols to announce to * the client. If not specified, no ALPN extension will be included in the @@ -1173,9 +1316,12 @@ declare namespace Deno { alpnProtocols?: string[]; } - /** @category Network */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Network + */ export interface StartTlsOptions { - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Application-Layer Protocol Negotiation (ALPN) protocols to announce to * the client. If not specified, no ALPN extension will be included in the @@ -1186,7 +1332,7 @@ declare namespace Deno { /** @category Network */ export interface Listener extends AsyncIterable<Conn> { - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Make the listener block the event loop from finishing. * @@ -1194,14 +1340,14 @@ declare namespace Deno { * This method is only meaningful after `.unref()` is called. */ ref(): void; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Make the listener not block the event loop from finishing. */ unref(): void; } - /** **UNSTABLE**: New API should be tested first. + /** **UNSTABLE**: New API, yet to be vetted. * * Acquire an advisory file-system lock for the provided file. `exclusive` * defaults to `false`. @@ -1210,7 +1356,7 @@ declare namespace Deno { */ export function flock(rid: number, exclusive?: boolean): Promise<void>; - /** **UNSTABLE**: New API should be tested first. + /** **UNSTABLE**: New API, yet to be vetted. * * Acquire an advisory file-system lock for the provided file. `exclusive` * defaults to `false`. @@ -1219,7 +1365,7 @@ declare namespace Deno { */ export function flockSync(rid: number, exclusive?: boolean): void; - /** **UNSTABLE**: New API should be tested first. + /** **UNSTABLE**: New API, yet to be vetted. * * Release an advisory file-system lock for the provided file. * @@ -1227,7 +1373,7 @@ declare namespace Deno { */ export function funlock(rid: number): Promise<void>; - /** **UNSTABLE**: New API should be tested first. + /** **UNSTABLE**: New API, yet to be vetted. * * Release an advisory file-system lock for the provided file. * @@ -1235,7 +1381,7 @@ declare namespace Deno { */ export function funlockSync(rid: number): void; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Make the timer of the given id blocking the event loop from finishing. * @@ -1243,7 +1389,7 @@ declare namespace Deno { */ export function refTimer(id: number): void; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Make the timer of the given id not blocking the event loop from finishing. * @@ -1251,7 +1397,8 @@ declare namespace Deno { */ export function unrefTimer(id: number): void; - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * A handler for HTTP requests. Consumes a request and returns a response. * * If a handler throws, the server calling the handler will assume the impact @@ -1262,7 +1409,8 @@ declare namespace Deno { */ export type ServeHandler = (request: Request) => Response | Promise<Response>; - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * @category HTTP Server */ export interface ServeOptions extends Partial<Deno.ListenOptions> { @@ -1276,7 +1424,8 @@ declare namespace Deno { onListen?: (params: { hostname: string; port: number }) => void; } - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * @category HTTP Server */ export interface ServeTlsOptions extends ServeOptions { @@ -1287,7 +1436,8 @@ declare namespace Deno { key: string; } - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * @category HTTP Server */ export interface ServeInit { @@ -1295,7 +1445,7 @@ declare namespace Deno { handler: ServeHandler; } - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Serves HTTP requests with the given handler. * @@ -1366,7 +1516,7 @@ declare namespace Deno { options: ServeInit & (ServeOptions | ServeTlsOptions), ): Promise<void>; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Allows "hijacking" the connection that the request is associated with. * This can be used to implement protocols that build on top of HTTP (eg. @@ -1394,7 +1544,7 @@ declare namespace Deno { request: Request, ): Promise<[Deno.Conn, Uint8Array]>; - /** **UNSTABLE**: new API, yet to be vetted. + /** **UNSTABLE**: New API, yet to be vetted. * * Allows "hijacking" the connection that the request is associated with. * This can be used to implement protocols that build on top of HTTP (eg. @@ -1412,7 +1562,10 @@ declare namespace Deno { */ export function upgradeHttpRaw(request: Request): [Deno.Conn, Uint8Array]; - /** @category Sub Process */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Sub Process + */ export interface SpawnOptions { /** Arguments to pass to the process. */ args?: string[]; @@ -1451,7 +1604,8 @@ declare namespace Deno { stderr?: "piped" | "inherit" | "null"; } - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * Spawns a child process. * * If any stdio options are not set to `"piped"`, accessing the corresponding @@ -1484,7 +1638,10 @@ declare namespace Deno { options?: SpawnOptions, ): Child; - /** @category Sub Process */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Sub Process + */ export class Child { get stdin(): WritableStream<Uint8Array>; get stdout(): ReadableStream<Uint8Array>; @@ -1502,7 +1659,8 @@ declare namespace Deno { unref(): void; } - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * Executes a subprocess, waiting for it to finish and * collecting all of its output. * Will throw an error if `stdin: "piped"` is passed. @@ -1529,7 +1687,8 @@ declare namespace Deno { options?: SpawnOptions, ): Promise<SpawnOutput>; - /** + /** **UNSTABLE**: New API, yet to be vetted. + * * Synchronously executes a subprocess, waiting for it to finish and * collecting all of its output. * Will throw an error if `stdin: "piped"` is passed. @@ -1556,21 +1715,28 @@ declare namespace Deno { options?: SpawnOptions, ): SpawnOutput; - /** @category Sub Process */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Sub Process + */ export interface ChildStatus { success: boolean; code: number; signal: Signal | null; } - /** @category Sub Process */ + /** **UNSTABLE**: New API, yet to be vetted. + * + * @category Sub Process + */ export interface SpawnOutput extends ChildStatus { get stdout(): Uint8Array; get stderr(): Uint8Array; } } -/** +/** **UNSTABLE**: New API, yet to be vetted. + * * @tags allow-net, allow-read * @category Fetch API */ @@ -1579,9 +1745,12 @@ declare function fetch( init?: RequestInit & { client: Deno.HttpClient }, ): Promise<Response>; -/** @category Web Workers */ +/** **UNSTABLE**: New API, yet to be vetted. + * + * @category Web Workers + */ declare interface WorkerOptions { - /** UNSTABLE: New API. + /** **UNSTABLE**: New API, yet to be vetted. * * Configure permissions options to change the level of access the worker will * have. By default it will have no permissions. Note that the permissions @@ -1613,14 +1782,20 @@ declare interface WorkerOptions { }; } -/** @category Web Sockets */ +/** **UNSTABLE**: New API, yet to be vetted. + * + * @category Web Sockets + */ declare interface WebSocketStreamOptions { protocols?: string[]; signal?: AbortSignal; headers?: HeadersInit; } -/** @category Web Sockets */ +/** **UNSTABLE**: New API, yet to be vetted. + * + * @category Web Sockets + */ declare interface WebSocketConnection { readable: ReadableStream<string | Uint8Array>; writable: WritableStream<string | Uint8Array>; @@ -1628,13 +1803,17 @@ declare interface WebSocketConnection { protocol: string; } -/** @category Web Sockets */ +/** **UNSTABLE**: New API, yet to be vetted. + * + * @category Web Sockets + */ declare interface WebSocketCloseInfo { code?: number; reason?: string; } -/** +/** **UNSTABLE**: New API, yet to be vetted. + * * @tags allow-net * @category Web Sockets */ |