@fuman/bun 0.0.1 → 0.0.3

package/connection.cjs

@@ -4,12 +4,14 @@ const io = require("@fuman/io");
 const net = require("@fuman/net");
 const utils = require("@fuman/utils");
 class TcpConnection {
+  /** Underlying socket */
   socket;
   #error = null;
   #recvBuffer = io.Bytes.alloc(1024 * 16);
   #sendBuffer = new utils.Deque();
   #cv = new utils.ConditionVariable();
   #endpoint;
+  /** Connect to the given endpoint (must be called as the first thing before using the connection) */
   async connect(endpoint, tls = false) {
     this.socket = await Bun.connect({
       hostname: endpoint.address,
@@ -24,19 +26,23 @@ class TcpConnection {
     });
     this.#endpoint = endpoint;
   }
+  /** Create a new TcpConnection from an existing socket */
   static from(socket) {
     const conn = new TcpConnection();
     conn.socket = socket;
     return conn;
   }
+  /** @internal */
   _handleData(_, data) {
     this.#recvBuffer.writeSync(data.length).set(data);
     this.#cv.notify();
   }
+  /** @internal */
   _handleError(_, error) {
     this.#error = error;
     this.#cv.notify();
   }
+  /** @internal */
   _handleClose() {
     this.#error = new net.ConnectionClosedError();
     this.#cv.notify();
@@ -44,6 +50,7 @@ class TcpConnection {
       deferred.reject(this.#error);
     }
   }
+  /** @internal */
   _handleDrain() {
     while (!this.#sendBuffer.isEmpty()) {
       const [chunk, deferred] = this.#sendBuffer.popFront();

package/connection.d.ts

@@ -1,14 +1,17 @@
 import { ITcpConnection, ITlsConnection, TcpEndpoint } from '@fuman/net';
 import { Socket } from 'bun';
+/**
+ * Implementation of {@link ITcpConnection} and {@link ITlsConnection} interfaces
+ * using Bun's `connect` function.
+ */
 export declare class TcpConnection implements ITcpConnection, ITlsConnection {
     #private;
+    /** Underlying socket */
     readonly socket: Socket<any>;
+    /** Connect to the given endpoint (must be called as the first thing before using the connection) */
     connect(endpoint: TcpEndpoint, tls?: boolean): Promise<void>;
+    /** Create a new TcpConnection from an existing socket */
     static from(socket: Socket<any>): TcpConnection;
-    _handleData(_: unknown, data: Buffer): void;
-    _handleError(_: unknown, error: Error): void;
-    _handleClose(): void;
-    _handleDrain(): void;
     read(into: Uint8Array): Promise<number>;
     write(bytes: Uint8Array): Promise<void>;
     close(): void;

package/connection.js

@@ -2,12 +2,14 @@ import { Bytes } from "@fuman/io";
 import { ConnectionClosedError } from "@fuman/net";
 import { Deque, ConditionVariable, Deferred } from "@fuman/utils";
 class TcpConnection {
+  /** Underlying socket */
   socket;
   #error = null;
   #recvBuffer = Bytes.alloc(1024 * 16);
   #sendBuffer = new Deque();
   #cv = new ConditionVariable();
   #endpoint;
+  /** Connect to the given endpoint (must be called as the first thing before using the connection) */
   async connect(endpoint, tls = false) {
     this.socket = await Bun.connect({
       hostname: endpoint.address,
@@ -22,19 +24,23 @@ class TcpConnection {
     });
     this.#endpoint = endpoint;
   }
+  /** Create a new TcpConnection from an existing socket */
   static from(socket) {
     const conn = new TcpConnection();
     conn.socket = socket;
     return conn;
   }
+  /** @internal */
   _handleData(_, data) {
     this.#recvBuffer.writeSync(data.length).set(data);
     this.#cv.notify();
   }
+  /** @internal */
   _handleError(_, error) {
     this.#error = error;
     this.#cv.notify();
   }
+  /** @internal */
   _handleClose() {
     this.#error = new ConnectionClosedError();
     this.#cv.notify();
@@ -42,6 +48,7 @@ class TcpConnection {
       deferred.reject(this.#error);
     }
   }
+  /** @internal */
   _handleDrain() {
     while (!this.#sendBuffer.isEmpty()) {
       const [chunk, deferred] = this.#sendBuffer.popFront();

package/listener.cjs

@@ -7,6 +7,7 @@ class TcpListener {
   }
   #listener;
   #waiter;
+  /** listen on the given endpoint; must be called before any other methods */
   listen(endpoint) {
     this.#listener = Bun.listen({
       hostname: endpoint.address,

package/listener.d.ts

@@ -3,6 +3,7 @@ import { TcpConnection } from './connection.js';
 export declare class TcpListener implements IListener<TcpEndpoint, TcpConnection> {
     #private;
     constructor();
+    /** listen on the given endpoint; must be called before any other methods */
     listen(endpoint: TcpEndpoint): void;
     close(): void;
     get address(): TcpEndpoint;

package/listener.js

@@ -5,6 +5,7 @@ class TcpListener {
   }
   #listener;
   #waiter;
+  /** listen on the given endpoint; must be called before any other methods */
   listen(endpoint) {
     this.#listener = Bun.listen({
       hostname: endpoint.address,

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@fuman/bun",
     "type": "module",
-    "version": "0.0.1",
+    "version": "0.0.3",
     "description": "bun-specific utilities",
     "license": "MIT",
     "scripts": {},
     "dependencies": {
-        "@fuman/io": "^0.0.1",
-        "@fuman/net": "^0.0.1",
-        "@fuman/utils": "^0.0.1"
+        "@fuman/io": "^0.0.3",
+        "@fuman/net": "^0.0.3",
+        "@fuman/utils": "^0.0.3"
     },
     "exports": {
         ".": {