2d74ec256f
* docs: change format of module reference * description fix * update structure + comments * added new options to README * small text fix * change section ordering * change how required/optional are shown * remove optional text * docs: redesigned accordion
19 lines
1.9 KiB
Plaintext
19 lines
1.9 KiB
Plaintext
---
|
|
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":"","children":[]}]} />
|
|
|
|
## Properties
|
|
|
|
<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` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","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":"","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":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","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 `SoftDeletableEntity` class.","optional":true,"defaultValue":"","children":[]}]} />
|