- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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#
Entity
objectOptionalselect
(string | keyof Entity)[]OptionalAn array of strings, each being attribute names of the entity to retrieve in the result.
skip
null | numberOptionalA number indicating the number of records to skip before retrieving the results.
take
null | numberOptionalA number indicating the number of records to return in the result.
relations
string[]OptionalAn array of strings, each being relation names of the entity to retrieve in the result.
order
Record<string, "ASC" \| "DESC" \| string & object>OptionalAn 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.withDeleted
booleanOptionalA boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the
SoftDeletableEntity
class.filters
Record<string, any>OptionalEnable ORM specific defined filters
options
Record<string, any>OptionalEnable ORM specific defined options
Was this page helpful?