chore: update docs

chef-js · Jun 11, 2023 · 8e92597 · 8e92597
1 parent a407b9b
commit 8e92597
Show file tree

Hide file tree

Showing 22 changed files with 27 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,6 @@
 
 [<img src="https://badge.fury.io/js/chef-core.svg" alt="npm package version" />](https://badge.fury.io/js/chef-core) [<img src="https://circleci.com/gh/chef-js/core.svg?style=shield" alt="tests status" />](https://circleci.com/gh/chef-js/core) [<img src="https://img.shields.io/npm/dw/chef-core.svg?color=success" alt="npm downloads per week" />](https://www.npmts.com/package/chef-core)
 
-
 **web-sockets** micro-service manager and **static files server** at the same port,
 
 designed for **node** written in **typescript**, with **tests**

diff --git a/docs/functions/chef.html b/docs/functions/chef.html
@@ -165,7 +165,7 @@ <h4 class="tsd-returns-title">
                   <li>
                     Defined in
                     <a
-                      href="https://github.com/chef-js/core/blob/cdfb632/src/server/index.ts#L19"
+                      href="https://github.com/chef-js/core/blob/a407b9b/src/server/index.ts#L19"
                       >server/index.ts:19</a
                     >
                   </li>

diff --git a/docs/functions/createFileReader.html b/docs/functions/createFileReader.html
@@ -195,7 +195,7 @@ <h4 class="tsd-returns-title">
                   <li>
                     Defined in
                     <a
-                      href="https://github.com/chef-js/core/blob/cdfb632/src/server/static-files.ts#L6"
+                      href="https://github.com/chef-js/core/blob/a407b9b/src/server/static-files.ts#L6"
                       >server/static-files.ts:6</a
                     >
                   </li>

diff --git a/docs/functions/getPlugin.html b/docs/functions/getPlugin.html
@@ -155,7 +155,7 @@ <h4 class="tsd-returns-title">
                   <li>
                     Defined in
                     <a
-                      href="https://github.com/chef-js/core/blob/cdfb632/src/plugins.ts#L30"
+                      href="https://github.com/chef-js/core/blob/a407b9b/src/plugins.ts#L30"
                       >plugins.ts:30</a
                     >
                   </li>

diff --git a/docs/functions/getUrl.html b/docs/functions/getUrl.html
@@ -130,7 +130,7 @@ <h4 class="tsd-returns-title">
                   <li>
                     Defined in
                     <a
-                      href="https://github.com/chef-js/core/blob/cdfb632/src/server/get-url.ts#L1"
+                      href="https://github.com/chef-js/core/blob/a407b9b/src/server/get-url.ts#L1"
                       >server/get-url.ts:1</a
                     >
                   </li>

diff --git a/docs/functions/populatePlugins.html b/docs/functions/populatePlugins.html
@@ -143,7 +143,7 @@ <h4 class="tsd-returns-title">
                   <li>
                     Defined in
                     <a
-                      href="https://github.com/chef-js/core/blob/cdfb632/src/plugins.ts#L4"
+                      href="https://github.com/chef-js/core/blob/a407b9b/src/plugins.ts#L4"
                       >plugins.ts:4</a
                     >
                   </li>

diff --git a/docs/index.html b/docs/index.html
@@ -97,6 +97,11 @@ <h1><a href="#md:chef-core">chef-core</a></h1>
                 src="https://circleci.com/gh/chef-js/core.svg?style=shield"
                 alt="tests status"
             /></a>
+            <a href="https://www.npmts.com/package/chef-core"
+              ><img
+                src="https://img.shields.io/npm/dw/chef-core.svg?color=success"
+                alt="npm downloads per week"
+            /></a>
           </p>
           <p>
             <strong>web-sockets</strong> micro-service manager and

diff --git a/docs/types/Config.html b/docs/types/Config.html
@@ -278,7 +278,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L94"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L94"
                 >types.ts:94</a
               >
             </li>

diff --git a/docs/types/CoreConsumer.html b/docs/types/CoreConsumer.html
@@ -194,7 +194,7 @@ <h4 class="tsd-returns-title">
                       <li>
                         Defined in
                         <a
-                          href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L110"
+                          href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L110"
                           >types.ts:110</a
                         >
                       </li>
@@ -261,7 +261,7 @@ <h4 class="tsd-returns-title">
                       <li>
                         Defined in
                         <a
-                          href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L111"
+                          href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L111"
                           >types.ts:111</a
                         >
                       </li>
@@ -278,7 +278,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L109"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L109"
                 >types.ts:109</a
               >
             </li>

diff --git a/docs/types/Event.html b/docs/types/Event.html
@@ -135,7 +135,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L36"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L36"
                 >types.ts:36</a
               >
             </li>

diff --git a/docs/types/FileReader.html b/docs/types/FileReader.html
@@ -148,7 +148,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L84"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L84"
                 >types.ts:84</a
               >
             </li>

diff --git a/docs/types/FileReaderCache.html b/docs/types/FileReaderCache.html
@@ -121,7 +121,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L89"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L89"
                 >types.ts:89</a
               >
             </li>

diff --git a/docs/types/FileReaderResponse.html b/docs/types/FileReaderResponse.html
@@ -141,7 +141,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L75"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L75"
                 >types.ts:75</a
               >
             </li>

diff --git a/docs/types/Plugin.html b/docs/types/Plugin.html
@@ -153,7 +153,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L51"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L51"
                 >types.ts:51</a
               >
             </li>

diff --git a/docs/types/Property.html b/docs/types/Property.html
@@ -143,7 +143,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L24"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L24"
                 >types.ts:24</a
               >
             </li>

diff --git a/docs/types/Request.html b/docs/types/Request.html
@@ -184,7 +184,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L66"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L66"
                 >types.ts:66</a
               >
             </li>

diff --git a/docs/types/Server.html b/docs/types/Server.html
@@ -218,7 +218,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L56"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L56"
                 >types.ts:56</a
               >
             </li>

diff --git a/docs/types/ServerContext.html b/docs/types/ServerContext.html
@@ -121,7 +121,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L17"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L17"
                 >types.ts:17</a
               >
             </li>

diff --git a/docs/types/ServerEmitEvent.html b/docs/types/ServerEmitEvent.html
@@ -155,7 +155,7 @@ <h4 class="tsd-returns-title">
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L5"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L5"
                 >types.ts:5</a
               >
             </li>

diff --git a/docs/types/ServerToTopic.html b/docs/types/ServerToTopic.html
@@ -177,7 +177,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L10"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L10"
                 >types.ts:10</a
               >
             </li>

diff --git a/docs/types/Socket.html b/docs/types/Socket.html
@@ -101,7 +101,7 @@ <h1>Type alias Socket</h1>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L45"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L45"
                 >types.ts:45</a
               >
             </li>

diff --git a/docs/types/UWebSocket.html b/docs/types/UWebSocket.html
@@ -125,7 +125,7 @@ <h5>
             <li>
               Defined in
               <a
-                href="https://github.com/chef-js/core/blob/cdfb632/src/types.ts#L29"
+                href="https://github.com/chef-js/core/blob/a407b9b/src/types.ts#L29"
                 >types.ts:29</a
               >
             </li>