@teambit/express 0.0.474 → 0.0.475

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.
@@ -11,14 +11,45 @@ export declare type ExpressConfig = {
11
11
  export declare type MiddlewareSlot = SlotRegistry<MiddlewareManifest[]>;
12
12
  export declare type RouteSlot = SlotRegistry<Route[]>;
13
13
  export declare class ExpressMain {
14
+ /**
15
+ * extension config
16
+ */
14
17
  readonly config: ExpressConfig;
18
+ /**
19
+ * slot for registering graphql modules
20
+ */
15
21
  private moduleSlot;
22
+ /**
23
+ * logger extension.
24
+ */
16
25
  readonly logger: Logger;
17
26
  readonly middlewareSlot: MiddlewareSlot;
18
27
  static runtime: import("@teambit/harmony").RuntimeDefinition;
19
- constructor(config: ExpressConfig, moduleSlot: RouteSlot, logger: Logger, middlewareSlot: MiddlewareSlot);
28
+ constructor(
29
+ /**
30
+ * extension config
31
+ */
32
+ config: ExpressConfig,
33
+ /**
34
+ * slot for registering graphql modules
35
+ */
36
+ moduleSlot: RouteSlot,
37
+ /**
38
+ * logger extension.
39
+ */
40
+ logger: Logger, middlewareSlot: MiddlewareSlot);
41
+ /**
42
+ * start a express server.
43
+ */
20
44
  listen(port?: number): Promise<void>;
45
+ /**
46
+ * register a new express routes.
47
+ * route will be added as `/api/${route}`
48
+ */
21
49
  register(routes: Route[]): this;
50
+ /**
51
+ * register a new middleware into express.
52
+ */
22
53
  registerMiddleware(middlewares: MiddlewareManifest[]): this;
23
54
  private createRootRoutes;
24
55
  createApp(expressApp?: Express, options?: {
@@ -2,11 +2,17 @@
2
2
  import { NextFunction } from './next';
3
3
  import { Request } from './request';
4
4
  import { Response } from './response';
5
+ /**
6
+ * define express Middleware
7
+ */
5
8
  export declare type Middleware = (req: Request, res: Response, next: NextFunction) => Promise<any>;
6
9
  export declare enum Verb {
7
10
  WRITE = "write",
8
11
  READ = "read"
9
12
  }
13
+ /**
14
+ * express new Route
15
+ */
10
16
  export interface Route {
11
17
  method: string;
12
18
  route: string | RegExp;
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@teambit/express",
3
- "version": "0.0.474",
3
+ "version": "0.0.475",
4
4
  "homepage": "https://bit.dev/teambit/harmony/express",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.harmony",
8
8
  "name": "express",
9
- "version": "0.0.474"
9
+ "version": "0.0.475"
10
10
  },
11
11
  "dependencies": {
12
12
  "@teambit/harmony": "0.2.11",
@@ -15,8 +15,8 @@
15
15
  "lodash": "4.17.21",
16
16
  "@babel/runtime": "7.12.18",
17
17
  "core-js": "^3.0.0",
18
- "@teambit/cli": "0.0.385",
19
- "@teambit/logger": "0.0.470"
18
+ "@teambit/cli": "0.0.386",
19
+ "@teambit/logger": "0.0.471"
20
20
  },
21
21
  "devDependencies": {
22
22
  "@types/express": "4.17.9",
@@ -29,7 +29,7 @@
29
29
  "@types/node": "12.20.4"
30
30
  },
31
31
  "peerDependencies": {
32
- "@teambit/legacy": "1.0.171",
32
+ "@teambit/legacy": "1.0.172",
33
33
  "react-dom": "^16.8.0 || ^17.0.0",
34
34
  "react": "^16.8.0 || ^17.0.0"
35
35
  },
@@ -57,7 +57,7 @@
57
57
  "react": "-"
58
58
  },
59
59
  "peerDependencies": {
60
- "@teambit/legacy": "1.0.171",
60
+ "@teambit/legacy": "1.0.172",
61
61
  "react-dom": "^16.8.0 || ^17.0.0",
62
62
  "react": "^16.8.0 || ^17.0.0"
63
63
  }
package/tsconfig.json CHANGED
@@ -25,7 +25,6 @@
25
25
  "strict": true,
26
26
  "noImplicitAny": false,
27
27
  "rootDir": ".",
28
- "removeComments": true,
29
28
  "preserveConstEnums": true,
30
29
  "resolveJsonModule": true
31
30
  },