docs: enhance how references are generated (#5805)

* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
2023-12-05 15:29:41 +02:00
parent a418e6cebc
commit 892d737c1f
4358 changed files with 947876 additions and 534760 deletions
@@ -0,0 +1,81 @@
+---
+displayed_sidebar: pricingReference
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# FindConfig
+
+An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
+which provides correct typing of field names in its properties.
+
+## Type parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "Entity",
+    "type": "`object`",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  }
+]} />
+
+<ParameterTypes parameters={[
+  {
+    "name": "order",
+    "type": "`object`",
+    "description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "relations",
+    "type": "`string`[]",
+    "description": "An array of strings, each being relation names of the entity to retrieve in the result.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "select",
+    "type": "(`string` \\| keyof `Entity`)[]",
+    "description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "skip",
+    "type": "`null` \\| `number`",
+    "description": "A number indicating the number of records to skip before retrieving the results.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "take",
+    "type": "`null` \\| `number`",
+    "description": "A number indicating the number of records to return in the result.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "withDeleted",
+    "type": "`boolean`",
+    "description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  }
+]} />