| | 1 | ## Modules |
| | 2 | |
| | 3 | <dl> |
| | 4 | <dt><a href="#module_Forum">Forum</a></dt> |
| | 5 | <dd><p>The Forum class is the main entry point for the backend application.</p> |
| | 6 | </dd> |
| | 7 | </dl> |
| | 8 | |
| | 9 | ## Typedefs |
| | 10 | |
| | 11 | <dl> |
| | 12 | <dt><a href="#tForumBackendConfiguration">tForumBackendConfiguration</a> : <code>object</code></dt> |
| | 13 | <dd><p>The main configuration object for the Forum backend. It will be used to |
| | 14 | initialize all of the sub-components. It can extend any property of |
| | 15 | the forum object.</p> |
| | 16 | </dd> |
| | 17 | <dt><a href="#tJWTConfiguration">tJWTConfiguration</a> : <code>object</code></dt> |
| | 18 | <dd><p>Configures the behavior of the JWT token.</p> |
| | 19 | </dd> |
| | 20 | <dt><a href="#tRethinkDBConfiguration">tRethinkDBConfiguration</a> : <code>object</code></dt> |
| | 21 | <dd><p>Information required to connect to the rethinkDB server</p> |
| | 22 | </dd> |
| | 23 | </dl> |
| | 24 | |
| | 25 | <a name="module_Forum"></a> |
| | 26 | |
| | 27 | ## Forum |
| | 28 | The Forum class is the main entry point for the backend application. |
| | 29 | |
| | 30 | |
| | 31 | | Param | Type | Description | |
| | 32 | | --- | --- | --- | |
| | 33 | | config | [<code>tForumBackendConfiguration</code>](#tForumBackendConfiguration) | the initialization options to extend the instance | |
| | 34 | |
| | 35 | <a name="module_Forum+run"></a> |
| | 36 | |
| | 37 | ### forum.run() |
| | 38 | Initializes the application and starts listening. Also prints a |
| | 39 | nice robotic banner with information. |
| | 40 | |
| | 41 | **Kind**: instance method of [<code>Forum</code>](#module_Forum) |
| | 42 | <a name="tForumBackendConfiguration"></a> |
| | 43 | |
| | 44 | ## tForumBackendConfiguration : <code>object</code> |
| | 45 | The main configuration object for the Forum backend. It will be used to |
| | 46 | initialize all of the sub-components. It can extend any property of |
| | 47 | the forum object. |
| | 48 | |
| | 49 | **Kind**: global typedef |
| | 50 | **Properties** |
| | 51 | |
| | 52 | | Name | Type | Default | Description | |
| | 53 | | --- | --- | --- | --- | |
| | 54 | | [port] | <code>number</code> | <code>1978</code> | the port where the app will listen on | |
| | 55 | | [staticDirectory] | <code>string</code> | <code>"static"</code> | the path, relative to the project root, where static assets live | |
| | 56 | | [ttl] | <code>number</code> | <code>180</code> | the time in seconds that posts remain alive | |
| | 57 | | rethinkDB | [<code>tRethinkDBConfiguration</code>](#tRethinkDBConfiguration) | | the configuration to connect to the rethinkDB server | |
| | 58 | | jwt | [<code>tJWTConfiguration</code>](#tJWTConfiguration) | | the configuration for the JWT authentication | |
| | 59 | |
| | 60 | <a name="tJWTConfiguration"></a> |
| | 61 | |
| | 62 | ## tJWTConfiguration : <code>object</code> |
| | 63 | Configures the behavior of the JWT token. |
| | 64 | |
| | 65 | **Kind**: global typedef |
| | 66 | **Properties** |
| | 67 | |
| | 68 | | Name | Type | Default | Description | |
| | 69 | | --- | --- | --- | --- | |
| | 70 | | [duration] | <code>number</code> | <code>86400</code> | the duration of the JWT in seconds | |
| | 71 | | secret | <code>string</code> | | the secret used to sign the JWT | |
| | 72 | |
| | 73 | <a name="tRethinkDBConfiguration"></a> |
| | 74 | |
| | 75 | ## tRethinkDBConfiguration : <code>object</code> |
| | 76 | Information required to connect to the rethinkDB server |
| | 77 | |
| | 78 | **Kind**: global typedef |
| | 79 | **Properties** |
| | 80 | |
| | 81 | | Name | Type | Default | Description | |
| | 82 | | --- | --- | --- | --- | |
| | 83 | | host | <code>string</code> | | the location of the rethinkDB host | |
| | 84 | | [post] | <code>string</code> | <code>6379</code> | port where rethinkDB server is listening | |
| | 85 | |
git.r.bdr.sh / rbdr / forum / blame_incremental