diff options
| author | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2022-05-01 09:43:38 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2022-05-01 09:43:38 +0200 |
| commit | 7b66f8a69c747932118a3e81f50c69258200d1e5 (patch) | |
| tree | 077137d0c8cf796f81de14548ec9cb5757f400fb /doc | |
| parent | d1d7a9908ee29ccc1b5d569f559e8721b80fb8d5 (diff) | |
Remove outdated docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 88 |
1 files changed, 0 insertions, 88 deletions
diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index d3119e0..0000000 --- a/doc/README.md +++ /dev/null @@ -1,88 +0,0 @@ -## Modules - -<dl> -<dt><a href="#module_Forum">Forum</a></dt> -<dd><p>The Forum class is the main entry point for the backend application.</p> -</dd> -</dl> - -## Typedefs - -<dl> -<dt><a href="#tForumBackendConfiguration">tForumBackendConfiguration</a> : <code>object</code></dt> -<dd><p>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.</p> -</dd> -<dt><a href="#tJWTConfiguration">tJWTConfiguration</a> : <code>object</code></dt> -<dd><p>Configures the behavior of the JWT token.</p> -</dd> -<dt><a href="#tRethinkDBConfiguration">tRethinkDBConfiguration</a> : <code>object</code></dt> -<dd><p>Information required to connect to the rethinkDB server</p> -</dd> -</dl> - -<a name="module_Forum"></a> - -## Forum - -The Forum class is the main entry point for the backend application. - -| 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. - -**Kind**: instance method of [<code>Forum</code>](#module_Forum) -<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. - -**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>"static"</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 | -| ---------- | ------------------- | ------------------ | ---------------------------------- | -| [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 | - -<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 | -| [post] | <code>string</code> | <code>6379</code> | port where rethinkDB server is listening | |