@ublitzjs/core 0.1.1 → 1.0.0

package/README.md

@@ -1,17 +1,20 @@
 ![μBlitz.js](./logo.png)
 <br/>
 
-# μBlitz.js - utility-library for uWebSockets.js
+# μBlitz.js - utilitarian-library for uWebSockets.js
 
-On NPM you can find such packages:
+On NPM you can find such packages: (with @ublitzjs/ organization)
 
-- @ublitzjs/core (THIS repo)
-- @ublitzjs/logger (colorful console)
-- @ublitzjs/static (send files)
-- @ublitzjs/payload (handling POST-like requests)
-- @ublitzjs/router (OpenAPI-like router for simple orientation)
-- @ublitzjs/openapi
-- @ublitzjs/dev-comments (Tool for removing CODE BETWEEN /\*\_START_DEV\_\*/ and /\*\_END_DEV\_\*/ comments)
+- core (THIS repo)
+- logger (colorful console)
+- static (send files)
+- payload (handling POST-like requests)
+- router (OpenAPI-like router for simple orientation)
+- openapi
+- preprocess (Code preprocessing + templating framework)
+- asyncapi
+- testing (coming soon)
+- auth (coming soon)
 
 # Installation
 
@@ -27,12 +30,12 @@ Supports CJS and ESM in ALL packages
 
 # <a href="./USAGE.md" target="_blank">Go to usage.md</a>
 
-# Comparison with others
+# But why?
 
-It is acclaimed, that Express.js, Fastify, and other frameworks are built to be very extensible and developer-friendly. It is enough to download needed packages, put them as middlewares, which handle everything behind the scenes, and do your own job. <br>
+It is acclaimed that Express.js, Fastify and other frameworks are built to be very extensible and developer-friendly. It is enough to download needed packages, put them as middlewares, which handle everything behind the scenes, and do your own job. <br>
 
-But the "speed" of creating your app comes from so-called "abstractions". Their versatility is often considered an "overkill" and they usually overwhelm the RAM and slow down your app. Most people, however, still prefer "rapid typing" over speed of execution, under which I mean uWebSocket.js (which actually handles websockets AND http requests)<br>
+But the "speed" of creating your app comes from so-called "abstractions". Their versatility is often considered to be an "overkill" as they usually overwhelm the RAM and slow down your app. Most people, however, still prefer "rapid typing" over speed of execution, under which I mean uWebSockets.js (which actually handles websockets AND http requests)<br>
 
-Though it IS performant, it handles only core features. Now there are solutions like "hyper-express", "ultimate-express", "uwebsockets-express", but they are just abstractions, created to be somehow faster then express, but hide the most important (and difficult) aspects of uWS.<br>
+Though it IS performant, it handles only core features. Now there are solutions like "hyper-express", "ultimate-express", "uwebsockets-express", but they are just additional layers simulating "express" behaviour, while hiding the most important (and difficult) aspects of uWS.<br>
 
-This library is different. It doesn't take care of everything, but rather helps you do it yourself, using utilities.
+This library provides you with utilities but you still operate on the uWebSockets.js. This way server remains optimizable and rapid typing doesn't vanish.

package/USAGE.md

@@ -195,7 +195,7 @@ export default (server: Server) => {
 };
 ```
 
-Also there is HeadersMap.default (see it in the code itself), HeadersMap.baseObj (also in the code), and HeadersMap.remove (you remove unwanted headers)
+Also there is HeadersMap.default (see in the code), HeadersMap.baseObj (also in the code), and HeadersMap.remove (you remove unwanted headers)
 
 ## setCSP
 
@@ -287,9 +287,9 @@ These types add 3 methods to websocket object: sendFirstFragment, sendFragment,
 More detailed description <a href="./types/uws-types.d.ts">here</a>
 
 ```typescript
-import type { DocumentedWSBehavior, lowHeaders } from "@ublitzjs/core";
+import type { extendApp, DocumentedWSBehavior, lowHeaders } from "@ublitzjs/core";
 import uWS from "uWebSockets.js";
-const server = uWS.App();
+const server = extendApp(uWS.App()) // better for ts
 server.ws("/*", {
   upgrade(res, req, context) {
     res.upgrade(
@@ -307,7 +307,18 @@ server.ws("/*", {
     ws.sendFragment("hello2\n");
     ws.sendLastFragment("end hello");
   },
-} as DocumentedWSBehavior<{}> as any);
+  close(ws){
+    //typed safety flag
+    ws.closed = true;
+  }
+  message(ws){
+    setTimeout(()=>{
+      //acts like res.aborted
+      if(ws.closed) return;
+      ws.send("hello")
+    }, 100);
+  },
+});
 ```
 
 # Bundling
@@ -316,4 +327,4 @@ Best efficiency and start time can be achieved if the code is bundled and minifi
 For this purpose you can use "esbuild" (at least it was tested and worked for both cjs and esm formats).<br>
 The only thing to remember: when you use it for bundling, don't forget to put "uWebSockets.js" to "external" array.<br>
 <a href="./examples/esbuild.mjs">Example 1</a><br>
-<a href="./tests/esbuild/build.mjs">Dynamic example 2</a>
+<a href="./tests/esbuild.test.ts">Dynamic example 2</a>

package/babel.config.json

@@ -0,0 +1,8 @@
+{
+  "plugins": [
+    [
+      "@babel/plugin-transform-modules-commonjs", 
+      { "importInterop": "node" }
+    ]
+  ]
+}