feat: update documentation generation

Author: maniator

README.md

@@ -2,7 +2,7 @@
 
 Servable is an implementation of a "simple" observable
 
-![](https://badgen.net/bundlephobia/minzip/servable)
+![](https://badgen.net/bundlephobia/minzip/@maniator/servable)
 
 ## To install run:
 
@@ -16,4 +16,4 @@ npm i @maniator/servable --save
 
 ### Documentation
 
-The documentation is available here: https://servable.netlify.com/
+The documentation is available here: https://servable.serveside.dev/

jsdoc.json

@@ -0,0 +1,63 @@
+{
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "source": {
+        "include": [
+            "src/",
+            "./README.md"
+        ]
+    },
+    "plugins": ["plugins/markdown"],
+    "opts": {
+        "encoding": "utf8",
+        "template": "node_modules/docdash",
+        "destination": "./docs/",
+        "recurse": true,
+        "verbose": true
+    },
+    "markdown": {
+        "parser": "gfm",
+        "hardwrap": true,
+        "idInHeadings": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false,
+        "default": {
+            "outputSourceFiles": true,
+            "includeDate": false,
+            "useLongnameInNav": true
+        }
+    },
+    "docdash": {
+        "static": true,
+        "sort": true,
+        "disqus": "",
+		"openGraph": {
+			"title": "Servable",
+			"type": "website",
+			"image": "https://naftali.lubin.dev/favicon-32x32.png?v=8a370ae67443a7fd96b71aff74147006",
+			"site_name": "Servable",
+			"url": "https://servable.serveside.dev/"
+		},
+		"meta": {
+			"title": "Servable",
+			"description": "From scratch observable.",
+			"keyword": "rx, rxjs, observable, es6"
+		},
+        "search": true,
+        "collapse": true,
+        "typedefs": true,
+        "removeQuotes": "none",
+        "scripts": [],
+        "menu":{
+            "Github repo":{
+                "href":"https://github.com/maniator/servable",
+                "target":"_blank",
+                "class":"menu-item",
+                "id":"repository"
+            }
+        }
+    }
+}

package.json

@@ -13,7 +13,7 @@
     "release": "node release.js",
     "exampleDemo": "yarn build && yarn docs",
     "predocs": "rimraf docs",
-    "docs": "documentation build src/** --format html --document-exported --theme node_modules/clean-documentation-theme -g -o docs",
+    "docs": "jsdoc -c jsdoc.json",
     "serve": "npx serve"
   },
   "author": "Naftali Lubin",
@@ -33,10 +33,10 @@
     "@babel/cli": "7.14.8",
     "@babel/core": "7.15.0",
     "@babel/preset-env": "7.15.0",
-    "clean-documentation-theme": "^0.5.2",
-    "documentation": "13.2.5",
+    "docdash": "^1.2.0",
     "inquirer": "^8.1.2",
     "jest": "27.0.6",
+    "jsdoc": "^3.6.7",
     "rimraf": "^3.0.2",
     "rollup": "2.56.0",
     "rollup-plugin-babel": "4.4.0",

src/observables.js

@@ -1,3 +1,7 @@
+/**
+ * @namespace observables
+ */
+
 export * from './observables/ajax';
 export * from './observables/fromEvent';
 export * from './observables/fromPromise';

src/observables/ajax.js

@@ -2,6 +2,7 @@ import { Observable } from '../Observable';
 
 /**
  * @private
+ * 
  * @param {XMLHttpRequest} xhr
  * @returns {*}
  */
@@ -23,11 +24,13 @@ function checkStatus (xhr) {
 
 /**
  * Make a cancellable XHR request
- *
+ * 
+ * @memberof observables
+ * 
  * @param {string} url
  * @param {string} [method]
  * @param {*} [requestData]
- * @param {{name: string, value: string}[]} [headers]
+ * @param {Array.<{name: string, value: string}>} [headers]
  *
  * @returns {Observable}
  */

src/observables/fromEvent.js

@@ -5,7 +5,10 @@ import { makeHot } from '../utilities/makeHot';
  * Will create an observable that will listen for an event on a DOM element
  *
  * Utilizes the [`makeHot`](#makehot) method so that the event does not get reattached on every subscription
- *
+ * 
+ * @memberof observables
+ * 
+ * 
  * @param {string} eventName
  * @param {Element} element
  * @param {Function} [mapCallback]

src/observables/fromPromise.js

@@ -3,6 +3,8 @@ import { isPromise } from '../utilities';
 
 /**
  * Turns a promise into an observable that emits the value of the promise and then completes
+ * 
+ * @memberof observables
  *
  * @param {Promise} promise
  * @returns {Observable}

src/observables/interval.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Creates an interval that will count on every interval tick
+ * 
+ * @memberof observables
  *
  * @param {Number} time in milliseconds to output the interval count
  * @param {Number} [start] number to start the interval count at

src/observables/of.js

@@ -2,8 +2,10 @@ import { Observable } from '../Observable';
 
 /**
  * Takes any number of arguments and outputs them in order in an Observable stream
- *
- * @param {*[]} args
+ * 
+ * @memberof observables
+ * 
+ * @param {Array.<*>} args
  * @returns {Observable}
  */
 export const of = function (...args) {

src/observables/range.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Output a range of numbers to an Observable stream
+ * 
+ * @memberof observables
  *
  * @param {Number} [start]
  * @param {Number} end

src/operators.js

@@ -1,3 +1,7 @@
+/**
+ * @namespace operators
+ */
+
 export * from './operators/map';
 export * from './operators/filter';
 export * from './operators/delay';

src/operators/average.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Takes an average of everything coming into the event stream until it completes
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @returns {Observable}

src/operators/combine.js

@@ -8,6 +8,8 @@ const argsCallback = function () { return Array.from(arguments); };
 /**
  * combines multiple observables at the same time.
  * it will only call the observer's next function when all observables have emitted at least one value
+ * 
+ * @memberof operators
  *
  * @param {Observable[]} sources$
  * @param {Function} combineCallback

src/operators/concat.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Concatenate any number of observables together
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Observable} nextSource$

src/operators/count.js

@@ -3,6 +3,8 @@ import { filter } from './filter';
 
 /**
  * Counts the number of values coming into the stream on complete
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} [countCallback] a function to use to filter out values that you do not wish to count

src/operators/debounceTime.js

@@ -4,6 +4,8 @@ import { passThroughNext } from './passThroughNext';
 /**
  * Debounces values that will be sent down the stream.
  * Will only output values if there has not been any new values in the past time interval passed
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Number} time amount of time in milliseconds

src/operators/delay.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Will delay output from the observable until a specific time interval has passed
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Number} time amount of time in milliseconds

src/operators/do.js

@@ -3,6 +3,8 @@ import { passThroughNext } from './passThroughNext';
 
 /**
  * Will run some callback before passing the current value to the subscription
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} runCallback

src/operators/filter.js

@@ -3,6 +3,8 @@ import { passThroughNext } from './passThroughNext';
 
 /**
  * Will filter out values that you do not want to subscribe to
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} filterCallback

src/operators/first.js

@@ -4,6 +4,8 @@ import { take } from './take';
 /**
  * Will take the first value from the observable and then complete
  * This is an alias for `take(obs$, 1, callback)`
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} [filterCallback] filter out values before taking the first one

src/operators/flatMap.js

@@ -4,6 +4,8 @@ import { onSubscriptionsComplete } from '../utilities/onSubscriptionsComplete';
 
 /**
  * Same as `map(obs$, mapCallback)` but will take the value of the callback and turn it from an observable to a value
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} mapCallback

src/operators/map.js

@@ -3,6 +3,8 @@ import { passThroughNext } from './passThroughNext';
 
 /**
  * Will map each value to a new value using the callback
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} mapCallback

src/operators/max.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Will result in the maximum value passed to the observer then will complete
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @returns {Observable}

src/operators/merge.js

@@ -3,6 +3,8 @@ import { onSubscriptionsComplete } from '../utilities/onSubscriptionsComplete';
 
 /**
  * Will merge any number of observables into one observable stream
+ * 
+ * @memberof operators
  *
  * @param {Observable[]} sources$
  * @returns {Observable}

src/operators/min.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Will result in the minimum value passed to the observer then will complete
+ * 
+ * @memberof operators
  *
  * @param source$
  * @returns {Observable}

src/operators/reduce.js

@@ -4,6 +4,8 @@ import { scan } from './scan';
 /**
  * _Sort of_ the same way that Array.reduce works, it will concatenate all of the values
  * passing through an Observable event stream with a given scanCallback
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} scanCallback

src/operators/scan.js

@@ -1,6 +1,8 @@
 import { Observable } from '../Observable';
 
 /**
+ * @memberof operators
+ * 
  * @param {Observable} source$
  * @param {Function} scanCallback
  * @param {*} [startValue]

src/operators/sum.js

@@ -3,6 +3,8 @@ import { reduce } from './reduce';
 
 /**
  * Sums all the values of an observable upon completion
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  */

src/operators/switchMap.js

@@ -5,6 +5,8 @@ import { passThroughNextObservable } from './passThroughNextObservable';
  * The value from the mapCallback is an observable and if another value comes through the previous observable is cancelled
  * <br />
  * This is useful for things like typeaheads where you dont want a request for every keypress
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Function} mapCallback

src/operators/take.js

@@ -3,6 +3,8 @@ import { passThroughNext } from './passThroughNext';
 
 /**
  * Takes a number of values that satisfy the `filterCallback` then completes
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Number} amount

src/operators/takeUntil.js

@@ -2,6 +2,8 @@ import { Observable } from '../Observable';
 
 /**
  * Takes values from the `source$` until the `takeSource$` emits one value
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @param {Observable} takeSource$

src/operators/toPromise.js

@@ -5,6 +5,8 @@ import { first } from './first';
  * Reverse of [`fromPromise`](#frompromise)
  * <br />
  * Converts an Observable to a promise, takes the first value and then completes
+ * 
+ * @memberof operators
  *
  * @param {Observable} source$
  * @returns {Promise<*>}

src/operators/zip.js

@@ -9,6 +9,8 @@ const startIndex = {
 const argsCallback = function () { return Array.from(arguments); };
 
 /**
+ * @memberof operators
+ * 
  * @param {Observable} sources$
  * @param {Function} combineCallback
  * @returns {Observable}