chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
378ca1b36e
commit
daea35fe73
@@ -0,0 +1,94 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: FindConfig<Entity\>
|
||||
|
||||
[internal](../modules/internal-8.md).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
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `Entity` |
|
||||
|
||||
## Properties
|
||||
|
||||
### order
|
||||
|
||||
• `Optional` **order**: `Object`
|
||||
|
||||
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.
|
||||
|
||||
#### Index signature
|
||||
|
||||
▪ [K: `string`]: ``"ASC"`` \| ``"DESC"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/types/dist/common/common.d.ts:45
|
||||
|
||||
___
|
||||
|
||||
### relations
|
||||
|
||||
• `Optional` **relations**: `string`[]
|
||||
|
||||
An array of strings, each being relation names of the entity to retrieve in the result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/types/dist/common/common.d.ts:44
|
||||
|
||||
___
|
||||
|
||||
### select
|
||||
|
||||
• `Optional` **select**: (`string` \| keyof `Entity`)[]
|
||||
|
||||
An array of strings, each being attribute names of the entity to retrieve in the result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/types/dist/common/common.d.ts:41
|
||||
|
||||
___
|
||||
|
||||
### skip
|
||||
|
||||
• `Optional` **skip**: `number`
|
||||
|
||||
A number indicating the number of records to skip before retrieving the results.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/types/dist/common/common.d.ts:42
|
||||
|
||||
___
|
||||
|
||||
### take
|
||||
|
||||
• `Optional` **take**: `number`
|
||||
|
||||
A number indicating the number of records to return in the result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/types/dist/common/common.d.ts:43
|
||||
|
||||
___
|
||||
|
||||
### withDeleted
|
||||
|
||||
• `Optional` **withDeleted**: `boolean`
|
||||
|
||||
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.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/types/dist/common/common.d.ts:48
|
||||
Reference in New Issue
Block a user