aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRuben Beltran del Rio <ruben@unlimited.pizza>2022-05-01 01:02:58 +0200
committerRuben Beltran del Rio <ruben@unlimited.pizza>2022-05-01 01:02:58 +0200
commitcac85db02ff00732cf75d473dc3411332f33d845 (patch)
tree5f244968a905eb3888434b3f60cbf05d2b652207 /doc
parenta7cf03c192470cbab13edeb1aec99e0c66dede10 (diff)
Apply formatting
Diffstat (limited to 'doc')
-rw-r--r--doc/COVERAGE.md46
-rw-r--r--doc/README.md37
2 files changed, 42 insertions, 41 deletions
diff --git a/doc/COVERAGE.md b/doc/COVERAGE.md
index dd1f5ef..09d8810 100644
--- a/doc/COVERAGE.md
+++ b/doc/COVERAGE.md
@@ -1,31 +1,29 @@
-# Code Quality Report
-Thu Nov 15 2018 01:45:42 GMT+0100 (Central European Standard Time)
-
+# Code Quality Report
+
+Thu Nov 15 2018 01:45:42 GMT+0100 (Central European Standard Time)
+
## Tests
-
+
**Application Loader**
-✔ 1) Should instantiate and start Forum on window load (18 ms)
-
-
+✔ 1) Should instantiate and start Forum on window load (18 ms)
+
1 test
0 tests failed
-0 tests skipped
-
-Test duration: 27 ms
-
-
-## Leaks
-The following global variable leaks were detected:_registeredHandlers, _eventHandlers, DOMException, NamedNodeMap, Attr, Node, Element, DocumentFragment, HTMLDocument, Document, XMLDocument, CharacterData, Text, CDATASection, ProcessingInstruction, Comment, DocumentType, DOMImplementation, NodeList, HTMLCollection, HTMLOptionsCollection, DOMStringMap, DOMTokenList, SVGAnimatedString, SVGNumber, SVGStringList, Event, CloseEvent, CustomEvent, MessageEvent, ErrorEvent, HashChangeEvent, FocusEvent, PopStateEvent, UIEvent, MouseEvent, KeyboardEvent, TouchEvent, ProgressEvent, CompositionEvent, WheelEvent, EventTarget, BarProp, Location, History, Screen, Performance, Blob, File, FileList, DOMParser, FormData, XMLHttpRequestEventTarget, XMLHttpRequestUpload, NodeIterator, TreeWalker, HTMLElement, HTMLAnchorElement, HTMLAreaElement, HTMLAudioElement, HTMLBaseElement, HTMLBodyElement, HTMLBRElement, HTMLButtonElement, HTMLCanvasElement, HTMLDataElement, HTMLDataListElement, HTMLDetailsElement, HTMLDialogElement, HTMLDirectoryElement, HTMLDivElement, HTMLDListElement, HTMLEmbedElement, HTMLFieldSetElement, HTMLFontElement, HTMLFormElement, HTMLFrameElement, HTMLFrameSetElement, HTMLHeadingElement, HTMLHeadElement, HTMLHRElement, HTMLHtmlElement, HTMLIFrameElement, HTMLImageElement, HTMLInputElement, HTMLLabelElement, HTMLLegendElement, HTMLLIElement, HTMLLinkElement, HTMLMapElement, HTMLMarqueeElement, HTMLMediaElement, HTMLMenuElement, HTMLMetaElement, HTMLMeterElement, HTMLModElement, HTMLObjectElement, HTMLOListElement, HTMLOptGroupElement, HTMLOptionElement, HTMLOutputElement, HTMLParagraphElement, HTMLParamElement, HTMLPictureElement, HTMLPreElement, HTMLProgressElement, HTMLQuoteElement, HTMLScriptElement, HTMLSelectElement, HTMLSourceElement, HTMLSpanElement, HTMLStyleElement, HTMLTableCaptionElement, HTMLTableCellElement, HTMLTableColElement, HTMLTableElement, HTMLTimeElement, HTMLTitleElement, HTMLTableRowElement, HTMLTableSectionElement, HTMLTemplateElement, HTMLTextAreaElement, HTMLTrackElement, HTMLUListElement, HTMLUnknownElement, HTMLVideoElement, SVGElement, SVGGraphicsElement, SVGSVGElement, StyleSheet, MediaList, CSSStyleSheet, CSSRule, CSSStyleRule, CSSMediaRule, CSSImportRule, CSSStyleDeclaration, StyleSheetList, XPathException, XPathExpression, XPathResult, XPathEvaluator, NodeFilter, Window, _globalProxy, _document, _sessionHistory, _virtualConsole, _runScripts, _top, _parent, _frameElement, _length, _pretendToBeVisual, length, window, frameElement, frames, self, parent, top, document, external, location, history, navigator, locationbar, menubar, personalbar, scrollbars, statusbar, toolbar, performance, screen, addEventListener, removeEventListener, dispatchEvent, __stopAllTimers, Option, Image, Audio, postMessage, atob, btoa, FileReader, WebSocket, AbortSignal, AbortController, XMLHttpRequest, stop, close, getComputedStyle, captureEvents, releaseEvents, name, devicePixelRatio, innerWidth, innerHeight, outerWidth, outerHeight, pageXOffset, pageYOffset, screenX, screenY, scrollX, scrollY, screenLeft, screenTop, alert, blur, confirm, focus, moveBy, moveTo, open, print, prompt, resizeBy, resizeTo, scroll, scrollBy, scrollTo
-
-
-## Coverage
+0 tests skipped
+
+Test duration: 27 ms
+
+## Leaks
+
+The following global variable leaks were detected:\_registeredHandlers, \_eventHandlers, DOMException, NamedNodeMap, Attr, Node, Element, DocumentFragment, HTMLDocument, Document, XMLDocument, CharacterData, Text, CDATASection, ProcessingInstruction, Comment, DocumentType, DOMImplementation, NodeList, HTMLCollection, HTMLOptionsCollection, DOMStringMap, DOMTokenList, SVGAnimatedString, SVGNumber, SVGStringList, Event, CloseEvent, CustomEvent, MessageEvent, ErrorEvent, HashChangeEvent, FocusEvent, PopStateEvent, UIEvent, MouseEvent, KeyboardEvent, TouchEvent, ProgressEvent, CompositionEvent, WheelEvent, EventTarget, BarProp, Location, History, Screen, Performance, Blob, File, FileList, DOMParser, FormData, XMLHttpRequestEventTarget, XMLHttpRequestUpload, NodeIterator, TreeWalker, HTMLElement, HTMLAnchorElement, HTMLAreaElement, HTMLAudioElement, HTMLBaseElement, HTMLBodyElement, HTMLBRElement, HTMLButtonElement, HTMLCanvasElement, HTMLDataElement, HTMLDataListElement, HTMLDetailsElement, HTMLDialogElement, HTMLDirectoryElement, HTMLDivElement, HTMLDListElement, HTMLEmbedElement, HTMLFieldSetElement, HTMLFontElement, HTMLFormElement, HTMLFrameElement, HTMLFrameSetElement, HTMLHeadingElement, HTMLHeadElement, HTMLHRElement, HTMLHtmlElement, HTMLIFrameElement, HTMLImageElement, HTMLInputElement, HTMLLabelElement, HTMLLegendElement, HTMLLIElement, HTMLLinkElement, HTMLMapElement, HTMLMarqueeElement, HTMLMediaElement, HTMLMenuElement, HTMLMetaElement, HTMLMeterElement, HTMLModElement, HTMLObjectElement, HTMLOListElement, HTMLOptGroupElement, HTMLOptionElement, HTMLOutputElement, HTMLParagraphElement, HTMLParamElement, HTMLPictureElement, HTMLPreElement, HTMLProgressElement, HTMLQuoteElement, HTMLScriptElement, HTMLSelectElement, HTMLSourceElement, HTMLSpanElement, HTMLStyleElement, HTMLTableCaptionElement, HTMLTableCellElement, HTMLTableColElement, HTMLTableElement, HTMLTimeElement, HTMLTitleElement, HTMLTableRowElement, HTMLTableSectionElement, HTMLTemplateElement, HTMLTextAreaElement, HTMLTrackElement, HTMLUListElement, HTMLUnknownElement, HTMLVideoElement, SVGElement, SVGGraphicsElement, SVGSVGElement, StyleSheet, MediaList, CSSStyleSheet, CSSRule, CSSStyleRule, CSSMediaRule, CSSImportRule, CSSStyleDeclaration, StyleSheetList, XPathException, XPathExpression, XPathResult, XPathEvaluator, NodeFilter, Window, \_globalProxy, \_document, \_sessionHistory, \_virtualConsole, \_runScripts, \_top, \_parent, \_frameElement, \_length, \_pretendToBeVisual, length, window, frameElement, frames, self, parent, top, document, external, location, history, navigator, locationbar, menubar, personalbar, scrollbars, statusbar, toolbar, performance, screen, addEventListener, removeEventListener, dispatchEvent, \_\_stopAllTimers, Option, Image, Audio, postMessage, atob, btoa, FileReader, WebSocket, AbortSignal, AbortController, XMLHttpRequest, stop, close, getComputedStyle, captureEvents, releaseEvents, name, devicePixelRatio, innerWidth, innerHeight, outerWidth, outerHeight, pageXOffset, pageYOffset, screenX, screenY, scrollX, scrollY, screenLeft, screenTop, alert, blur, confirm, focus, moveBy, moveTo, open, print, prompt, resizeBy, resizeTo, scroll, scrollBy, scrollTo
+
+## Coverage
+
Threshold: 100%
-Coverage: 0.00% (0/0)
-
-
-
-## Linting
+Coverage: 0.00% (0/0)
+
+## Linting
+
Warnings threshold: 0
Errors threshold: 0
-No issues
-
+No issues
diff --git a/doc/README.md b/doc/README.md
index f294b0f..d3119e0 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -25,16 +25,17 @@ the forum object.</p>
<a name="module_Forum"></a>
## Forum
-The Forum class is the main entry point for the backend application.
+The Forum class is the main entry point for the backend application.
-| Param | Type | Description |
-| --- | --- | --- |
+| Param | Type | Description |
+| ------ | ---------------------------------------------------------------------- | ------------------------------------------------- |
| config | [<code>tForumBackendConfiguration</code>](#tForumBackendConfiguration) | the initialization options to extend the instance |
<a name="module_Forum+run"></a>
### forum.run()
+
Initializes the application and starts listening. Also prints a
nice robotic banner with information.
@@ -42,6 +43,7 @@ nice robotic banner with information.
<a name="tForumBackendConfiguration"></a>
## tForumBackendConfiguration : <code>object</code>
+
The main configuration object for the Forum backend. It will be used to
initialize all of the sub-components. It can extend any property of
the forum object.
@@ -49,37 +51,38 @@ the forum object.
**Kind**: global typedef
**Properties**
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| [port] | <code>number</code> | <code>1978</code> | the port where the app will listen on |
-| [staticDirectory] | <code>string</code> | <code>&quot;static&quot;</code> | the path, relative to the project root, where static assets live |
-| [ttl] | <code>number</code> | <code>180</code> | the time in seconds that posts remain alive |
-| rethinkDB | [<code>tRethinkDBConfiguration</code>](#tRethinkDBConfiguration) | | the configuration to connect to the rethinkDB server |
-| jwt | [<code>tJWTConfiguration</code>](#tJWTConfiguration) | | the configuration for the JWT authentication |
+| Name | Type | Default | Description |
+| ----------------- | ---------------------------------------------------------------- | ------------------------------- | ---------------------------------------------------------------- |
+| [port] | <code>number</code> | <code>1978</code> | the port where the app will listen on |
+| [staticDirectory] | <code>string</code> | <code>&quot;static&quot;</code> | the path, relative to the project root, where static assets live |
+| [ttl] | <code>number</code> | <code>180</code> | the time in seconds that posts remain alive |
+| rethinkDB | [<code>tRethinkDBConfiguration</code>](#tRethinkDBConfiguration) | | the configuration to connect to the rethinkDB server |
+| jwt | [<code>tJWTConfiguration</code>](#tJWTConfiguration) | | the configuration for the JWT authentication |
<a name="tJWTConfiguration"></a>
## tJWTConfiguration : <code>object</code>
+
Configures the behavior of the JWT token.
**Kind**: global typedef
**Properties**
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
+| Name | Type | Default | Description |
+| ---------- | ------------------- | ------------------ | ---------------------------------- |
| [duration] | <code>number</code> | <code>86400</code> | the duration of the JWT in seconds |
-| secret | <code>string</code> | | the secret used to sign the JWT |
+| secret | <code>string</code> | | the secret used to sign the JWT |
<a name="tRethinkDBConfiguration"></a>
## tRethinkDBConfiguration : <code>object</code>
+
Information required to connect to the rethinkDB server
**Kind**: global typedef
**Properties**
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| host | <code>string</code> | | the location of the rethinkDB host |
+| Name | Type | Default | Description |
+| ------ | ------------------- | ----------------- | ---------------------------------------- |
+| host | <code>string</code> | | the location of the rethinkDB host |
| [post] | <code>string</code> | <code>6379</code> | port where rethinkDB server is listening |
-