From cac85db02ff00732cf75d473dc3411332f33d845 Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Sun, 1 May 2022 01:02:58 +0200 Subject: Apply formatting --- doc/README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) (limited to 'doc/README.md') 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.

## 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 | [tForumBackendConfiguration](#tForumBackendConfiguration) | the initialization options to extend the instance | ### 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. ## tForumBackendConfiguration : object + 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] | number | 1978 | the port where the app will listen on | -| [staticDirectory] | string | "static" | the path, relative to the project root, where static assets live | -| [ttl] | number | 180 | the time in seconds that posts remain alive | -| rethinkDB | [tRethinkDBConfiguration](#tRethinkDBConfiguration) | | the configuration to connect to the rethinkDB server | -| jwt | [tJWTConfiguration](#tJWTConfiguration) | | the configuration for the JWT authentication | +| Name | Type | Default | Description | +| ----------------- | ---------------------------------------------------------------- | ------------------------------- | ---------------------------------------------------------------- | +| [port] | number | 1978 | the port where the app will listen on | +| [staticDirectory] | string | "static" | the path, relative to the project root, where static assets live | +| [ttl] | number | 180 | the time in seconds that posts remain alive | +| rethinkDB | [tRethinkDBConfiguration](#tRethinkDBConfiguration) | | the configuration to connect to the rethinkDB server | +| jwt | [tJWTConfiguration](#tJWTConfiguration) | | the configuration for the JWT authentication | ## tJWTConfiguration : object + Configures the behavior of the JWT token. **Kind**: global typedef **Properties** -| Name | Type | Default | Description | -| --- | --- | --- | --- | +| Name | Type | Default | Description | +| ---------- | ------------------- | ------------------ | ---------------------------------- | | [duration] | number | 86400 | the duration of the JWT in seconds | -| secret | string | | the secret used to sign the JWT | +| secret | string | | the secret used to sign the JWT | ## tRethinkDBConfiguration : object + Information required to connect to the rethinkDB server **Kind**: global typedef **Properties** -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| host | string | | the location of the rethinkDB host | +| Name | Type | Default | Description | +| ------ | ------------------- | ----------------- | ---------------------------------------- | +| host | string | | the location of the rethinkDB host | | [post] | string | 6379 | port where rethinkDB server is listening | - -- cgit