@expressots/shared 3.0.0-beta.3 → 3.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
## [3.0.0](https://github.com/expressots/shared/compare/3.0.0-beta.3...3.0.0) (2024-12-03)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* refactor IWebServer interface, add IWebServerBuilder ([9a23fff](https://github.com/expressots/shared/commit/9a23fff1e7de8d3880ed90317ffde1037ef1947b))
|
|
9
|
+
|
|
1
10
|
## [3.0.0-beta.3](https://github.com/expressots/shared/compare/0.3.0...0.4.0) (2024-11-28)
|
|
2
11
|
|
|
3
12
|
### Features
|
|
@@ -52,4 +61,4 @@
|
|
|
52
61
|
|
|
53
62
|
### Bug Fixes
|
|
54
63
|
|
|
55
|
-
- testing commitlint ([0e78653](https://github.com/expressots/<<repo_name>>/commit/0e786539402f69fdca3fe5b684d850e523db7698))
|
|
64
|
+
- testing commitlint ([0e78653](https://github.com/expressots/<<repo_name>>/commit/0e786539402f69fdca3fe5b684d850e523db7698))
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { Environment, IEnvironment } from "./environment.interface";
|
|
1
|
+
import { Server as HTTPServer } from "http";
|
|
3
2
|
import { IConsoleMessage } from "./console.interface";
|
|
3
|
+
import { Environment, IEnvironment } from "./environment.interface";
|
|
4
4
|
import { RenderEngine } from "./render/render.types";
|
|
5
5
|
/**
|
|
6
6
|
* Namespace for the Server Application.
|
|
@@ -13,9 +13,8 @@ export declare namespace Server {
|
|
|
13
13
|
*/
|
|
14
14
|
interface IWebServer {
|
|
15
15
|
initEnvironment(environment: Environment, options?: IEnvironment): void;
|
|
16
|
-
listen(port: number | string, appInfo?: IConsoleMessage): Promise<
|
|
16
|
+
listen(port: number | string, appInfo?: IConsoleMessage): Promise<IWebServerPublic>;
|
|
17
17
|
setEngine<T extends RenderEngine.EngineOptions>(engine: RenderEngine.Engine, options?: T): Promise<void>;
|
|
18
|
-
close(enableLog?: boolean): Promise<void>;
|
|
19
18
|
}
|
|
20
19
|
/**
|
|
21
20
|
* Constructor type for IWebServer.
|
|
@@ -24,31 +23,31 @@ export declare namespace Server {
|
|
|
24
23
|
new (): T;
|
|
25
24
|
}
|
|
26
25
|
/**
|
|
27
|
-
*
|
|
26
|
+
* Interface for the WebServerBuilder.
|
|
28
27
|
* @public API
|
|
29
28
|
*/
|
|
30
|
-
interface
|
|
29
|
+
interface IWebServerBuilder {
|
|
31
30
|
/**
|
|
32
31
|
* Start listening on the given port.
|
|
33
32
|
* @param port - The port number to listen on.
|
|
34
33
|
* @param consoleMessage - Optional App info message to display on startup.
|
|
35
34
|
*/
|
|
36
|
-
listen(port: number | string, consoleMessage?: IConsoleMessage): Promise<
|
|
35
|
+
listen(port: number | string, consoleMessage?: IConsoleMessage): Promise<IWebServerPublic>;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Public Interface for the WebServer application.
|
|
39
|
+
* @public API
|
|
40
|
+
*/
|
|
41
|
+
interface IWebServerPublic {
|
|
37
42
|
/**
|
|
38
43
|
* Get the underlying HTTP server. (default: Express.js)
|
|
39
44
|
* @returns The underlying HTTP server after initialization.
|
|
40
45
|
* @public API
|
|
41
46
|
*/
|
|
42
|
-
getHttpServer(): Promise<
|
|
43
|
-
/**
|
|
44
|
-
* Close the server and stop listening.
|
|
45
|
-
* @returns A promise that resolves when the server is closed.
|
|
46
|
-
* @param enableLog - Enable logging when closing the server.
|
|
47
|
-
* @public API
|
|
48
|
-
*/
|
|
49
|
-
close(enableLog?: boolean): Promise<void>;
|
|
47
|
+
getHttpServer(): Promise<HTTPServer>;
|
|
50
48
|
}
|
|
51
49
|
}
|
|
52
50
|
export type IWebServer = Server.IWebServer;
|
|
53
51
|
export type IWebServerConstructor<T extends IWebServer> = Server.IWebServerConstructor<T>;
|
|
52
|
+
export type IWebServerBuilder = Server.IWebServerBuilder;
|
|
54
53
|
export type IWebServerPublic = Server.IWebServerPublic;
|
|
@@ -2,4 +2,4 @@ export { RenderEngine } from "./render/render.types";
|
|
|
2
2
|
export { IConsoleMessage } from "./console.interface";
|
|
3
3
|
export { IExpressoMiddleware } from "./middleware.interface";
|
|
4
4
|
export { Environment, IEnvironment, Env } from "./environment.interface";
|
|
5
|
-
export { IWebServer, IWebServerConstructor, IWebServerPublic, Server, } from "./application-express.interface";
|
|
5
|
+
export { IWebServer, IWebServerBuilder, IWebServerConstructor, IWebServerPublic, Server, } from "./application-express.interface";
|
package/lib/package.json
CHANGED
package/package.json
CHANGED