From 1a97b8bc5f01ac9bc399f39b10c10a0503c0438b Mon Sep 17 00:00:00 2001
From: Jeongho Nam <samchon.github@gmail.com>
Date: Tue, 7 May 2024 00:21:03 +0900
Subject: [PATCH] `@internal` tags for only internal features.

---
 package.json                                           |  2 +-
 src/protocols/workers/internal/FileSystem.ts           |  2 +-
 src/protocols/workers/internal/IReject.ts              |  2 +-
 src/protocols/workers/internal/IWorkerCompiler.ts      |  4 ++--
 src/protocols/workers/internal/NodeWorkerCompiler.ts   |  5 ++++-
 src/protocols/workers/internal/WebWorkerCompiler.ts    |  2 +-
 .../workers/internal/processes/ProcessChannel.ts       |  2 +-
 .../workers/internal/processes/ProcessWorker.ts        |  2 +-
 src/protocols/workers/internal/threads/ThreadPort.ts   | 10 +++++-----
 src/protocols/workers/internal/threads/ThreadWorker.ts |  6 +-----
 10 files changed, 18 insertions(+), 19 deletions(-)

diff --git a/package.json b/package.json
index 5557201..c793ba1 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tgrid",
-  "version": "1.0.0-dev.20240506",
+  "version": "1.0.0-dev.20240507",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "exports": {
diff --git a/src/protocols/workers/internal/FileSystem.ts b/src/protocols/workers/internal/FileSystem.ts
index aea32d9..727dd80 100644
--- a/src/protocols/workers/internal/FileSystem.ts
+++ b/src/protocols/workers/internal/FileSystem.ts
@@ -3,7 +3,7 @@ import type fs from "fs";
 import { NodeModule } from "../../../utils/internal/NodeModule";
 
 /**
- * @hidden
+ * @internal
  */
 export namespace FileSystem {
   /* ----------------------------------------------------------------
diff --git a/src/protocols/workers/internal/IReject.ts b/src/protocols/workers/internal/IReject.ts
index 15eb52d..52d14f8 100644
--- a/src/protocols/workers/internal/IReject.ts
+++ b/src/protocols/workers/internal/IReject.ts
@@ -1,5 +1,5 @@
 /**
- * @hidden
+ * @internal
  */
 export interface IReject {
   name: "reject";
diff --git a/src/protocols/workers/internal/IWorkerCompiler.ts b/src/protocols/workers/internal/IWorkerCompiler.ts
index 5efeeb4..f53776d 100644
--- a/src/protocols/workers/internal/IWorkerCompiler.ts
+++ b/src/protocols/workers/internal/IWorkerCompiler.ts
@@ -1,5 +1,5 @@
 /**
- * @hidden
+ * @internal
  */
 export interface IWorkerCompiler {
   compile(content: string): Promise<string>;
@@ -8,7 +8,7 @@ export interface IWorkerCompiler {
 }
 
 /**
- * @hidden
+ * @internal
  */
 export namespace IWorkerCompiler {
   export type Creator = {
diff --git a/src/protocols/workers/internal/NodeWorkerCompiler.ts b/src/protocols/workers/internal/NodeWorkerCompiler.ts
index 016ea57..551912c 100644
--- a/src/protocols/workers/internal/NodeWorkerCompiler.ts
+++ b/src/protocols/workers/internal/NodeWorkerCompiler.ts
@@ -5,7 +5,7 @@ import { ProcessWorker } from "./processes/ProcessWorker";
 import { ThreadWorker } from "./threads/ThreadWorker";
 
 /**
- * @hidden
+ * @internal
  */
 export const NodeWorkerCompiler = async (
   type: "process" | "thread",
@@ -41,6 +41,9 @@ export const NodeWorkerCompiler = async (
   // }
 });
 
+/**
+ * @internal
+ */
 const uuid = () =>
   "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
     const r = (Math.random() * 16) | 0;
diff --git a/src/protocols/workers/internal/WebWorkerCompiler.ts b/src/protocols/workers/internal/WebWorkerCompiler.ts
index a72371f..a2a82ab 100644
--- a/src/protocols/workers/internal/WebWorkerCompiler.ts
+++ b/src/protocols/workers/internal/WebWorkerCompiler.ts
@@ -1,7 +1,7 @@
 import { IWorkerCompiler } from "./IWorkerCompiler";
 
 /**
- * @hidden
+ * @internal
  */
 export const WebWorkerCompiler = async (): Promise<IWorkerCompiler> => ({
   compile: async (content) => {
diff --git a/src/protocols/workers/internal/processes/ProcessChannel.ts b/src/protocols/workers/internal/processes/ProcessChannel.ts
index 72cb5fb..c1f1914 100644
--- a/src/protocols/workers/internal/processes/ProcessChannel.ts
+++ b/src/protocols/workers/internal/processes/ProcessChannel.ts
@@ -1,7 +1,7 @@
 import { NodeModule } from "../../../../utils/internal/NodeModule";
 
 /**
- * @hidden
+ * @internal
  */
 export class ProcessChannel {
   public static postMessage(message: any): void {
diff --git a/src/protocols/workers/internal/processes/ProcessWorker.ts b/src/protocols/workers/internal/processes/ProcessWorker.ts
index 19112df..c6a7453 100644
--- a/src/protocols/workers/internal/processes/ProcessWorker.ts
+++ b/src/protocols/workers/internal/processes/ProcessWorker.ts
@@ -4,7 +4,7 @@ import { NodeModule } from "../../../../utils/internal/NodeModule";
 import { IWorkerCompiler } from "../IWorkerCompiler";
 
 /**
- * @hidden
+ * @internal
  */
 export async function ProcessWorker(): Promise<IWorkerCompiler.Creator> {
   const { fork } = await NodeModule.cp.get();
diff --git a/src/protocols/workers/internal/threads/ThreadPort.ts b/src/protocols/workers/internal/threads/ThreadPort.ts
index 6598228..bedfbf5 100644
--- a/src/protocols/workers/internal/threads/ThreadPort.ts
+++ b/src/protocols/workers/internal/threads/ThreadPort.ts
@@ -1,11 +1,7 @@
-//================================================================
-
-/** @module tgrid.protocols.workers */
-//================================================================
 import { NodeModule } from "../../../../utils/internal/NodeModule";
 
 /**
- * @hidden
+ * @internal
  */
 
 export async function ThreadPort() {
@@ -34,6 +30,10 @@ export async function ThreadPort() {
   }
   return ThreadPort;
 }
+
+/**
+ * @internal
+ */
 export namespace ThreadPort {
   export async function isWorkerThread(): Promise<boolean> {
     const { parentPort } = await NodeModule.thread.get();
diff --git a/src/protocols/workers/internal/threads/ThreadWorker.ts b/src/protocols/workers/internal/threads/ThreadWorker.ts
index 3c2578f..3f985e2 100644
--- a/src/protocols/workers/internal/threads/ThreadWorker.ts
+++ b/src/protocols/workers/internal/threads/ThreadWorker.ts
@@ -1,14 +1,10 @@
-//================================================================
-
-/** @module tgrid.protocols.workers */
-//================================================================
 import type thread from "worker_threads";
 
 import { NodeModule } from "../../../../utils/internal/NodeModule";
 import { IWorkerCompiler } from "../IWorkerCompiler";
 
 /**
- * @hidden
+ * @internal
  */
 export async function ThreadWorker(): Promise<IWorkerCompiler.Creator> {
   const { Worker } = await NodeModule.thread.get();