summaryrefslogtreecommitdiff
path: root/ext/net/lib.deno_net.d.ts
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2022-08-17 13:12:24 +1000
committerGitHub <noreply@github.com>2022-08-17 13:12:24 +1000
commita2ab5eee015b1dafc1a18cd2bc5f5c5756123d74 (patch)
tree1efd7d79208fee44cc05c71c18c7d9e6759ed8c3 /ext/net/lib.deno_net.d.ts
parent868c7e38bfc9a09b5cfeae30ea5a2345a6d700d7 (diff)
docs: add category tag for built-in APIs (#15480)
Diffstat (limited to 'ext/net/lib.deno_net.d.ts')
-rw-r--r--ext/net/lib.deno_net.d.ts44
1 files changed, 39 insertions, 5 deletions
diff --git a/ext/net/lib.deno_net.d.ts b/ext/net/lib.deno_net.d.ts
index bb031f60d..25eb893d1 100644
--- a/ext/net/lib.deno_net.d.ts
+++ b/ext/net/lib.deno_net.d.ts
@@ -4,20 +4,26 @@
/// <reference lib="esnext" />
declare namespace Deno {
+ /** @category Network */
export interface NetAddr {
transport: "tcp" | "udp";
hostname: string;
port: number;
}
+ /** @category Network */
export interface UnixAddr {
transport: "unix" | "unixpacket";
path: string;
}
+ /** @category Network */
export type Addr = NetAddr | UnixAddr;
- /** A generic network listener for stream-oriented protocols. */
+ /** A generic network listener for stream-oriented protocols.
+ *
+ * @category Network
+ */
export interface Listener extends AsyncIterable<Conn> {
/** Waits for and resolves to the next connection to the `Listener`. */
accept(): Promise<Conn>;
@@ -33,13 +39,17 @@ declare namespace Deno {
[Symbol.asyncIterator](): AsyncIterableIterator<Conn>;
}
- /** Specialized listener that accepts TLS connections. */
+ /** Specialized listener that accepts TLS connections.
+ *
+ * @category Network
+ */
export interface TlsListener extends Listener, AsyncIterable<TlsConn> {
/** Waits for a TLS client to connect and accepts the connection. */
accept(): Promise<TlsConn>;
[Symbol.asyncIterator](): AsyncIterableIterator<TlsConn>;
}
+ /** @category Network */
export interface Conn extends Reader, Writer, Closer {
/** The local address of the connection. */
readonly localAddr: Addr;
@@ -55,9 +65,11 @@ declare namespace Deno {
readonly writable: WritableStream<Uint8Array>;
}
+ /** @category Network */
// deno-lint-ignore no-empty-interface
export interface TlsHandshakeInfo {}
+ /** @category Network */
export interface TlsConn extends Conn {
/** Runs the client or server handshake protocol to completion if that has
* not happened yet. Calling this method is optional; the TLS handshake
@@ -65,6 +77,7 @@ declare namespace Deno {
handshake(): Promise<TlsHandshakeInfo>;
}
+ /** @category Network */
export interface ListenOptions {
/** The port to listen on. */
port: number;
@@ -87,11 +100,15 @@ declare namespace Deno {
* const listener4 = Deno.listen({ hostname: "golang.org", port: 80, transport: "tcp" });
* ```
*
- * Requires `allow-net` permission. */
+ * Requires `allow-net` permission.
+ *
+ * @category Network
+ */
export function listen(
options: ListenOptions & { transport?: "tcp" },
): Listener;
+ /** @category Network */
export interface ListenTlsOptions extends ListenOptions {
/** Server private key in PEM format */
key?: string;
@@ -119,9 +136,13 @@ declare namespace Deno {
* const lstnr = Deno.listenTls({ port: 443, certFile: "./server.crt", keyFile: "./server.key" });
* ```
*
- * Requires `allow-net` permission. */
+ * Requires `allow-net` permission.
+ *
+ * @category Network
+ */
export function listenTls(options: ListenTlsOptions): TlsListener;
+ /** @category Network */
export interface ConnectOptions {
/** The port to connect to. */
port: number;
@@ -142,9 +163,13 @@ declare namespace Deno {
* const conn4 = await Deno.connect({ hostname: "golang.org", port: 80, transport: "tcp" });
* ```
*
- * Requires `allow-net` permission for "tcp". */
+ * Requires `allow-net` permission for "tcp".
+ *
+ * @category Network
+ */
export function connect(options: ConnectOptions): Promise<TcpConn>;
+ /** @category Network */
export interface TcpConn extends Conn {
/**
* **UNSTABLE**: new API, see https://github.com/denoland/deno/issues/13617.
@@ -160,9 +185,11 @@ declare namespace Deno {
setKeepAlive(keepalive?: boolean): void;
}
+ /** @category Network */
// deno-lint-ignore no-empty-interface
export interface UnixConn extends Conn {}
+ /** @category Network */
export interface ConnectTlsOptions {
/** The port to connect to. */
port: number;
@@ -197,9 +224,12 @@ declare namespace Deno {
* ```
*
* Requires `allow-net` permission.
+ *
+ * @category Network
*/
export function connectTls(options: ConnectTlsOptions): Promise<TlsConn>;
+ /** @category Network */
export interface StartTlsOptions {
/** A literal IP address or host name that can be resolved to an IP address.
* If not specified, defaults to `127.0.0.1`. */
@@ -224,6 +254,8 @@ declare namespace Deno {
* ```
*
* Requires `allow-net` permission.
+ *
+ * @category Network
*/
export function startTls(
conn: Conn,
@@ -239,6 +271,8 @@ declare namespace Deno {
* const conn = await listener.accept();
* Deno.shutdown(conn.rid);
* ```
+ *
+ * @category Network
*/
export function shutdown(rid: number): Promise<void>;
}