foster/denoland-deno
0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-02-08 15:21:26 -05:00
Code Issues Packages 1 Wiki Activity

fix(docs): add missing categories for unstable (#15807)

Browse source
This commit is contained in:
Leo Kettmeir 2022-09-08 01:47:47 +01:00 • committed by GitHub
parent 9e6917426a
commit 4e52319795
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -282,6 +282,7 @@ declare namespace Deno {
*/ */
export function systemMemoryInfo(): SystemMemoryInfo; export function systemMemoryInfo(): SystemMemoryInfo;
/** @category Runtime Environment */
export interface SystemMemoryInfo { export interface SystemMemoryInfo {
/** Total installed memory */ /** Total installed memory */
total: number; total: number;
@ -393,14 +394,19 @@ declare namespace Deno {
| "usize" | "usize"
| "isize"; | "isize";
/** @category FFI */
type NativeBooleanType = "bool"; type NativeBooleanType = "bool";
/** @category FFI */
type NativePointerType = "pointer"; type NativePointerType = "pointer";
/** @category FFI */
type NativeBufferType = "buffer"; type NativeBufferType = "buffer";
/** @category FFI */
type NativeFunctionType = "function"; type NativeFunctionType = "function";
/** @category FFI */
type NativeVoidType = "void"; type NativeVoidType = "void";
/** All possible types for interfacing with foreign functions. /** All possible types for interfacing with foreign functions.
@ -676,6 +682,7 @@ declare namespace Deno {
call: FromForeignFunction<Fn>; call: FromForeignFunction<Fn>;
} }
/** @category FFI */
export interface UnsafeCallbackDefinition< export interface UnsafeCallbackDefinition<
Parameters extends readonly NativeType[] = readonly NativeType[], Parameters extends readonly NativeType[] = readonly NativeType[],
Result extends NativeResultType = NativeResultType, Result extends NativeResultType = NativeResultType,
@ -684,6 +691,7 @@ declare namespace Deno {
result: Result; result: Result;
} }
/** @category FFI */
type UnsafeCallbackFunction< type UnsafeCallbackFunction<
Parameters extends readonly NativeType[] = readonly NativeType[], Parameters extends readonly NativeType[] = readonly NativeType[],
Result extends NativeResultType = NativeResultType, Result extends NativeResultType = NativeResultType,
@ -749,7 +757,11 @@ declare namespace Deno {
close(): void; close(): void;
} }
/** A dynamic library resource */ /**
* A dynamic library resource
*
* @category FFI
*/
export interface DynamicLibrary<S extends ForeignLibraryInterface> { export interface DynamicLibrary<S extends ForeignLibraryInterface> {
/** All of the registered library along with functions for calling them */ /** All of the registered library along with functions for calling them */
symbols: StaticForeignLibraryInterface<S>; symbols: StaticForeignLibraryInterface<S>;
@ -1065,6 +1077,7 @@ declare namespace Deno {
options: UnixListenOptions & { transport: "unixpacket" }, options: UnixListenOptions & { transport: "unixpacket" },
): DatagramConn; ): DatagramConn;
/** @category Network */
export interface UnixConnectOptions { export interface UnixConnectOptions {
transport: "unix"; transport: "unix";
path: string; path: string;
@ -1096,6 +1109,7 @@ declare namespace Deno {
options: UnixConnectOptions, options: UnixConnectOptions,
): Promise<UnixConn>; ): Promise<UnixConn>;
/** @category Network */
export interface ConnectTlsOptions { export interface ConnectTlsOptions {
/** PEM formatted client certificate chain. */ /** PEM formatted client certificate chain. */
certChain?: string; certChain?: string;
@ -1542,12 +1556,14 @@ declare namespace Deno {
options?: SpawnOptions, options?: SpawnOptions,
): SpawnOutput; ): SpawnOutput;
/** @category Sub Process */
export interface ChildStatus { export interface ChildStatus {
success: boolean; success: boolean;
code: number; code: number;
signal: Signal | null; signal: Signal | null;
} }
/** @category Sub Process */
export interface SpawnOutput extends ChildStatus { export interface SpawnOutput extends ChildStatus {
get stdout(): Uint8Array; get stdout(): Uint8Array;
get stderr(): Uint8Array; get stderr(): Uint8Array;