docs: include examples for the types in the docs

Author: aminya

examples/threaded-worker/processor.ts

@@ -10,8 +10,8 @@ export class Processor {
   output = new Pull()
   signal = new Publisher()
 
-  init: Promise<any>
-  exit: Promise<any>
+  init: Promise<void[]>
+  exit: Promise<void[]>
 
   constructor(threads: number = cpus().length) {
     console.log(`starting ${threads} worker threads`)
@@ -22,7 +22,7 @@ export class Processor {
       this.input.bind("inproc://input"),
       this.output.bind("inproc://output"),
       this.signal.bind("inproc://signal"),
-      new Promise(resolve => {
+      new Promise<void>(resolve => {
         setTimeout(resolve, 100)
       }),
     ])

package.json

@@ -59,6 +59,7 @@
     "ts-node": "~10.9.2",
     "typedoc": "^0.27.6",
     "typedoc-plugin-dt-links": "^1.1.6",
+    "typedoc-plugin-include-example": "^2.0.2",
     "typedoc-plugin-inline-sources": "^1.2.0",
     "typedoc-plugin-mdn-links": "^4.0.7",
     "typescript": "~4.9.5",

pnpm-lock.yaml

@@ -732,6 +732,16 @@ 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} = {}) {
   const sock = new Socket(type)
   for (const key in options) {

src/compat.ts

@@ -982,6 +982,8 @@ 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 {
   /**
@@ -1030,6 +1032,8 @@ 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 {
   /**
@@ -1135,6 +1139,8 @@ 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 {
   /**
@@ -1201,6 +1207,8 @@ 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 {
   /**
@@ -1232,6 +1240,9 @@ 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
  */
 export class Dealer extends Socket {
   /**
@@ -1375,6 +1386,8 @@ 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 {
   constructor(options?: SocketOptions<Pull>) {
@@ -1406,6 +1419,8 @@ 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 {
   constructor(options?: SocketOptions<Push>) {

src/index.ts

@@ -31,5 +31,6 @@
   "plugin": [
     "typedoc-plugin-dt-links",
     "typedoc-plugin-mdn-links",
+    "typedoc-plugin-include-example"
   ]
 }