Configuration
Below defines the configuration options.
| Option | Description | Type | Default |
|---|---|---|---|
port |
The port the framework should listen on. | number |
3000 |
host |
The hostname the framework should listen on. | string |
localhost |
database |
Whether to enable database functionality. |
true/false
|
false |
databases |
An array of databases to use (see databases section.) | Array |
[] |
websocket |
Whether or not to enable the WebSocket server. |
true/false
|
false |
websocket_path |
The path that the WebSocket server should listen on. | string |
/ws |
websocket_access |
The type of access to controllers that the WebSockets can access. |
partial/full
|
partial |
state_flush_period |
The schedule in seconds for when to flush the state to permanent storage. | number |
30 |
state_flush_file |
Whether to use file or database storage type. |
file/database
|
file |
The databases option should contain an array of objects and each object should follow the below.
Note: you must specify at least ONE default driver.
| Option | Description | Type | Default | Optional/Required |
|---|---|---|---|---|
unique |
The unique database name, this is used to define custom databases for models. | string |
N/A | Required |
host |
The hostname of the database to connect to. | string |
localhost |
Optional |
port |
The port of the database to connect to. | number |
27017 (Mongo)/3306 (MySQL)
|
Optional |
name |
The name of the database or collection to use. | string |
undefined |
Optional |
driver |
Which driver this database should use. | string |
N/A | Required |
default |
Whether this database is the default to use. | boolean |
false |
Optional |
customDriver |
Whether the defined driver is custom. | boolean |
false |
Optional |
