Merge fd47cc9 into 0c181e7

Author: anacromaniac

.gitignore

@@ -39,6 +39,9 @@ jspm_packages/
 # Distribution files
 dist/
 
+# Project generated documentation
+docs/
+
 # TypeScript v1 declaration files
 typings/
 

lib/utils/highestPossible.ts

@@ -1 +1 @@
-export const highestPossible = ((num: number, limit: number) => limit <= num ? limit : num );
+export const highestPossible = (num: number, limit: number) => limit <= num ? limit : num;

package-lock.json

@@ -8,6 +8,7 @@
     "test": "jest --config jest.config.json && cat ./coverage/lcov.info | coveralls",
     "lint": "tslint -c tslint.json 'src/**/*.ts'",
     "build": "tsc",
+    "docs": "typedoc --options ./typedocconfig.ts",
     "prepublishOnly": "npm install && npm run build"
   },
   "repository": {
@@ -40,6 +41,7 @@
     "regenerator-runtime": "^0.12.1",
     "ts-jest": "^23.10.4",
     "tslint": "^5.11.0",
+    "typedoc": "^0.13.0",
     "typescript": "^3.1.6"
   },
   "dependencies": {

package.json

@@ -0,0 +1,20 @@
+module.exports = {
+    exclude: "**/*.spec.ts",
+    excludeExternals: true,
+    excludePrivate: true,
+    excludeProtected: true,
+    ignoreCompilerErrors: true,
+    includeDeclarations: true,
+    listInvalidSymbolLinks: true,
+    mode: "file",
+    name: "SLMF-HTTP-connector",
+    out: "./docs",
+    plugin: "none",
+    readme: "none",
+    src: [
+      "./index.ts",
+      "./lib/",
+    ],
+    target: "ES5",
+    tsconfig: "tsconfig.json",
+  };