Merge pull request #4 from jfet97/feature/typedoc

Feature/typedoc

Author: jfet97

.travis.yml

@@ -2,10 +2,13 @@ language: node_js
 
 node_js:
  - "10"
+
 script:
  - npm run test:ci
 
 branches:
   only:
     - master
+
+
 

docs/.vuepress/config.js

@@ -12,6 +12,10 @@ module.exports = {
                 text: 'Guide',
                 link: '/guide/',
             },
+            {
+                text: 'API',
+                link: 'https://jfet97.github.io/csp/api/',
+            },
             {
                 text: 'GitHub',
                 link: 'https://github.com/jfet97/csp',

docs/README.md

@@ -5,4 +5,6 @@ actionText: Get Started →
 actionLink: /guide/
 footer: MIT Licensed | Copyright © 2019-present Andrea Simone Costa
 ---
-
+::: warning
+Node v10.0.0 or greater is required.
+:::

docs/guide/operators.md

@@ -81,7 +81,7 @@ const result2 = await resCh.take(); // will receive 3
 
 `source.map(value => value)` -> `channel`
 
-The `map` method takes a `mapper` function and returns a new channel. Each value inserted into the `source` will be passed to the `mapper` function and the result of each computation will be inserted into the resulting `channel`.
+The `map` method takes a `mapper` function and returns a new channel. Each value inserted into the `source` will be passed to the `mapper` function and the result of each computation will be inserted into the returned `channel`.
 
 ```js
 require("@jfet97/csp/dist/operators/map");

package-lock.json

@@ -9,9 +9,10 @@
     "dev": "tsc -w -p tsconfig.build.json",
     "test": "jest --watchAll --coverage",
     "test:ci": "jest",
-    "deploy": "gh-pages -d /docs/.vuepress/dist",
     "docs:dev": "vuepress dev docs",
-    "docs:build": "vuepress build docs"
+    "docs:build": "vuepress build docs",
+    "api:build": "typedoc",
+    "deploy": "gh-pages -d /docs/.vuepress/dist"
   },
   "files": [
     "dist"
@@ -37,8 +38,11 @@
     "jest": "^24.5.0",
     "ts-jest": "^24.0.0",
     "ts-node": "^8.0.3",
+    "typedoc": "^0.14.2",
+    "typedoc-plugin-nojekyll": "^1.0.1",
     "typescript": "^3.3.3333",
     "vuepress": "^0.14.10",
     "webpack-dev-middleware": "^3.6.0"
-  }
+  },
+  "dependencies": {}
 }