@autofleet/super-express 2.0.0 → 2.1.0

package/index.d.ts

@@ -0,0 +1,43 @@
+import express from 'express';
+
+/**
+ * Options to customize the behavior of the SuperExpress application.
+ */
+export type DefaultOptions = {
+    /**
+     * Enables or disables body parser middleware.
+     */
+    bodyParser?: boolean;
+    // Add other options from default-options.json as needed
+};
+
+/**
+ * Type for the callback function used in the listen method.
+ */
+type ListenCallback = () => void;
+
+/**
+ * Extends the express.Application interface to include nativeListen and the overridden listen method.
+ */
+export interface SuperExpressApp extends express.Application {
+    /**
+     * Original express listen method.
+     */
+    nativeListen: express.Application['listen'];
+
+    /**
+     * Overridden listen method to add custom behavior.
+     * @param port - The port number to listen on.
+     * @param cb - Optional callback function to execute after the server starts listening.
+     */
+    listen(port: number, cb?: ListenCallback): void;
+}
+
+/**
+ * Creates a new SuperExpress application with the given options.
+ * @param options - Optional settings to customize the application.
+ * @returns A SuperExpress application instance.
+ */
+export default function createSuperExpressApp(
+    options?: Partial<DefaultOptions & express.ApplicationOptions>
+): SuperExpressApp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/super-express",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "AF Express with built in boilerplate",
   "main": "index.js",
   "type": "module",