diff options
| author | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2022-05-01 01:02:58 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2022-05-01 01:02:58 +0200 |
| commit | cac85db02ff00732cf75d473dc3411332f33d845 (patch) | |
| tree | 5f244968a905eb3888434b3f60cbf05d2b652207 /doc/README.md | |
| parent | a7cf03c192470cbab13edeb1aec99e0c66dede10 (diff) | |
Apply formatting
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 37 |
1 files changed, 20 insertions, 17 deletions
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>"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 | +| 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 | -| --- | --- | --- | --- | +| 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 | - |