chore(bin/generate-docs.js): custom handling of socket:events module …

…docs
socketsupply · Sep 19, 2023 · 32a045e · 32a045e
1 parent 8506614
commit 32a045e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 49 deletions.
diff --git a/api/README.md b/api/README.md
@@ -322,7 +322,7 @@ Start advertising a new value for a well-known UUID
 
 # [Buffer](https://github.com/socketsupply/socket/blob/master/api/buffer.js)
 
-Buffer module is a [third party](https://github.com/feross/buffer) vendor module provided by Feross Aboukhadijeh and other contributors (MIT License),
+Buffer module is a [third party](https://github.com/feross/buffer) vendor module provided by Feross Aboukhadijeh and other contributors (MIT License).
 
 External docs: https://nodejs.org/api/buffer.html
 
@@ -755,54 +755,11 @@ External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options
 
 
 
-### [EventEmitter](https://github.com/socketsupply/socket/blob/master/api/events.js#L225)
-
-
-
-
-### [undefined](https://github.com/socketsupply/socket/blob/master/api/events.js#L225)
-
-
-
-
-### [undefined](https://github.com/socketsupply/socket/blob/master/api/events.js#L225)
-
-
-
-
-### [undefined](https://github.com/socketsupply/socket/blob/master/api/events.js#L225)
-
-
-
-
-### [undefined](https://github.com/socketsupply/socket/blob/master/api/events.js#L225)
-
-
-
-
-## [Event](https://github.com/socketsupply/socket/blob/master/api/events.js#L485)
-
-This is a `VariableDeclaration` named `Event` in `api/events.js`, it's exported but undocumented.
-
-
-
-## [CustomEvent](https://github.com/socketsupply/socket/blob/master/api/events.js#L487)
-
-This is a `VariableDeclaration` named `CustomEvent` in `api/events.js`, it's exported but undocumented.
-
-
-
-## [MessageEvent](https://github.com/socketsupply/socket/blob/master/api/events.js#L502)
-
-This is a `VariableDeclaration` named `MessageEvent` in `api/events.js`, it's exported but undocumented.
-
-
-
-## [ErrorEvent](https://github.com/socketsupply/socket/blob/master/api/events.js#L526)
-
-This is a `VariableDeclaration` named `ErrorEvent` in `api/events.js`, it's exported but undocumented.
+# [Events](https://github.com/socketsupply/socket/blob/master/api/events.js)
 
+Events module is a [third party](https://github.com/browserify/events/blob/main/events.js) module provided by Browserify and Node.js contributors (MIT License).
 
+External docs: https://nodejs.org/api/events.html
 
 
 # [File System](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L26)

diff --git a/bin/generate-docs.js b/bin/generate-docs.js
@@ -25,7 +25,6 @@ const SOCKET_NODE_DIR = 'npm/packages/@socketsupply/socket-node'
     'dgram.js',
     'dns/index.js',
     'dns/promises.js',
-    'events.js',
     'fs/index.js',
     'fs/promises.js',
     'ipc.js',
@@ -54,9 +53,18 @@ const SOCKET_NODE_DIR = 'npm/packages/@socketsupply/socket-node'
     content: `
 # [Buffer](https://github.com/socketsupply/socket/blob/master/api/buffer.js)
 
-Buffer module is a [third party](https://github.com/feross/buffer) vendor module provided by Feross Aboukhadijeh and other contributors (MIT License),
+Buffer module is a [third party](https://github.com/feross/buffer) vendor module provided by Feross Aboukhadijeh and other contributors (MIT License).
 
 External docs: https://nodejs.org/api/buffer.html
+`
+  }, {
+    module: 'events.js',
+    content: `
+# [Events](https://github.com/socketsupply/socket/blob/master/api/events.js)
+
+Events module is a [third party](https://github.com/browserify/events/blob/main/events.js) module provided by Browserify and Node.js contributors (MIT License).
+
+External docs: https://nodejs.org/api/events.html
 `
   })