chore: add info on generate types

JasonShin · Nov 4, 2023 · a0cca14 · a0cca14
1 parent ad17639
commit a0cca14
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/book/src/reference-guide/2.1.configs-file-based.md b/book/src/reference-guide/2.1.configs-file-based.md
@@ -67,6 +67,18 @@ Then running `sqlx-ts` compile time query checker along with the
 
 ### generate_types
 
+```json
+{
+  "generateTypes: {
+    enabled: true|false,
+    convertToCamelCaseColumnName: true|false
+  },
+  "connections": {
+    ...
+  }
+}
+```
+
 Support for configuration of generate types operations.
-- `enabled`: enables type generation via config
-- `convertToCamelCaseColumnName`: when generating field name based on table's column name, it will automatically cast to camelCase in TypeScript
+- `enabled` (default: false): enables type generation via config
+- `convertToCamelCaseColumnName` (default: true): when generating field name based on table's column name, it will automatically cast to camelCase in TypeScript