git.r.bdr.sh - rbdr/forum/blob - doc/README.md

   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
  29 The Forum class is the main entry point for the backend application.
  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
  39 Initializes the application and starts listening. Also prints a
  40 nice robotic banner with information.
  41
  42 **Kind**: instance method of [<code>Forum</code>](#module_Forum)
  43 <a name="tForumBackendConfiguration"></a>
  44
  45 ## tForumBackendConfiguration : <code>object</code>
  46
  47 The main configuration object for the Forum backend. It will be used to
  48 initialize all of the sub-components. It can extend any property of
  49 the forum object.
  50
  51 **Kind**: global typedef
  52 **Properties**
  53
  54 | Name              | Type                                                             | Default                         | Description                                                      |
  55 | ----------------- | ---------------------------------------------------------------- | ------------------------------- | ---------------------------------------------------------------- |
  56 | [port]            | <code>number</code>                                              | <code>1978</code>               | the port where the app will listen on                            |
  57 | [staticDirectory] | <code>string</code>                                              | <code>&quot;static&quot;</code> | the path, relative to the project root, where static assets live |
  58 | [ttl]             | <code>number</code>                                              | <code>180</code>                | the time in seconds that posts remain alive                      |
  59 | rethinkDB         | [<code>tRethinkDBConfiguration</code>](#tRethinkDBConfiguration) |                                 | the configuration to connect to the rethinkDB server             |
  60 | jwt               | [<code>tJWTConfiguration</code>](#tJWTConfiguration)             |                                 | the configuration for the JWT authentication                     |
  61
  62 <a name="tJWTConfiguration"></a>
  63
  64 ## tJWTConfiguration : <code>object</code>
  65
  66 Configures the behavior of the JWT token.
  67
  68 **Kind**: global typedef
  69 **Properties**
  70
  71 | Name       | Type                | Default            | Description                        |
  72 | ---------- | ------------------- | ------------------ | ---------------------------------- |
  73 | [duration] | <code>number</code> | <code>86400</code> | the duration of the JWT in seconds |
  74 | secret     | <code>string</code> |                    | the secret used to sign the JWT    |
  75
  76 <a name="tRethinkDBConfiguration"></a>
  77
  78 ## tRethinkDBConfiguration : <code>object</code>
  79
  80 Information required to connect to the rethinkDB server
  81
  82 **Kind**: global typedef
  83 **Properties**
  84
  85 | Name   | Type                | Default           | Description                              |
  86 | ------ | ------------------- | ----------------- | ---------------------------------------- |
  87 | host   | <code>string</code> |                   | the location of the rethinkDB host       |
  88 | [post] | <code>string</code> | <code>6379</code> | port where rethinkDB server is listening |