improved docs (#89)

README.md

@@ -18,8 +18,8 @@ Some utilities for the development of express applications with Inversify.
 
 You can install `inversify-express-utils` using npm:
 
-```
-$ npm install inversify inversify-express-utils reflect-metadata --save
+```sh
+npm install inversify inversify-express-utils reflect-metadata --save
 ```
 
 The `inversify-express-utils` type definitions are included in the npm module and require TypeScript 2.0.
@@ -524,12 +524,14 @@ console.log(prettyjson.render({ routes: routeInfo }));
 // ...
 ```
 
+> :warning: Please ensure that you invoke `getRouteInfo` after invoking `server.build()`!
+
 The output formatter by `prettyjson` looks as follows:
 
 ```txt
 routes:
   -
-    controller: Symbol(OrderController)
+    controller: OrderController
     endpoints:
       -
         route: GET /api/order/
@@ -540,7 +542,7 @@ routes:
         route:
           - @requestParam id
   -
-    controller: Symbol(UserController)
+    controller: UserController
     endpoints:
       -
         route: GET /api/user/

package.json

@@ -1,6 +1,6 @@
 {
   "name": "inversify-express-utils",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "Some utilities for the development of express applications with Inversify",
   "main": "lib/index.js",
   "jsnext:main": "es/index.js",

src/debug.ts

@@ -1,7 +1,7 @@
 import { interfaces as inversifyInterfaces } from "inversify";
 import { BaseHttpController } from "./base_http_controller";
 import { interfaces } from "./interfaces";
-import { PARAMETER_TYPE } from "./constants";
+import { PARAMETER_TYPE, TYPE } from "./constants";
 import {
     getControllersFromContainer,
     getControllerMetadata,
@@ -15,7 +15,7 @@ export function getRouteInfo(container: inversifyInterfaces.Container) {
 
     const info = raw.map(r => {
 
-        const controllerId = Symbol.for(r.controllerMetadata.target.name).toString();
+        const controllerId = r.controllerMetadata.target.name;
 
         const endpoints = r.methodMetadata.map(m => {
 

test/debug.test.ts

@@ -64,8 +64,8 @@ describe("Debug utils", () => {
         }
 
         const TYPES = {
-            OrderController: Symbol.for(OrderController.name).toString(),
-            UserController: Symbol.for(UserController.name).toString()
+            OrderController: OrderController.name,
+            UserController: UserController.name
         };
 
         let server = new InversifyExpressServer(container);