From 4e5231979523a65e09122b8ea79beeeaae0e7e3d Mon Sep 17 00:00:00 2001 From: Leo Kettmeir Date: Thu, 8 Sep 2022 01:47:47 +0100 Subject: [PATCH] fix(docs): add missing categories for unstable (#15807) --- cli/dts/lib.deno.unstable.d.ts | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/cli/dts/lib.deno.unstable.d.ts b/cli/dts/lib.deno.unstable.d.ts index ae306d8195..e7074c1308 100644 --- a/cli/dts/lib.deno.unstable.d.ts +++ b/cli/dts/lib.deno.unstable.d.ts @@ -282,6 +282,7 @@ declare namespace Deno { */ export function systemMemoryInfo(): SystemMemoryInfo; + /** @category Runtime Environment */ export interface SystemMemoryInfo { /** Total installed memory */ total: number; @@ -393,14 +394,19 @@ declare namespace Deno { | "usize" | "isize"; + /** @category FFI */ type NativeBooleanType = "bool"; + /** @category FFI */ type NativePointerType = "pointer"; + /** @category FFI */ type NativeBufferType = "buffer"; + /** @category FFI */ type NativeFunctionType = "function"; + /** @category FFI */ type NativeVoidType = "void"; /** All possible types for interfacing with foreign functions. @@ -676,6 +682,7 @@ declare namespace Deno { call: FromForeignFunction; } + /** @category FFI */ export interface UnsafeCallbackDefinition< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, @@ -684,6 +691,7 @@ declare namespace Deno { result: Result; } + /** @category FFI */ type UnsafeCallbackFunction< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, @@ -749,7 +757,11 @@ declare namespace Deno { close(): void; } - /** A dynamic library resource */ + /** + * A dynamic library resource + * + * @category FFI + */ export interface DynamicLibrary { /** All of the registered library along with functions for calling them */ symbols: StaticForeignLibraryInterface; @@ -1065,6 +1077,7 @@ declare namespace Deno { options: UnixListenOptions & { transport: "unixpacket" }, ): DatagramConn; + /** @category Network */ export interface UnixConnectOptions { transport: "unix"; path: string; @@ -1096,6 +1109,7 @@ declare namespace Deno { options: UnixConnectOptions, ): Promise; + /** @category Network */ export interface ConnectTlsOptions { /** PEM formatted client certificate chain. */ certChain?: string; @@ -1542,12 +1556,14 @@ declare namespace Deno { options?: SpawnOptions, ): SpawnOutput; + /** @category Sub Process */ export interface ChildStatus { success: boolean; code: number; signal: Signal | null; } + /** @category Sub Process */ export interface SpawnOutput extends ChildStatus { get stdout(): Uint8Array; get stderr(): Uint8Array;