docs: export SocketType in the compat layer

Author: aminya

src/compat.ts

@@ -57,7 +57,7 @@ const shortOptions = {
   connect_timeout: longOptions.ZMQ_CONNECT_TIMEOUT,
 }
 
-class Context {
+export class Context {
   static setMaxThreads(value: number) {
     zmq.context.ioThreads = value
   }
@@ -79,7 +79,10 @@ class Context {
   }
 }
 
-type SocketType =
+/**
+ * All the socket types available in the compatibility layer
+ */
+export type SocketType =
   | "pair"
   | "req"
   | "rep"
@@ -97,7 +100,7 @@ type SocketType =
 
 type Callback = (err?: Error) => void
 
-class Socket extends EventEmitter {
+export class Socket extends EventEmitter {
   [key: string]: any
 
   type: SocketType
@@ -729,7 +732,7 @@ for (const key in shortOptions) {
   })
 }
 
-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)) {
@@ -739,12 +742,12 @@ function createSocket(type: SocketType, options: {[key: string]: any} = {}) {
   return sock
 }
 
-function curveKeypair() {
+export function curveKeypair() {
   const {publicKey, secretKey} = zmq.curveKeyPair()
   return {public: publicKey, secret: secretKey}
 }
 
-function proxy(frontend: Socket, backend: Socket, capture?: Socket) {
+export function proxy(frontend: Socket, backend: Socket, capture?: Socket) {
   switch (`${frontend.type}/${backend.type}`) {
     case "push/pull":
     case "pull/push":
@@ -790,17 +793,10 @@ function proxy(frontend: Socket, backend: Socket, capture?: Socket) {
   }
 }
 
-const version = zmq.version
+export const version = zmq.version
 
 export {
-  version,
-  Context,
-  Socket,
-  SocketType,
   createSocket as socket,
-  createSocket,
-  curveKeypair,
-  proxy,
   shortOptions as options,
 }
 

src/native.ts

@@ -656,6 +656,9 @@ export declare abstract class Socket {
   protected setStringOption(option: number, value: string | Buffer | null): void
 }
 
+/**
+ * Socket types available for creating sockets.
+ */
 export const enum SocketType {
   Pair = 0,
   Publisher = 1,