@fuman/net 0.0.1 → 0.0.3

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "@fuman/net",
     "type": "module",
-    "version": "0.0.1",
+    "version": "0.0.3",
     "description": "experimental network abstractions",
     "license": "MIT",
     "scripts": {},
     "dependencies": {
-        "@fuman/io": "^0.0.1",
-        "@fuman/utils": "^0.0.1"
+        "@fuman/io": "^0.0.3",
+        "@fuman/utils": "^0.0.3"
     },
     "exports": {
         ".": {

package/types.d.ts

@@ -1,12 +1,18 @@
 import { IClosable, IReadable, IWritable } from '@fuman/io';
 export interface IConnection<Address, LocalAddress = Address> extends IReadable, IWritable, IClosable {
+    /** local address of the connection (if available) */
     readonly localAddress: LocalAddress | null;
+    /** remote address of the connection (if available) */
     readonly remoteAddress: Address | null;
 }
+/** a TCP endpoint */
 export interface TcpEndpoint {
+    /** address of the endpoint */
     readonly address: string;
+    /** port of the endpoint */
     readonly port: number;
 }
+/** common TLS options */
 export interface TlsOptions {
     /**
      * List of CA certificates to use.
@@ -18,22 +24,32 @@ export interface TlsOptions {
     /** Hostname to use for SNI */
     readonly sni?: string;
 }
+/** TLS options for connecting to an endpoint */
 export interface TlsConnectOptions extends TcpEndpoint, TlsOptions {
 }
+/** TLS options for listening on an endpoint */
 export interface TlsListenOptions extends TcpEndpoint, TlsOptions {
     readonly key?: string;
     readonly cert?: string;
     readonly hosts?: Omit<this, 'hosts' | 'address' | 'port'>[];
 }
+/** a TCP connection */
 export interface ITcpConnection extends IConnection<TcpEndpoint> {
+    /** set no-delay flag on the connection */
     setNoDelay: (noDelay: boolean) => void;
+    /** set keep-alive flag on the connection */
     setKeepAlive: (keepAlive: boolean) => void;
 }
+/** a TLS connection */
 export interface ITlsConnection extends ITcpConnection {
+    /** get the ALPN protocol that was negotiated in the handshake */
     getAlpnProtocol: () => string | null;
 }
+/** a listener for connections */
 export interface IListener<Address, Connection extends IConnection<Address> = IConnection<Address>> extends IClosable {
+    /** address of the listener (if available) */
     readonly address: Address | null;
+    /** accept a new connection */
     accept: () => Promise<Connection>;
 }
 export type ListenFunction<Options, Listener extends IListener<unknown>> = (options: Options) => Promise<Listener>;