docs: include non-exported types in the docs

Author: aminya

package.json

@@ -62,6 +62,7 @@
     "typedoc-plugin-include-example": "^2.0.2",
     "typedoc-plugin-inline-sources": "^1.2.0",
     "typedoc-plugin-mdn-links": "^4.0.7",
+    "typedoc-plugin-missing-exports": "^3.1.0",
     "typescript": "~4.9.5",
     "which": "^5.0.0"
   },

pnpm-lock.yaml

@@ -734,15 +734,18 @@ for (const key in shortOptions) {
 
 /**
  * Create a new socket.
- * 
+ *
  * @param type Type of socket to create.
  * @param options Options for the socket.
- * 
+ *
  * @returns A new socket.
- * 
+ *
  * @includeExample examples/v5-compat/index.js
  */
-export function createSocket(type: SocketType, options: {[key: string]: any} = {}) {
+export function createSocket(
+  type: SocketType,
+  options: {[key: string]: any} = {},
+) {
   const sock = new Socket(type)
   for (const key in options) {
     if (options.hasOwnProperty(key)) {
@@ -805,10 +808,7 @@ export function proxy(frontend: Socket, backend: Socket, capture?: Socket) {
 
 export const version = zmq.version
 
-export {
-  createSocket as socket,
-  shortOptions as options,
-}
+export {createSocket as socket, shortOptions as options}
 
 export * from "./compat/long-options"
 export * from "./compat/types"

src/compat.ts

@@ -982,7 +982,7 @@ allowMethods(Pair.prototype, ["send", "receive"])
  * water mark for a connected {@link Subscriber}, then any messages that would
  * be sent to the subscriber in question shall instead be dropped until the mute
  * state ends. The {@link Writable.send}() method will never block.
- * 
+ *
  * @includeExample examples/pub-sub/publisher.ts
  */
 export class Publisher extends Socket {
@@ -1032,7 +1032,7 @@ allowMethods(Publisher.prototype, ["send"])
  * {@link Publisher}. Initially a {@link Subscriber} is not subscribed to any
  * messages. Use {@link Subscriber.subscribe}() to specify which messages to
  * subscribe to. This socket cannot send messages.
- * 
+ *
  * @includeExample examples/pub-sub/subscriber.ts
  */
 export class Subscriber extends Socket {
@@ -1139,7 +1139,7 @@ allowMethods(Subscriber.prototype, ["receive"])
  * If no services are available, then any send operation on the socket shall
  * block until at least one service becomes available. The REQ socket shall not
  * discard messages.
- * 
+ *
  * @includeExample examples/req-rep/client.ts
  */
 export class Request extends Socket {
@@ -1207,7 +1207,7 @@ allowMethods(Request.prototype, ["send", "receive"])
  * among all clients, and each reply sent is routed to the client that issued
  * the last request. If the original requester does not exist any more the reply
  * is silently discarded.
- * 
+ *
  * @includeExample examples/req-rep/server.ts
  */
 export class Reply extends Socket {
@@ -1240,7 +1240,7 @@ allowMethods(Reply.prototype, ["send", "receive"])
  * When a {@link Dealer} is connected to a {@link Reply} socket, each message
  * sent must consist of an empty message part, the delimiter, followed by one or
  * more body parts.
- * 
+ *
  * @includeExample examples/queue/index.ts
  * @includeExample examples/queue/queue.ts
  */
@@ -1386,7 +1386,7 @@ allowMethods(Router.prototype, ["send", "receive"])
  * A {@link Pull} socket is used by a pipeline node to receive messages from
  * upstream pipeline nodes. Messages are fair-queued from among all connected
  * upstream nodes. This socket cannot send messages.
- * 
+ *
  * @includeExample examples/push-pull/worker.ts
  */
 export class Pull extends Socket {
@@ -1419,7 +1419,7 @@ allowMethods(Pull.prototype, ["receive"])
  * at all, then {@link Writable.send}() will block until the mute state ends or
  * at least one downstream node becomes available for sending; messages are not
  * discarded.
- * 
+ *
  * @includeExample examples/push-pull/producer.ts
  */
 export class Push extends Socket {

src/index.ts

@@ -685,8 +685,11 @@ export const enum SocketType {
 
 /* Utility types. */
 
-/* https://stackoverflow.com/questions/49579094 */
-type IfEquals<X, Y, A, B = never> =
+/**
+ * @internal
+ * https://stackoverflow.com/questions/49579094
+ */
+export type IfEquals<X, Y, A, B = never> =
   (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? A : B
 
 /**

src/native.ts

@@ -6,7 +6,7 @@ type SocketMethods = "send" | "receive" | "join" | "leave"
  * to make the relevant socket types have only their relevant methods.
  * @param socketPrototype
  * @param methods
- * 
+ *
  * @internal
  */
 export function allowMethods(socketPrototype: any, methods: SocketMethods[]) {

src/util.ts

@@ -6,12 +6,7 @@
   "out": "docs-unminified",
   "excludePrivate": true,
   "excludeExternals": false,
-  "exclude": [
-    "script/**/*",
-    "test/**/*",
-    "examples/**/*",
-    "build/**/*"
-  ],
+  "exclude": ["script/**/*", "test/**/*", "examples/**/*", "build/**/*"],
   "highlightLanguages": [
     "bash",
     "console",
@@ -31,6 +26,7 @@
   "plugin": [
     "typedoc-plugin-dt-links",
     "typedoc-plugin-mdn-links",
-    "typedoc-plugin-include-example"
+    "typedoc-plugin-include-example",
+    "typedoc-plugin-missing-exports"
   ]
 }