docs: add typedoc

Author: oyyd

.gitignore

@@ -4,6 +4,16 @@ target
 .tmp
 test.js
 
+out
+temp
+dist
+etc
+docs
+
+package-lock.json
 js/**/*.js
+js/**/*.js.map
+js/**/*.d.ts
+js/tsdoc-metadata.json
 !js/addon.js
 test.ts

__test__/dgram.spec.ts

@@ -1,7 +1,8 @@
 import * as path from 'path';
 import * as fs from 'fs';
+import * as os from 'os';
 import { DgramSocket } from '../js/index';
-import { kTmp, sliently, createDefer } from './util';
+import { kTmp, silently, createDefer } from './util';
 
 const kServerPath = path.resolve(kTmp, './server.sock');
 const kClientPath = path.resolve(kTmp, './client.sock');
@@ -11,11 +12,11 @@ const emptyFn = () => {};
 
 describe('DgramSocket', () => {
   beforeAll(() => {
-    sliently(() => fs.mkdirSync(kTmp));
+    silently(() => fs.mkdirSync(kTmp));
   });
   beforeEach(async () => {
-    sliently(() => fs.unlinkSync(kServerPath));
-    sliently(() => fs.unlinkSync(kClientPath));
+    silently(() => fs.unlinkSync(kServerPath));
+    silently(() => fs.unlinkSync(kClientPath));
   });
 
   it('should work', async () => {
@@ -288,13 +289,15 @@ describe('DgramSocket', () => {
   it('shoud set/send recv/send buffer size', () => {
     const server = new DgramSocket();
 
-    const size = 511;
+    const size = 10000;
+    const expectedSize = os.platform() === 'linux' ? size * 2 : size;
+
 
     server.setRecvBufferSize(size);
-    expect(server.getRecvBufferSize()).toBe(size);
+    expect(server.getRecvBufferSize()).toBe(expectedSize);
 
     server.setSendBufferSize(size);
-    expect(server.getSendBufferSize()).toBe(size);
+    expect(server.getSendBufferSize()).toBe(expectedSize);
 
     server.close();
   });

__test__/seqpacket.spec.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 import * as fs from 'fs';
 import { SeqpacketSocket, SeqpacketServer } from '../js/seqpacket';
-import { kTmp, sliently, createDefer, } from './util';
+import { kTmp, silently, createDefer, } from './util';
 
 const kServerpath = path.resolve(kTmp, './seqpacket_server.sock');
 
@@ -39,10 +39,10 @@ async function createTestPair(
 
 describe('SeqpacketSocket', () => {
   beforeAll(() => {
-    sliently(() => fs.mkdirSync(kTmp));
+    silently(() => fs.mkdirSync(kTmp));
   });
   beforeEach(async () => {
-    sliently(() => fs.unlinkSync(kServerpath));
+    silently(() => fs.unlinkSync(kServerpath));
   });
 
   it('should emit "close"', async () => {

__test__/util.js

@@ -10,7 +10,7 @@ export function wait(t: number) {
   })
 }
 
-export function sliently(fn: any) {
+export function silently(fn: any) {
   try { fn() } catch (_) { }
 }
 

__test__/util.ts

@@ -13,13 +13,17 @@ import {
 } from './addon';
 
 type FnRecv = (err: undefined | Error, buf: Buffer) => void;
-type FnSend = (err: undefined | Error) => void;
+export type SendCb = (err: undefined | Error) => void;
 
 function wrapSocket(obj: DgramSocket) {
   obj.emit = obj.emit.bind(obj);
   dgramCreateSocket(obj);
 }
 
+/**
+ * DgramSocket docs
+ * @public
+ */
 export class DgramSocket extends EventEmitter {
   private closed: boolean = false;
 
@@ -50,17 +54,35 @@ export class DgramSocket extends EventEmitter {
     }
   }
 
+  /**
+   * Returns the average of two numbers.
+   *
+   * @remarks
+   * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
+   *
+   * @param x - The first input number
+   * @param y - The second input number
+   * @returns The arithmetic mean of `x` and `y`
+   */
   bind(socketPath: string) {
     this.checkClosed();
     dgramBind(this, socketPath);
   }
 
+  /**
+   * TODO sendTo
+   * @param buf
+   * @param offset
+   * @param length
+   * @param destPath
+   * @param onWrite
+   */
   sendTo(
     buf: Buffer,
     offset: number,
     length: number,
     destPath: string,
-    onWrite?: FnSend
+    onWrite?: SendCb
   ) {
     this.checkClosed();
     dgramSendTo(this, buf, offset, length, destPath, onWrite);

js/dgram.ts

@@ -1,2 +1,2 @@
-export { DgramSocket } from './dgram'
-export { SeqpacketSocket, SeqpacketServer } from './seqpacket'
+export { SendCb, DgramSocket } from './dgram'
+export { NotifyCb, SeqpacketSocket, SeqpacketServer } from './seqpacket'

js/index.ts

@@ -11,14 +11,16 @@ import {
   seqWrite,
 } from './addon'
 
-// type ConnectionCb = (socket: SeqpacketSocket, addr: string) => void;
-type NotifyCb = () => void;
+export type NotifyCb = () => void;
 
 function wrapSocket(obj: EventEmitter, fd?: number) {
   obj.emit = obj.emit.bind(obj);
   seqCreateSocket(obj, fd);
 }
 
+/**
+ * TODO add docs
+ */
 export class SeqpacketServer extends EventEmitter {
   private closed: boolean = false
 
@@ -71,6 +73,9 @@ export class SeqpacketServer extends EventEmitter {
   // }
 }
 
+/**
+ * TODO add docs
+ */
 export class SeqpacketSocket extends EventEmitter {
   private destroyed: boolean = false
   private connectCb?: NotifyCb;

js/seqpacket.ts

@@ -1,17 +1,18 @@
 {
   "name": "unix-socket",
   "version": "0.0.0",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "js/index.js",
+  "types": "js/index.d.ts",
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "napi build --platform --js false --dts js/addon.d.ts && npm run build:ts",
     "build:release": "napi build --platform --release --js false --dts js/addon.d.ts && npm run build:ts",
-    "build:ts": "tsc js/*.ts",
+    "build:ts": "tsc -p tsconfig.json",
+    "check_mem": "node --max-old-space-size=128 scripts/dgram_memory.js",
+    "doc": "typedoc --excludePrivate --excludeInternal --excludeExternals js/index.ts",
     "prepublishOnly": "napi prepublish -t npm",
     "test": "jest --testRegex '__test__/(.+).spec.ts' --runInBand",
     "test:dumb": "TERM=dumb npm run test",
-    "check_mem": "node --max-old-space-size=128 scripts/dgram_memory.js",
     "version": "napi version"
   },
   "napi": {
@@ -25,10 +26,11 @@
   "license": "MIT",
   "devDependencies": {
     "@napi-rs/cli": "^2.6.2",
-    "@types/jest": "^27.4.1",
+    "@types/jest": "^27.5.0",
+    "@types/node": "^17.0.31",
     "jest": "^27.5.1",
-    "jsdoc": "^3.6.10",
     "ts-jest": "^27.1.4",
+    "typedoc": "^0.22.15",
     "typescript": "^4.6.3"
   },
   "engines": {

package.json

@@ -168,21 +168,6 @@ impl DgramSocketWrap {
     Ok(())
   }
 
-  fn emit_error(&mut self, error: napi::Error) {
-    let env = self.env;
-
-    env
-      .run_in_scope(|| {
-        let event = env.create_string("_error").unwrap();
-        let error = self.env.create_error(error).unwrap();
-        self
-          .emitter.emit(&[event.into_unknown(), error.into_unknown()])
-          .unwrap();
-        Ok(())
-      })
-      .unwrap();
-  }
-
   fn start_recv(&mut self, env: Env) -> Result<()> {
     let uv_loop = get_loop(&env)?;
 
@@ -409,6 +394,7 @@ impl DgramSocketWrap {
 
     let event = env.create_string("close")?;
     self.emitter.emit(&[event.into_unknown()])?;
+    self.emitter.unref()?;
 
     Ok(())
   }
@@ -527,6 +513,7 @@ extern "C" fn on_event(handle: *mut sys::uv_poll_t, status: i32, events: i32) {
 extern "C" fn on_close(handle: *mut sys::uv_handle_t) {
   unsafe {
     let handle = Box::from_raw(handle);
-    Box::from_raw(handle.data as *mut HandleData);
+    let mut data = Box::from_raw(handle.data as *mut HandleData);
+    data.unref().unwrap();
   };
 }