waibu
Version:
Web Framework for Bajo
46 lines (43 loc) • 3.94 kB
Markdown
# Config Object
| Key Name | Type | Default | Description |
| ------- | ---- | ----- | ----------- |
| ```server``` | ```object``` | | |
| ```host``` | ```string``` | ```127.0.0.1``` | |
| ```port``` | ```number``` | ```7777``` | |
| ```factory``` | ```object``` | | [Fastify Server](https://fastify.dev/docs/latest/Reference/Server) factory options |
| ```trustProxy``` | ```boolean``` | ```true``` | |
| ```bodyLimit``` | ```number``` | ```10485760``` | |
| ```pluginTimeout``` | ```number``` | ```30000``` | |
| ```deferLog``` | ```boolean``` | ```false``` | Set ```true``` to defer log at Fastify onResponse |
| ```prefixVirtual``` | ```string``` | ```~``` | Virtual route prefix to use |
| ```printRoutes``` | ```boolean``` | ```true``` | Print routes on startup |
| ```cors``` | ```object``` | | Defaults to [Fastify Cors](https://github.com/fastify/fastify-cors) options |
| ```compress``` | ```object``` | | Defaults to [Fastify Compress](https://github.com/fastify/fastify-compress) options |
| ```helmet``` | ```object``` | | Defaults to [Fastify Helmet](https://github.com/fastify/fastify-helmet) options |
| ```rateLimit``` | ```object``` | | Defaults to [Fastify Rate Limit](https://github.com/fastify/fastify-rate-limit) options |
| ```multipart``` | ```object``` | | Defaults to [Fastify Multipart](https://github.com/fastify/fastify-multipart) options |
| ```attachFieldsToBody``` | ```boolean``` | ```true``` | |
| ```limits``` | ```object``` | | |
| ```parts``` | ```number``` | ```100``` | |
| ```noIcon``` | ```boolean``` | ```true``` | |
| ```underPressure``` | ```object``` | | Defaults to [Fastify Under Pressure](https://github.com/fastify/fastify-under-pressure) options |
| ```forwardOpts``` | ```object``` | | Options for route forward |
| ```disableRequestLogging``` | ```boolean``` | ```true``` | |
| ```undici``` | ```object``` | | Defaults to [Undici](https://github.com/nodejs/undici) options |
| ```connections``` | ```number``` | ```128``` | |
| ```pipelining``` | ```number``` | ```1``` | |
| ```keepAliveTimeout``` | ```number``` | ```60000``` | |
| ```tls``` | ```object``` | | |
| ```rejectUnauthorized``` | ```boolean``` | ```false``` | |
| ```qsKey``` | ```object``` | | Query string keys used to build model/database filter |
| ```bbox``` | ```string``` | ```bbox``` | Key to use for bbox setting |
| ```bboxLatField``` | ```string``` | ```bboxLatField``` | Key to use to determine bbox's latitude |
| ```bboxLngField``` | ```string``` | ```bboxLngField``` | Key to use to determine bbox's longitude |
| ```query``` | ```string``` | ```query``` | Key to use for query |
| ```match``` | ```string``` | ```match``` | Key to enter fulltext matching |
| ```skip``` | ```string``` | ```skip``` | Key to skip page |
| ```page``` | ```string``` | ```page``` | Key to go to page number |
| ```limit``` | ```string``` | ```limit``` | Key to limit model per page |
| ```sort``` | ```string``` | ```sort``` | Key to sort model |
| ```fields``` | ```string``` | ```fields``` | Key to show model fields |
| ```lang``` | ```string``` | ```lang``` | Key for language setting |