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
objectRequiredselect
(string | keyof Entity)[]An array of strings, each being attribute names of the entity to retrieve in the result.
skip
null | numberA number indicating the number of records to skip before retrieving the results.
take
null | numberA number indicating the number of records to return in the result.
relations
string[]An array of strings, each being relation names of the entity to retrieve in the result.
order
objectAn 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
booleanA 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>Enable ORM specific defined filters
Was this section helpful?