@hichchi/nest-crud 0.0.6 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +679 -347
- package/base/base-entity.js +0 -1
- package/base/base-entity.js.map +1 -1
- package/base/base-repository.d.ts +3 -2
- package/base/base-repository.js +19 -8
- package/base/base-repository.js.map +1 -1
- package/base/base-user.entity.d.ts +59 -12
- package/base/base-user.entity.js +73 -15
- package/base/base-user.entity.js.map +1 -1
- package/crud.module.js +3 -3
- package/crud.module.js.map +1 -1
- package/decorators/entity.decorator.js +1 -1
- package/decorators/entity.decorator.js.map +1 -1
- package/decorators/page.decorator.d.ts +50 -2
- package/decorators/page.decorator.js +15 -3
- package/decorators/page.decorator.js.map +1 -1
- package/interfaces/crud-options.interfaces.d.ts +11 -3
- package/package.json +4 -4
- package/readme-top.md +5 -1
- package/responses/crud.error.responses.d.ts +22 -0
- package/responses/crud.error.responses.js +28 -0
- package/responses/crud.error.responses.js.map +1 -1
- package/services/crud.service.d.ts +61 -51
- package/services/crud.service.js +49 -41
- package/services/crud.service.js.map +1 -1
- package/types/find-conditions.type.d.ts +1 -1
package/README.md
CHANGED
|
@@ -334,7 +334,7 @@ npm install mongodb
|
|
|
334
334
|
### 🏗️ Ready-to-Use Base Classes
|
|
335
335
|
|
|
336
336
|
- 🗂️ **BaseEntity** - Pre-configured entity with common fields (id, createdAt, updatedAt, etc.)
|
|
337
|
-
- 👤 **BaseUserEntity** - Extended entity with user-specific fields and relationships
|
|
337
|
+
- 👤 **BaseUserEntity** - Extended entity with user-specific fields, role/tenant references, and relationships
|
|
338
338
|
- 🔧 **BaseEntityExtension** - Flexible entity extension for custom requirements
|
|
339
339
|
- 📦 **BaseRepository** - Comprehensive repository with advanced CRUD operations
|
|
340
340
|
|
|
@@ -421,6 +421,10 @@ export class UserEntity extends HichchiUserEntity {
|
|
|
421
421
|
// - fullName: string (automatically generated)
|
|
422
422
|
// - email: string | null
|
|
423
423
|
// - username: string | null
|
|
424
|
+
// - role: string | Role | null
|
|
425
|
+
// - roleId: EntityId | null
|
|
426
|
+
// - tenant: TenantSlug | Tenant | null
|
|
427
|
+
// - tenantId: EntityId | null
|
|
424
428
|
// Plus all BaseEntity fields
|
|
425
429
|
|
|
426
430
|
// Overriding email as only string if
|
|
@@ -1503,7 +1507,7 @@ Complete technical reference for all classes, interfaces, methods, and types in
|
|
|
1503
1507
|
|
|
1504
1508
|
### BaseEntity
|
|
1505
1509
|
|
|
1506
|
-
Defined in: [libs/nest-crud/src/base/base-entity.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
1510
|
+
Defined in: [libs/nest-crud/src/base/base-entity.ts:51](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L51)
|
|
1507
1511
|
|
|
1508
1512
|
Base entity class that provides common fields and functionality for all entities
|
|
1509
1513
|
|
|
@@ -1565,7 +1569,7 @@ new BaseEntity(): BaseEntity;
|
|
|
1565
1569
|
protected optional afterLoad(): void;
|
|
1566
1570
|
```
|
|
1567
1571
|
|
|
1568
|
-
Defined in: [libs/nest-crud/src/base/base-entity.ts:156](https://github.com/hichchidev/hichchi/blob/
|
|
1572
|
+
Defined in: [libs/nest-crud/src/base/base-entity.ts:156](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L156)
|
|
1569
1573
|
|
|
1570
1574
|
Lifecycle hook that runs after an entity is loaded from the database
|
|
1571
1575
|
|
|
@@ -1615,7 +1619,7 @@ It is not nullable and cannot be changed after creation.
|
|
|
1615
1619
|
</td>
|
|
1616
1620
|
<td>
|
|
1617
1621
|
|
|
1618
|
-
[libs/nest-crud/src/base/base-entity.ts:68](https://github.com/hichchidev/hichchi/blob/
|
|
1622
|
+
[libs/nest-crud/src/base/base-entity.ts:68](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L68)
|
|
1619
1623
|
|
|
1620
1624
|
</td>
|
|
1621
1625
|
</tr>
|
|
@@ -1640,7 +1644,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
1640
1644
|
</td>
|
|
1641
1645
|
<td>
|
|
1642
1646
|
|
|
1643
|
-
[libs/nest-crud/src/base/base-entity.ts:105](https://github.com/hichchidev/hichchi/blob/
|
|
1647
|
+
[libs/nest-crud/src/base/base-entity.ts:105](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L105)
|
|
1644
1648
|
|
|
1645
1649
|
</td>
|
|
1646
1650
|
</tr>
|
|
@@ -1665,7 +1669,7 @@ It is used for the foreign key relationship with the createdBy field.
|
|
|
1665
1669
|
</td>
|
|
1666
1670
|
<td>
|
|
1667
1671
|
|
|
1668
|
-
[libs/nest-crud/src/base/base-entity.ts:95](https://github.com/hichchidev/hichchi/blob/
|
|
1672
|
+
[libs/nest-crud/src/base/base-entity.ts:95](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L95)
|
|
1669
1673
|
|
|
1670
1674
|
</td>
|
|
1671
1675
|
</tr>
|
|
@@ -1690,7 +1694,7 @@ soft delete functionality. When this field has a value, the entity is considered
|
|
|
1690
1694
|
</td>
|
|
1691
1695
|
<td>
|
|
1692
1696
|
|
|
1693
|
-
[libs/nest-crud/src/base/base-entity.ts:86](https://github.com/hichchidev/hichchi/blob/
|
|
1697
|
+
[libs/nest-crud/src/base/base-entity.ts:86](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L86)
|
|
1694
1698
|
|
|
1695
1699
|
</td>
|
|
1696
1700
|
</tr>
|
|
@@ -1715,7 +1719,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
1715
1719
|
</td>
|
|
1716
1720
|
<td>
|
|
1717
1721
|
|
|
1718
|
-
[libs/nest-crud/src/base/base-entity.ts:143](https://github.com/hichchidev/hichchi/blob/
|
|
1722
|
+
[libs/nest-crud/src/base/base-entity.ts:143](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L143)
|
|
1719
1723
|
|
|
1720
1724
|
</td>
|
|
1721
1725
|
</tr>
|
|
@@ -1740,7 +1744,7 @@ It is used for the foreign key relationship with the deletedBy field.
|
|
|
1740
1744
|
</td>
|
|
1741
1745
|
<td>
|
|
1742
1746
|
|
|
1743
|
-
[libs/nest-crud/src/base/base-entity.ts:133](https://github.com/hichchidev/hichchi/blob/
|
|
1747
|
+
[libs/nest-crud/src/base/base-entity.ts:133](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L133)
|
|
1744
1748
|
|
|
1745
1749
|
</td>
|
|
1746
1750
|
</tr>
|
|
@@ -1765,7 +1769,7 @@ It serves as the primary key for the entity in the database.
|
|
|
1765
1769
|
</td>
|
|
1766
1770
|
<td>
|
|
1767
1771
|
|
|
1768
|
-
[libs/nest-crud/src/base/base-entity.ts:59](https://github.com/hichchidev/hichchi/blob/
|
|
1772
|
+
[libs/nest-crud/src/base/base-entity.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L59)
|
|
1769
1773
|
|
|
1770
1774
|
</td>
|
|
1771
1775
|
</tr>
|
|
@@ -1790,7 +1794,7 @@ and updated whenever the entity is modified.
|
|
|
1790
1794
|
</td>
|
|
1791
1795
|
<td>
|
|
1792
1796
|
|
|
1793
|
-
[libs/nest-crud/src/base/base-entity.ts:77](https://github.com/hichchidev/hichchi/blob/
|
|
1797
|
+
[libs/nest-crud/src/base/base-entity.ts:77](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L77)
|
|
1794
1798
|
|
|
1795
1799
|
</td>
|
|
1796
1800
|
</tr>
|
|
@@ -1815,7 +1819,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
1815
1819
|
</td>
|
|
1816
1820
|
<td>
|
|
1817
1821
|
|
|
1818
|
-
[libs/nest-crud/src/base/base-entity.ts:124](https://github.com/hichchidev/hichchi/blob/
|
|
1822
|
+
[libs/nest-crud/src/base/base-entity.ts:124](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L124)
|
|
1819
1823
|
|
|
1820
1824
|
</td>
|
|
1821
1825
|
</tr>
|
|
@@ -1840,7 +1844,7 @@ It is used for the foreign key relationship with the updatedBy field.
|
|
|
1840
1844
|
</td>
|
|
1841
1845
|
<td>
|
|
1842
1846
|
|
|
1843
|
-
[libs/nest-crud/src/base/base-entity.ts:114](https://github.com/hichchidev/hichchi/blob/
|
|
1847
|
+
[libs/nest-crud/src/base/base-entity.ts:114](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L114)
|
|
1844
1848
|
|
|
1845
1849
|
</td>
|
|
1846
1850
|
</tr>
|
|
@@ -1851,7 +1855,7 @@ It is used for the foreign key relationship with the updatedBy field.
|
|
|
1851
1855
|
|
|
1852
1856
|
### BaseEntityExtension
|
|
1853
1857
|
|
|
1854
|
-
Defined in: [libs/nest-crud/src/base/base-entity-extension.ts:43](https://github.com/hichchidev/hichchi/blob/
|
|
1858
|
+
Defined in: [libs/nest-crud/src/base/base-entity-extension.ts:43](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity-extension.ts#L43)
|
|
1855
1859
|
|
|
1856
1860
|
Base entity extension class that provides a minimal entity structure
|
|
1857
1861
|
|
|
@@ -1945,7 +1949,7 @@ It serves as the primary key for the entity in the database.
|
|
|
1945
1949
|
</td>
|
|
1946
1950
|
<td>
|
|
1947
1951
|
|
|
1948
|
-
[libs/nest-crud/src/base/base-entity-extension.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
1952
|
+
[libs/nest-crud/src/base/base-entity-extension.ts:51](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity-extension.ts#L51)
|
|
1949
1953
|
|
|
1950
1954
|
</td>
|
|
1951
1955
|
</tr>
|
|
@@ -1956,7 +1960,7 @@ It serves as the primary key for the entity in the database.
|
|
|
1956
1960
|
|
|
1957
1961
|
### BaseRepository
|
|
1958
1962
|
|
|
1959
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
1963
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:98](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L98)
|
|
1960
1964
|
|
|
1961
1965
|
Base Repository Class that extends TypeORM's Repository with enhanced functionality
|
|
1962
1966
|
|
|
@@ -2065,7 +2069,7 @@ ModelExtension interface (for lightweight entity extensions).
|
|
|
2065
2069
|
get entityRepository(): Repository<Entity>;
|
|
2066
2070
|
```
|
|
2067
2071
|
|
|
2068
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2072
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:127](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L127)
|
|
2069
2073
|
|
|
2070
2074
|
Get the appropriate repository instance for the current context
|
|
2071
2075
|
|
|
@@ -2112,7 +2116,7 @@ Entity metadata of the entity current repository manages.
|
|
|
2112
2116
|
new BaseRepository<Entity>(repository): BaseRepository<Entity>;
|
|
2113
2117
|
```
|
|
2114
2118
|
|
|
2115
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2119
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:111](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L111)
|
|
2116
2120
|
|
|
2117
2121
|
Constructor for the BaseRepository
|
|
2118
2122
|
|
|
@@ -2330,7 +2334,7 @@ Useful for pagination.
|
|
|
2330
2334
|
countMany(options?): Promise<number>;
|
|
2331
2335
|
```
|
|
2332
2336
|
|
|
2333
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2337
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:770](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L770)
|
|
2334
2338
|
|
|
2335
2339
|
Count entities matching the specified criteria
|
|
2336
2340
|
|
|
@@ -2412,7 +2416,7 @@ The data to create entities with
|
|
|
2412
2416
|
create(): Entity;
|
|
2413
2417
|
```
|
|
2414
2418
|
|
|
2415
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2419
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:148](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L148)
|
|
2416
2420
|
|
|
2417
2421
|
Create a new entity instance
|
|
2418
2422
|
|
|
@@ -2447,7 +2451,7 @@ user.lastName = "Doe";
|
|
|
2447
2451
|
create<T>(entityLike): Entity;
|
|
2448
2452
|
```
|
|
2449
2453
|
|
|
2450
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2454
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:172](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L172)
|
|
2451
2455
|
|
|
2452
2456
|
Create a new entity instance with the provided data
|
|
2453
2457
|
|
|
@@ -2555,7 +2559,7 @@ const user = userRepository.create({
|
|
|
2555
2559
|
create<T>(entityLikeArray): Entity[];
|
|
2556
2560
|
```
|
|
2557
2561
|
|
|
2558
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2562
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:195](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L195)
|
|
2559
2563
|
|
|
2560
2564
|
Create multiple entity instances
|
|
2561
2565
|
|
|
@@ -2855,7 +2859,7 @@ WARNING! This method deletes ALL rows in the target table.
|
|
|
2855
2859
|
deleteById(id): Promise<DeleteResult>;
|
|
2856
2860
|
```
|
|
2857
2861
|
|
|
2858
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2862
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:671](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L671)
|
|
2859
2863
|
|
|
2860
2864
|
Soft delete an entity by ID
|
|
2861
2865
|
|
|
@@ -2918,7 +2922,7 @@ const result = await userRepository.delete("user-id");
|
|
|
2918
2922
|
deleteByIds(ids): Promise<DeleteResult>;
|
|
2919
2923
|
```
|
|
2920
2924
|
|
|
2921
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
2925
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:695](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L695)
|
|
2922
2926
|
|
|
2923
2927
|
Soft delete multiple entities by their IDs
|
|
2924
2928
|
|
|
@@ -3634,7 +3638,7 @@ If entity was not found in the database - rejects with error.
|
|
|
3634
3638
|
generateOptions(getOptions): FindOneOptions<Entity>;
|
|
3635
3639
|
```
|
|
3636
3640
|
|
|
3637
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
3641
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:848](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L848)
|
|
3638
3642
|
|
|
3639
3643
|
Generate TypeORM query options from Hichchi query options
|
|
3640
3644
|
|
|
@@ -3704,7 +3708,7 @@ TypeORM query options
|
|
|
3704
3708
|
getById(id, options?): Promise<Entity | null>;
|
|
3705
3709
|
```
|
|
3706
3710
|
|
|
3707
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
3711
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:549](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L549)
|
|
3708
3712
|
|
|
3709
3713
|
Get an entity by ID
|
|
3710
3714
|
|
|
@@ -3787,7 +3791,7 @@ const user = await userRepository.get("user-id", {
|
|
|
3787
3791
|
getByIds(getByIds): Promise<Entity[]>;
|
|
3788
3792
|
```
|
|
3789
3793
|
|
|
3790
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
3794
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:580](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L580)
|
|
3791
3795
|
|
|
3792
3796
|
Get multiple entities by their IDs
|
|
3793
3797
|
|
|
@@ -3897,7 +3901,7 @@ Gets entity mixed id.
|
|
|
3897
3901
|
getMany(getMany): Promise<[Entity[], number]>;
|
|
3898
3902
|
```
|
|
3899
3903
|
|
|
3900
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
3904
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:647](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L647)
|
|
3901
3905
|
|
|
3902
3906
|
Get multiple entities matching the specified criteria
|
|
3903
3907
|
|
|
@@ -3967,7 +3971,7 @@ const [users, count] = await userRepository.getMany({
|
|
|
3967
3971
|
getOne(getOne): Promise<Entity | null>;
|
|
3968
3972
|
```
|
|
3969
3973
|
|
|
3970
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
3974
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:616](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L616)
|
|
3971
3975
|
|
|
3972
3976
|
Get a single entity matching the specified criteria
|
|
3973
3977
|
|
|
@@ -4033,7 +4037,7 @@ const user = await userRepository.getOne({
|
|
|
4033
4037
|
hardDeleteById(id): Promise<DeleteResult>;
|
|
4034
4038
|
```
|
|
4035
4039
|
|
|
4036
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
4040
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:720](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L720)
|
|
4037
4041
|
|
|
4038
4042
|
Permanently delete an entity by ID
|
|
4039
4043
|
|
|
@@ -4097,7 +4101,7 @@ const result = await userRepository.hardDelete("user-id");
|
|
|
4097
4101
|
hardDeleteByIds(ids): Promise<DeleteResult>;
|
|
4098
4102
|
```
|
|
4099
4103
|
|
|
4100
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
4104
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:745](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L745)
|
|
4101
4105
|
|
|
4102
4106
|
Permanently delete multiple entities by their IDs
|
|
4103
4107
|
|
|
@@ -4321,7 +4325,7 @@ Does not check if entity exist in the database, so query will fail if duplicate
|
|
|
4321
4325
|
isFindOperator<T>(value): value is FindOperator<T>;
|
|
4322
4326
|
```
|
|
4323
4327
|
|
|
4324
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
4328
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:940](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L940)
|
|
4325
4329
|
|
|
4326
4330
|
Type guard to check if a value is a TypeORM FindOperator
|
|
4327
4331
|
|
|
@@ -4407,7 +4411,7 @@ mapAndWhere<T>(
|
|
|
4407
4411
|
wrap?): FindOptionsWhere<T>;
|
|
4408
4412
|
```
|
|
4409
4413
|
|
|
4410
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
4414
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:975](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L975)
|
|
4411
4415
|
|
|
4412
4416
|
Map and transform where conditions with operators
|
|
4413
4417
|
|
|
@@ -4418,7 +4422,7 @@ queries with nested conditions and operators.
|
|
|
4418
4422
|
Key features:
|
|
4419
4423
|
|
|
4420
4424
|
- Handles nested objects recursively
|
|
4421
|
-
- Applies operators to values (like ILike, Not,
|
|
4425
|
+
- Applies operators to values (like ILike, Not, IsNull)
|
|
4422
4426
|
- Supports string templating with the wrap parameter
|
|
4423
4427
|
- Preserves existing conditions when merging
|
|
4424
4428
|
- Maintains type safety throughout the transformation
|
|
@@ -4552,6 +4556,7 @@ The resulting where conditions
|
|
|
4552
4556
|
- toFindOptionsWhere Utility function for type-safe where condition conversion
|
|
4553
4557
|
- ILike Example of an operator that can be applied
|
|
4554
4558
|
- Not Example of an operator that can be applied
|
|
4559
|
+
- IsNull Example of an operator that can be applied
|
|
4555
4560
|
|
|
4556
4561
|
##### maximum()
|
|
4557
4562
|
|
|
@@ -4727,7 +4732,7 @@ orWhere(
|
|
|
4727
4732
|
operator): FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[];
|
|
4728
4733
|
```
|
|
4729
4734
|
|
|
4730
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
4735
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:909](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L909)
|
|
4731
4736
|
|
|
4732
4737
|
Create OR conditions for search or negation queries
|
|
4733
4738
|
|
|
@@ -5852,7 +5857,7 @@ If entity does not exist in the database then inserts, otherwise updates.
|
|
|
5852
5857
|
saveAndGet<T>(entityLike, options?): Promise<Entity | null>;
|
|
5853
5858
|
```
|
|
5854
5859
|
|
|
5855
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
5860
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:302](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L302)
|
|
5856
5861
|
|
|
5857
5862
|
Save an entity and retrieve it with relations
|
|
5858
5863
|
|
|
@@ -5989,7 +5994,7 @@ const savedUser = await userRepository.saveAndGet(existingUser, {
|
|
|
5989
5994
|
saveMany<T>(entities, options?): Promise<Entity[]>;
|
|
5990
5995
|
```
|
|
5991
5996
|
|
|
5992
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
5997
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:348](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L348)
|
|
5993
5998
|
|
|
5994
5999
|
Save multiple entities to the database
|
|
5995
6000
|
|
|
@@ -6125,7 +6130,7 @@ const savedUsers = await userRepository.saveMany(existingUsers, {
|
|
|
6125
6130
|
saveOne<T>(entityLike, options?): Promise<Entity>;
|
|
6126
6131
|
```
|
|
6127
6132
|
|
|
6128
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
6133
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:253](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L253)
|
|
6129
6134
|
|
|
6130
6135
|
Save an entity to the database
|
|
6131
6136
|
|
|
@@ -6812,7 +6817,7 @@ Return the SUM of a column
|
|
|
6812
6817
|
transaction<T>(operation): Promise<T>;
|
|
6813
6818
|
```
|
|
6814
6819
|
|
|
6815
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
6820
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:807](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L807)
|
|
6816
6821
|
|
|
6817
6822
|
Execute operations within a transaction
|
|
6818
6823
|
|
|
@@ -7021,7 +7026,7 @@ updateAndGet(
|
|
|
7021
7026
|
options?): Promise<Entity | null>;
|
|
7022
7027
|
```
|
|
7023
7028
|
|
|
7024
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
7029
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:412](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L412)
|
|
7025
7030
|
|
|
7026
7031
|
Update an entity and retrieve it with relations
|
|
7027
7032
|
|
|
@@ -7123,7 +7128,7 @@ const user = await userRepository.updateAndGet(
|
|
|
7123
7128
|
updateById(id, partialEntity): Promise<UpdateResult>;
|
|
7124
7129
|
```
|
|
7125
7130
|
|
|
7126
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
7131
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:381](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L381)
|
|
7127
7132
|
|
|
7128
7133
|
Update an entity by ID
|
|
7129
7134
|
|
|
@@ -7208,7 +7213,7 @@ const result = await userRepository.update("user-id", {
|
|
|
7208
7213
|
updateByIds(ids, partialEntity): Promise<UpdateResult>;
|
|
7209
7214
|
```
|
|
7210
7215
|
|
|
7211
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
7216
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:521](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L521)
|
|
7212
7217
|
|
|
7213
7218
|
Update multiple entities by their IDs
|
|
7214
7219
|
|
|
@@ -7291,7 +7296,7 @@ const result = await userRepository.updateByIds(
|
|
|
7291
7296
|
updateMany(where, partialEntity): Promise<UpdateResult>;
|
|
7292
7297
|
```
|
|
7293
7298
|
|
|
7294
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
7299
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:479](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L479)
|
|
7295
7300
|
|
|
7296
7301
|
Update multiple entities matching the specified criteria
|
|
7297
7302
|
|
|
@@ -7376,7 +7381,7 @@ const result = await userRepository.updateMany(
|
|
|
7376
7381
|
updateOne(where, partialEntity): Promise<UpdateResult>;
|
|
7377
7382
|
```
|
|
7378
7383
|
|
|
7379
|
-
Defined in: [libs/nest-crud/src/base/base-repository.ts:
|
|
7384
|
+
Defined in: [libs/nest-crud/src/base/base-repository.ts:446](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-repository.ts#L446)
|
|
7380
7385
|
|
|
7381
7386
|
Update a single entity matching the specified criteria
|
|
7382
7387
|
|
|
@@ -7401,7 +7406,7 @@ This method updates the first entity that matches the provided where condition.
|
|
|
7401
7406
|
</td>
|
|
7402
7407
|
<td>
|
|
7403
7408
|
|
|
7404
|
-
`QueryDeepPartial`<`Entity`>
|
|
7409
|
+
`QueryDeepPartial`<`Entity`> | `QueryDeepPartial`<`Entity`>\[]
|
|
7405
7410
|
|
|
7406
7411
|
</td>
|
|
7407
7412
|
<td>
|
|
@@ -7630,7 +7635,7 @@ node_modules/typeorm/repository/Repository.d.ts:28
|
|
|
7630
7635
|
|
|
7631
7636
|
### BulkDeleteDto
|
|
7632
7637
|
|
|
7633
|
-
Defined in: [libs/nest-crud/src/dtos/bulk-delete.dto.ts:45](https://github.com/hichchidev/hichchi/blob/
|
|
7638
|
+
Defined in: [libs/nest-crud/src/dtos/bulk-delete.dto.ts:45](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/dtos/bulk-delete.dto.ts#L45)
|
|
7634
7639
|
|
|
7635
7640
|
Data Transfer Object for bulk deletion operations
|
|
7636
7641
|
|
|
@@ -7724,7 +7729,7 @@ to perform the actual deletion operation.
|
|
|
7724
7729
|
</td>
|
|
7725
7730
|
<td>
|
|
7726
7731
|
|
|
7727
|
-
[libs/nest-crud/src/dtos/bulk-delete.dto.ts:62](https://github.com/hichchidev/hichchi/blob/
|
|
7732
|
+
[libs/nest-crud/src/dtos/bulk-delete.dto.ts:62](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/dtos/bulk-delete.dto.ts#L62)
|
|
7728
7733
|
|
|
7729
7734
|
</td>
|
|
7730
7735
|
</tr>
|
|
@@ -7735,7 +7740,7 @@ to perform the actual deletion operation.
|
|
|
7735
7740
|
|
|
7736
7741
|
### `abstract` CrudService
|
|
7737
7742
|
|
|
7738
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
7743
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:99](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L99)
|
|
7739
7744
|
|
|
7740
7745
|
Abstract base service providing CRUD operations for entities
|
|
7741
7746
|
|
|
@@ -7756,12 +7761,6 @@ Key features:
|
|
|
7756
7761
|
The service is designed to work with repositories that extend BaseRepository,
|
|
7757
7762
|
providing a consistent and type-safe way to interact with the database.
|
|
7758
7763
|
|
|
7759
|
-
#### Template
|
|
7760
|
-
|
|
7761
|
-
The entity type this service manages. This type parameter
|
|
7762
|
-
represents the entity class that the service will work with.
|
|
7763
|
-
It must extend the Model interface.
|
|
7764
|
-
|
|
7765
7764
|
#### Examples
|
|
7766
7765
|
|
|
7767
7766
|
```typescript
|
|
@@ -7813,6 +7812,7 @@ export class UserController {
|
|
|
7813
7812
|
<thead>
|
|
7814
7813
|
<tr>
|
|
7815
7814
|
<th>Type Parameter</th>
|
|
7815
|
+
<th>Description</th>
|
|
7816
7816
|
</tr>
|
|
7817
7817
|
</thead>
|
|
7818
7818
|
<tbody>
|
|
@@ -7821,6 +7821,13 @@ export class UserController {
|
|
|
7821
7821
|
|
|
7822
7822
|
`Entity` _extends_ `Model` | `ModelExtension`
|
|
7823
7823
|
|
|
7824
|
+
</td>
|
|
7825
|
+
<td>
|
|
7826
|
+
|
|
7827
|
+
The entity type this service manages. This type parameter
|
|
7828
|
+
represents the entity class that the service will work with.
|
|
7829
|
+
It must extend the Model interface.
|
|
7830
|
+
|
|
7824
7831
|
</td>
|
|
7825
7832
|
</tr>
|
|
7826
7833
|
</tbody>
|
|
@@ -7834,7 +7841,7 @@ export class UserController {
|
|
|
7834
7841
|
new CrudService<Entity>(repository): CrudService<Entity>;
|
|
7835
7842
|
```
|
|
7836
7843
|
|
|
7837
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
7844
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:140](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L140)
|
|
7838
7845
|
|
|
7839
7846
|
Creates a new instance of CrudService
|
|
7840
7847
|
|
|
@@ -7909,7 +7916,7 @@ export class UserService extends CrudService<UserEntity> {
|
|
|
7909
7916
|
count(getMany?, eh?): Promise<number>;
|
|
7910
7917
|
```
|
|
7911
7918
|
|
|
7912
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
7919
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1263](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1263)
|
|
7913
7920
|
|
|
7914
7921
|
Counts entities that match the specified conditions
|
|
7915
7922
|
|
|
@@ -8005,7 +8012,7 @@ const premiumUsers = await userService.count({
|
|
|
8005
8012
|
create<T>(createDto?, eh?): Entity;
|
|
8006
8013
|
```
|
|
8007
8014
|
|
|
8008
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8015
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:208](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L208)
|
|
8009
8016
|
|
|
8010
8017
|
Creates a new entity instance without saving it to the database
|
|
8011
8018
|
|
|
@@ -8184,7 +8191,7 @@ delete(
|
|
|
8184
8191
|
eh?): Promise<Entity>;
|
|
8185
8192
|
```
|
|
8186
8193
|
|
|
8187
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8194
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:860](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L860)
|
|
8188
8195
|
|
|
8189
8196
|
Deletes an entity by its ID
|
|
8190
8197
|
|
|
@@ -8279,7 +8286,7 @@ delete(
|
|
|
8279
8286
|
eh?): Promise<Entity>;
|
|
8280
8287
|
```
|
|
8281
8288
|
|
|
8282
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8289
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:874](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L874)
|
|
8283
8290
|
|
|
8284
8291
|
Deletes an entity by its ID with audit tracking
|
|
8285
8292
|
|
|
@@ -8427,7 +8434,7 @@ deleteByIds(
|
|
|
8427
8434
|
eh?): Promise<SuccessResponse>;
|
|
8428
8435
|
```
|
|
8429
8436
|
|
|
8430
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8437
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1151](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1151)
|
|
8431
8438
|
|
|
8432
8439
|
Deletes multiple entities by their IDs
|
|
8433
8440
|
|
|
@@ -8523,7 +8530,7 @@ deleteByIds(
|
|
|
8523
8530
|
eh?): Promise<SuccessResponse>;
|
|
8524
8531
|
```
|
|
8525
8532
|
|
|
8526
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8533
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1165](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1165)
|
|
8527
8534
|
|
|
8528
8535
|
Deletes multiple entities by their IDs with audit tracking
|
|
8529
8536
|
|
|
@@ -8674,7 +8681,7 @@ deleteMany(
|
|
|
8674
8681
|
eh?): Promise<Entity[]>;
|
|
8675
8682
|
```
|
|
8676
8683
|
|
|
8677
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8684
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1052](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1052)
|
|
8678
8685
|
|
|
8679
8686
|
Deletes multiple entities that match the specified conditions
|
|
8680
8687
|
|
|
@@ -8768,7 +8775,7 @@ deleteMany(
|
|
|
8768
8775
|
eh?): Promise<Entity[]>;
|
|
8769
8776
|
```
|
|
8770
8777
|
|
|
8771
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8778
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1066](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1066)
|
|
8772
8779
|
|
|
8773
8780
|
Deletes multiple entities that match the specified conditions with audit tracking
|
|
8774
8781
|
|
|
@@ -8918,7 +8925,7 @@ deleteOne(
|
|
|
8918
8925
|
eh?): Promise<Entity>;
|
|
8919
8926
|
```
|
|
8920
8927
|
|
|
8921
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
8928
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:949](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L949)
|
|
8922
8929
|
|
|
8923
8930
|
Deletes a single entity that matches the specified conditions
|
|
8924
8931
|
|
|
@@ -9012,7 +9019,7 @@ deleteOne(
|
|
|
9012
9019
|
eh?): Promise<Entity>;
|
|
9013
9020
|
```
|
|
9014
9021
|
|
|
9015
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9022
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:963](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L963)
|
|
9016
9023
|
|
|
9017
9024
|
Deletes a single entity that matches the specified conditions with audit tracking
|
|
9018
9025
|
|
|
@@ -9106,7 +9113,7 @@ get(
|
|
|
9106
9113
|
eh?): Promise<Entity>;
|
|
9107
9114
|
```
|
|
9108
9115
|
|
|
9109
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9116
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:629](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L629)
|
|
9110
9117
|
|
|
9111
9118
|
Retrieves an entity by its ID
|
|
9112
9119
|
|
|
@@ -9217,7 +9224,7 @@ const userWithProfile = await userService.get(userId, {
|
|
|
9217
9224
|
getAll<Options>(getAll?, eh?): Options extends object ? Promise<PaginatedResponse<Entity>> : Promise<Entity[]>;
|
|
9218
9225
|
```
|
|
9219
9226
|
|
|
9220
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9227
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:829](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L829)
|
|
9221
9228
|
|
|
9222
9229
|
Retrieves all entities, optionally with filtering, sorting, and pagination
|
|
9223
9230
|
|
|
@@ -9340,7 +9347,7 @@ const sortedUsers = await userService.getAll({
|
|
|
9340
9347
|
getByIds(getByIds, eh?): Promise<Entity[]>;
|
|
9341
9348
|
```
|
|
9342
9349
|
|
|
9343
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9350
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:678](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L678)
|
|
9344
9351
|
|
|
9345
9352
|
Retrieves multiple entities by their IDs
|
|
9346
9353
|
|
|
@@ -9438,7 +9445,7 @@ const usersWithProfiles = await userService.getByIds({
|
|
|
9438
9445
|
getMany<Options>(getMany, eh?): Options extends object ? Promise<PaginatedResponse<Entity>> : Promise<Entity[]>;
|
|
9439
9446
|
```
|
|
9440
9447
|
|
|
9441
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9448
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:774](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L774)
|
|
9442
9449
|
|
|
9443
9450
|
Retrieves multiple entities that match the specified conditions
|
|
9444
9451
|
|
|
@@ -9565,7 +9572,7 @@ const sortedUsers = await userService.getMany({
|
|
|
9565
9572
|
getOne(getOne, eh?): Promise<Entity>;
|
|
9566
9573
|
```
|
|
9567
9574
|
|
|
9568
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9575
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:720](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L720)
|
|
9569
9576
|
|
|
9570
9577
|
Retrieves a single entity that matches the specified conditions
|
|
9571
9578
|
|
|
@@ -9661,7 +9668,7 @@ const userWithProfile = await userService.getOne({
|
|
|
9661
9668
|
getRepository(): BaseRepository<Entity>;
|
|
9662
9669
|
```
|
|
9663
9670
|
|
|
9664
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9671
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:179](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L179)
|
|
9665
9672
|
|
|
9666
9673
|
Gets the repository instance used by this service
|
|
9667
9674
|
|
|
@@ -9702,7 +9709,7 @@ const entityMetadata = repository.metadata;
|
|
|
9702
9709
|
handleError(error, eh?): never;
|
|
9703
9710
|
```
|
|
9704
9711
|
|
|
9705
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9712
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1379](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1379)
|
|
9706
9713
|
|
|
9707
9714
|
Handles errors in a standardized way
|
|
9708
9715
|
|
|
@@ -9804,7 +9811,7 @@ save<T>(
|
|
|
9804
9811
|
eh?): Promise<Entity | null>;
|
|
9805
9812
|
```
|
|
9806
9813
|
|
|
9807
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9814
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:256](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L256)
|
|
9808
9815
|
|
|
9809
9816
|
Creates and saves a new entity to the database
|
|
9810
9817
|
|
|
@@ -9976,7 +9983,7 @@ saveMany<T>(
|
|
|
9976
9983
|
eh?): Promise<Entity[]>;
|
|
9977
9984
|
```
|
|
9978
9985
|
|
|
9979
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
9986
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:306](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L306)
|
|
9980
9987
|
|
|
9981
9988
|
Creates and saves multiple entities to the database
|
|
9982
9989
|
|
|
@@ -10145,7 +10152,7 @@ const usersWithAudit = await userService.saveMany(
|
|
|
10145
10152
|
transaction<T>(operation): Promise<T>;
|
|
10146
10153
|
```
|
|
10147
10154
|
|
|
10148
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
10155
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1305](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1305)
|
|
10149
10156
|
|
|
10150
10157
|
Executes operations within a transaction
|
|
10151
10158
|
|
|
@@ -10185,6 +10192,7 @@ The return type of the operation
|
|
|
10185
10192
|
<tr>
|
|
10186
10193
|
<th>Parameter</th>
|
|
10187
10194
|
<th>Type</th>
|
|
10195
|
+
<th>Description</th>
|
|
10188
10196
|
</tr>
|
|
10189
10197
|
</thead>
|
|
10190
10198
|
<tbody>
|
|
@@ -10196,7 +10204,12 @@ The return type of the operation
|
|
|
10196
10204
|
</td>
|
|
10197
10205
|
<td>
|
|
10198
10206
|
|
|
10199
|
-
() => `Promise`<`T`>
|
|
10207
|
+
(`manager`) => `Promise`<`T`>
|
|
10208
|
+
|
|
10209
|
+
</td>
|
|
10210
|
+
<td>
|
|
10211
|
+
|
|
10212
|
+
The operation to execute within the transaction
|
|
10200
10213
|
|
|
10201
10214
|
</td>
|
|
10202
10215
|
</tr>
|
|
@@ -10217,7 +10230,7 @@ If any error occurs during the transaction
|
|
|
10217
10230
|
|
|
10218
10231
|
```typescript
|
|
10219
10232
|
// Execute multiple operations in a transaction
|
|
10220
|
-
const result = await userService.transaction(async (manager) => {
|
|
10233
|
+
const result = await userService.transaction(async (manager: EntityManager) => {
|
|
10221
10234
|
// Create a user
|
|
10222
10235
|
const user = await manager.getRepository(UserEntity).save({
|
|
10223
10236
|
name: "John Doe",
|
|
@@ -10244,7 +10257,7 @@ const result = await userService.transaction(async (manager) => {
|
|
|
10244
10257
|
try<T>(fn): Promise<T>;
|
|
10245
10258
|
```
|
|
10246
10259
|
|
|
10247
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
10260
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:1336](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L1336)
|
|
10248
10261
|
|
|
10249
10262
|
Executes a function with error handling
|
|
10250
10263
|
|
|
@@ -10347,12 +10360,12 @@ update<T>(
|
|
|
10347
10360
|
eh?): Promise<Entity>;
|
|
10348
10361
|
```
|
|
10349
10362
|
|
|
10350
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
10363
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:375](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L375)
|
|
10351
10364
|
|
|
10352
10365
|
Updates an entity by its ID
|
|
10353
10366
|
|
|
10354
10367
|
This method updates an entity with the specified ID using the provided data.
|
|
10355
|
-
It also sets the
|
|
10368
|
+
It also sets the createdBy property if a user is provided. After updating,
|
|
10356
10369
|
it retrieves the updated entity with any specified relations or options.
|
|
10357
10370
|
|
|
10358
10371
|
###### Type Parameters
|
|
@@ -10551,12 +10564,12 @@ updateByIds<T>(
|
|
|
10551
10564
|
eh?): Promise<SuccessResponse>;
|
|
10552
10565
|
```
|
|
10553
10566
|
|
|
10554
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
10567
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:572](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L572)
|
|
10555
10568
|
|
|
10556
10569
|
Updates multiple entities by their IDs
|
|
10557
10570
|
|
|
10558
10571
|
This method updates all entities with the specified IDs using the provided data.
|
|
10559
|
-
It also sets the
|
|
10572
|
+
It also sets the createdBy property if a user is provided. Like updateMany,
|
|
10560
10573
|
this method returns a success response rather than the updated entities.
|
|
10561
10574
|
|
|
10562
10575
|
###### Type Parameters
|
|
@@ -10735,12 +10748,12 @@ updateMany<T>(
|
|
|
10735
10748
|
eh?): Promise<SuccessResponse>;
|
|
10736
10749
|
```
|
|
10737
10750
|
|
|
10738
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
10751
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:508](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L508)
|
|
10739
10752
|
|
|
10740
10753
|
Updates multiple entities that match the specified conditions
|
|
10741
10754
|
|
|
10742
10755
|
This method updates all entities that match the given conditions.
|
|
10743
|
-
It also sets the
|
|
10756
|
+
It also sets the createdBy property if a user is provided. Unlike update and updateOne,
|
|
10744
10757
|
this method returns a success response rather than the updated entities.
|
|
10745
10758
|
|
|
10746
10759
|
###### Type Parameters
|
|
@@ -10802,7 +10815,7 @@ Type that extends QueryDeepPartial of the base entity
|
|
|
10802
10815
|
</td>
|
|
10803
10816
|
<td>
|
|
10804
10817
|
|
|
10805
|
-
`QueryDeepPartial`<`Entity`>
|
|
10818
|
+
`QueryDeepPartial`<`Entity`> | `QueryDeepPartial`<`Entity`>\[]
|
|
10806
10819
|
|
|
10807
10820
|
</td>
|
|
10808
10821
|
<td>
|
|
@@ -10913,12 +10926,12 @@ updateOne<T>(
|
|
|
10913
10926
|
eh?): Promise<Entity>;
|
|
10914
10927
|
```
|
|
10915
10928
|
|
|
10916
|
-
Defined in: [libs/nest-crud/src/services/crud.service.ts:
|
|
10929
|
+
Defined in: [libs/nest-crud/src/services/crud.service.ts:443](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L443)
|
|
10917
10930
|
|
|
10918
10931
|
Updates a single entity that matches the specified conditions
|
|
10919
10932
|
|
|
10920
10933
|
This method updates the first entity that matches the given conditions.
|
|
10921
|
-
It also sets the
|
|
10934
|
+
It also sets the createdBy property if a user is provided. After updating,
|
|
10922
10935
|
it retrieves the updated entity.
|
|
10923
10936
|
|
|
10924
10937
|
###### Type Parameters
|
|
@@ -10980,7 +10993,7 @@ Type that extends QueryDeepPartial of the base entity
|
|
|
10980
10993
|
</td>
|
|
10981
10994
|
<td>
|
|
10982
10995
|
|
|
10983
|
-
`QueryDeepPartial`<`Entity`>
|
|
10996
|
+
`QueryDeepPartial`<`Entity`> | `QueryDeepPartial`<`Entity`>\[]
|
|
10984
10997
|
|
|
10985
10998
|
</td>
|
|
10986
10999
|
<td>
|
|
@@ -11134,7 +11147,7 @@ The repository for the entity
|
|
|
11134
11147
|
</td>
|
|
11135
11148
|
<td>
|
|
11136
11149
|
|
|
11137
|
-
[libs/nest-crud/src/services/crud.service.ts:
|
|
11150
|
+
[libs/nest-crud/src/services/crud.service.ts:140](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/services/crud.service.ts#L140)
|
|
11138
11151
|
|
|
11139
11152
|
</td>
|
|
11140
11153
|
</tr>
|
|
@@ -11145,7 +11158,7 @@ The repository for the entity
|
|
|
11145
11158
|
|
|
11146
11159
|
### HichchiCrudModule
|
|
11147
11160
|
|
|
11148
|
-
Defined in: [libs/nest-crud/src/crud.module.ts:35](https://github.com/hichchidev/hichchi/blob/
|
|
11161
|
+
Defined in: [libs/nest-crud/src/crud.module.ts:35](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/crud.module.ts#L35)
|
|
11149
11162
|
|
|
11150
11163
|
Module for integrating TypeORM with NestJS and providing CRUD functionality
|
|
11151
11164
|
|
|
@@ -11191,7 +11204,7 @@ new HichchiCrudModule(): HichchiCrudModule;
|
|
|
11191
11204
|
static forFeature(entities): DynamicModule;
|
|
11192
11205
|
```
|
|
11193
11206
|
|
|
11194
|
-
Defined in: [libs/nest-crud/src/crud.module.ts:131](https://github.com/hichchidev/hichchi/blob/
|
|
11207
|
+
Defined in: [libs/nest-crud/src/crud.module.ts:131](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/crud.module.ts#L131)
|
|
11195
11208
|
|
|
11196
11209
|
Register entities for the HichchiCrudModule
|
|
11197
11210
|
|
|
@@ -11257,7 +11270,7 @@ export class UserModule {}
|
|
|
11257
11270
|
static forRoot(options): DynamicModule;
|
|
11258
11271
|
```
|
|
11259
11272
|
|
|
11260
|
-
Defined in: [libs/nest-crud/src/crud.module.ts:73](https://github.com/hichchidev/hichchi/blob/
|
|
11273
|
+
Defined in: [libs/nest-crud/src/crud.module.ts:73](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/crud.module.ts#L73)
|
|
11261
11274
|
|
|
11262
11275
|
Register the HichchiCrudModule
|
|
11263
11276
|
|
|
@@ -11336,7 +11349,7 @@ export class AppModule {}
|
|
|
11336
11349
|
static validateEntities(entities): void;
|
|
11337
11350
|
```
|
|
11338
11351
|
|
|
11339
|
-
Defined in: [libs/nest-crud/src/crud.module.ts:206](https://github.com/hichchidev/hichchi/blob/
|
|
11352
|
+
Defined in: [libs/nest-crud/src/crud.module.ts:206](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/crud.module.ts#L206)
|
|
11340
11353
|
|
|
11341
11354
|
Validates entities for registration with the HichchiCrudModule
|
|
11342
11355
|
|
|
@@ -11401,7 +11414,7 @@ Array of entity classes to validate
|
|
|
11401
11414
|
|
|
11402
11415
|
### HichchiUserEntity
|
|
11403
11416
|
|
|
11404
|
-
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
11417
|
+
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:51](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L51)
|
|
11405
11418
|
|
|
11406
11419
|
Base user entity class that provides common user fields and functionality
|
|
11407
11420
|
|
|
@@ -11445,7 +11458,7 @@ UserInfo The interface that defines the required user properties
|
|
|
11445
11458
|
|
|
11446
11459
|
#### Implements
|
|
11447
11460
|
|
|
11448
|
-
- `
|
|
11461
|
+
- `User`
|
|
11449
11462
|
- `Model`
|
|
11450
11463
|
|
|
11451
11464
|
#### Constructors
|
|
@@ -11468,7 +11481,7 @@ new HichchiUserEntity(): HichchiUserEntity;
|
|
|
11468
11481
|
protected optional afterLoad(): void;
|
|
11469
11482
|
```
|
|
11470
11483
|
|
|
11471
|
-
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:
|
|
11484
|
+
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:299](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L299)
|
|
11472
11485
|
|
|
11473
11486
|
Lifecycle hook that runs after an entity is loaded from the database
|
|
11474
11487
|
|
|
@@ -11491,7 +11504,7 @@ UserInfo The interface that defines the user information structure
|
|
|
11491
11504
|
protected optional beforeInsert(): void;
|
|
11492
11505
|
```
|
|
11493
11506
|
|
|
11494
|
-
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:
|
|
11507
|
+
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:284](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L284)
|
|
11495
11508
|
|
|
11496
11509
|
Lifecycle hooks that run before an entity is inserted or updated
|
|
11497
11510
|
|
|
@@ -11528,12 +11541,15 @@ concatenating the firstName and lastName properties.
|
|
|
11528
11541
|
</td>
|
|
11529
11542
|
<td>
|
|
11530
11543
|
|
|
11531
|
-
|
|
11544
|
+
URL or path to the user's profile avatar image.
|
|
11545
|
+
|
|
11546
|
+
This field is optional and may be populated from uploaded images or
|
|
11547
|
+
third-party identity providers.
|
|
11532
11548
|
|
|
11533
11549
|
</td>
|
|
11534
11550
|
<td>
|
|
11535
11551
|
|
|
11536
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11552
|
+
[libs/nest-crud/src/base/base-user.entity.ts:220](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L220)
|
|
11537
11553
|
|
|
11538
11554
|
</td>
|
|
11539
11555
|
</tr>
|
|
@@ -11558,7 +11574,7 @@ It is not nullable and cannot be changed after creation.
|
|
|
11558
11574
|
</td>
|
|
11559
11575
|
<td>
|
|
11560
11576
|
|
|
11561
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11577
|
+
[libs/nest-crud/src/base/base-user.entity.ts:68](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L68)
|
|
11562
11578
|
|
|
11563
11579
|
</td>
|
|
11564
11580
|
</tr>
|
|
@@ -11583,7 +11599,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
11583
11599
|
</td>
|
|
11584
11600
|
<td>
|
|
11585
11601
|
|
|
11586
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11602
|
+
[libs/nest-crud/src/base/base-user.entity.ts:105](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L105)
|
|
11587
11603
|
|
|
11588
11604
|
</td>
|
|
11589
11605
|
</tr>
|
|
@@ -11608,7 +11624,7 @@ It is used for the foreign key relationship with the createdBy field.
|
|
|
11608
11624
|
</td>
|
|
11609
11625
|
<td>
|
|
11610
11626
|
|
|
11611
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11627
|
+
[libs/nest-crud/src/base/base-user.entity.ts:95](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L95)
|
|
11612
11628
|
|
|
11613
11629
|
</td>
|
|
11614
11630
|
</tr>
|
|
@@ -11633,7 +11649,7 @@ soft delete functionality. When this field has a value, the entity is considered
|
|
|
11633
11649
|
</td>
|
|
11634
11650
|
<td>
|
|
11635
11651
|
|
|
11636
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11652
|
+
[libs/nest-crud/src/base/base-user.entity.ts:86](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L86)
|
|
11637
11653
|
|
|
11638
11654
|
</td>
|
|
11639
11655
|
</tr>
|
|
@@ -11658,7 +11674,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
11658
11674
|
</td>
|
|
11659
11675
|
<td>
|
|
11660
11676
|
|
|
11661
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11677
|
+
[libs/nest-crud/src/base/base-user.entity.ts:143](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L143)
|
|
11662
11678
|
|
|
11663
11679
|
</td>
|
|
11664
11680
|
</tr>
|
|
@@ -11683,7 +11699,7 @@ It is used for the foreign key relationship with the deletedBy field.
|
|
|
11683
11699
|
</td>
|
|
11684
11700
|
<td>
|
|
11685
11701
|
|
|
11686
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11702
|
+
[libs/nest-crud/src/base/base-user.entity.ts:133](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L133)
|
|
11687
11703
|
|
|
11688
11704
|
</td>
|
|
11689
11705
|
</tr>
|
|
@@ -11709,7 +11725,7 @@ or uses alternative authentication methods.
|
|
|
11709
11725
|
</td>
|
|
11710
11726
|
<td>
|
|
11711
11727
|
|
|
11712
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11728
|
+
[libs/nest-crud/src/base/base-user.entity.ts:182](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L182)
|
|
11713
11729
|
|
|
11714
11730
|
</td>
|
|
11715
11731
|
</tr>
|
|
@@ -11726,12 +11742,15 @@ or uses alternative authentication methods.
|
|
|
11726
11742
|
</td>
|
|
11727
11743
|
<td>
|
|
11728
11744
|
|
|
11729
|
-
|
|
11745
|
+
Indicates whether the user's email address has been verified.
|
|
11746
|
+
|
|
11747
|
+
Used to enforce verification-dependent flows and prevent unverified
|
|
11748
|
+
accounts from accessing restricted features.
|
|
11730
11749
|
|
|
11731
11750
|
</td>
|
|
11732
11751
|
<td>
|
|
11733
11752
|
|
|
11734
|
-
[libs/nest-crud/src/base/base-user.entity.ts:211](https://github.com/hichchidev/hichchi/blob/
|
|
11753
|
+
[libs/nest-crud/src/base/base-user.entity.ts:211](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L211)
|
|
11735
11754
|
|
|
11736
11755
|
</td>
|
|
11737
11756
|
</tr>
|
|
@@ -11757,7 +11776,7 @@ be null.
|
|
|
11757
11776
|
</td>
|
|
11758
11777
|
<td>
|
|
11759
11778
|
|
|
11760
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11779
|
+
[libs/nest-crud/src/base/base-user.entity.ts:153](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L153)
|
|
11761
11780
|
|
|
11762
11781
|
</td>
|
|
11763
11782
|
</tr>
|
|
@@ -11783,7 +11802,7 @@ automatically maintained by the beforeInsert and beforeUpdate hooks.
|
|
|
11783
11802
|
</td>
|
|
11784
11803
|
<td>
|
|
11785
11804
|
|
|
11786
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11805
|
+
[libs/nest-crud/src/base/base-user.entity.ts:172](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L172)
|
|
11787
11806
|
|
|
11788
11807
|
</td>
|
|
11789
11808
|
</tr>
|
|
@@ -11808,7 +11827,7 @@ It serves as the primary key for the entity in the database.
|
|
|
11808
11827
|
</td>
|
|
11809
11828
|
<td>
|
|
11810
11829
|
|
|
11811
|
-
[libs/nest-crud/src/base/base-user.entity.ts:59](https://github.com/hichchidev/hichchi/blob/
|
|
11830
|
+
[libs/nest-crud/src/base/base-user.entity.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L59)
|
|
11812
11831
|
|
|
11813
11832
|
</td>
|
|
11814
11833
|
</tr>
|
|
@@ -11833,7 +11852,7 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11833
11852
|
</td>
|
|
11834
11853
|
<td>
|
|
11835
11854
|
|
|
11836
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11855
|
+
[libs/nest-crud/src/base/base-user.entity.ts:162](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L162)
|
|
11837
11856
|
|
|
11838
11857
|
</td>
|
|
11839
11858
|
</tr>
|
|
@@ -11850,12 +11869,15 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11850
11869
|
</td>
|
|
11851
11870
|
<td>
|
|
11852
11871
|
|
|
11853
|
-
|
|
11872
|
+
The user's password (stored in hashed form).
|
|
11873
|
+
|
|
11874
|
+
This value is excluded from serialized responses and should never contain
|
|
11875
|
+
plaintext credentials. It may be null for users authenticated via external providers.
|
|
11854
11876
|
|
|
11855
11877
|
</td>
|
|
11856
11878
|
<td>
|
|
11857
11879
|
|
|
11858
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11880
|
+
[libs/nest-crud/src/base/base-user.entity.ts:202](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L202)
|
|
11859
11881
|
|
|
11860
11882
|
</td>
|
|
11861
11883
|
</tr>
|
|
@@ -11872,12 +11894,63 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11872
11894
|
</td>
|
|
11873
11895
|
<td>
|
|
11874
11896
|
|
|
11875
|
-
|
|
11897
|
+
Additional profile information associated with the user.
|
|
11898
|
+
|
|
11899
|
+
Stores provider-specific or extended profile attributes in JSON format.
|
|
11900
|
+
|
|
11901
|
+
</td>
|
|
11902
|
+
<td>
|
|
11903
|
+
|
|
11904
|
+
[libs/nest-crud/src/base/base-user.entity.ts:228](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L228)
|
|
11905
|
+
|
|
11906
|
+
</td>
|
|
11907
|
+
</tr>
|
|
11908
|
+
<tr>
|
|
11909
|
+
<td>
|
|
11910
|
+
|
|
11911
|
+
<a id="property-role"></a> `role`
|
|
11912
|
+
|
|
11913
|
+
</td>
|
|
11914
|
+
<td>
|
|
11915
|
+
|
|
11916
|
+
`string` | `Role`<`string`, `string`> | `null`
|
|
11876
11917
|
|
|
11877
11918
|
</td>
|
|
11878
11919
|
<td>
|
|
11879
11920
|
|
|
11880
|
-
|
|
11921
|
+
The authorization role assigned to the user.
|
|
11922
|
+
|
|
11923
|
+
Stores either a role identifier string or a populated role object,
|
|
11924
|
+
depending on how the entity is loaded and mapped.
|
|
11925
|
+
|
|
11926
|
+
</td>
|
|
11927
|
+
<td>
|
|
11928
|
+
|
|
11929
|
+
[libs/nest-crud/src/base/base-user.entity.ts:245](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L245)
|
|
11930
|
+
|
|
11931
|
+
</td>
|
|
11932
|
+
</tr>
|
|
11933
|
+
<tr>
|
|
11934
|
+
<td>
|
|
11935
|
+
|
|
11936
|
+
<a id="property-roleid"></a> `roleId?`
|
|
11937
|
+
|
|
11938
|
+
</td>
|
|
11939
|
+
<td>
|
|
11940
|
+
|
|
11941
|
+
`EntityId` | `null`
|
|
11942
|
+
|
|
11943
|
+
</td>
|
|
11944
|
+
<td>
|
|
11945
|
+
|
|
11946
|
+
The unique identifier of the user's role.
|
|
11947
|
+
|
|
11948
|
+
Optional foreign key reference to the role entity for direct relational access.
|
|
11949
|
+
|
|
11950
|
+
</td>
|
|
11951
|
+
<td>
|
|
11952
|
+
|
|
11953
|
+
[libs/nest-crud/src/base/base-user.entity.ts:253](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L253)
|
|
11881
11954
|
|
|
11882
11955
|
</td>
|
|
11883
11956
|
</tr>
|
|
@@ -11894,12 +11967,14 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11894
11967
|
</td>
|
|
11895
11968
|
<td>
|
|
11896
11969
|
|
|
11897
|
-
|
|
11970
|
+
Authentication provider used when the account was created.
|
|
11971
|
+
|
|
11972
|
+
Determines which sign-in flow and credential requirements apply to the user.
|
|
11898
11973
|
|
|
11899
11974
|
</td>
|
|
11900
11975
|
<td>
|
|
11901
11976
|
|
|
11902
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11977
|
+
[libs/nest-crud/src/base/base-user.entity.ts:236](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L236)
|
|
11903
11978
|
|
|
11904
11979
|
</td>
|
|
11905
11980
|
</tr>
|
|
@@ -11911,7 +11986,7 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11911
11986
|
</td>
|
|
11912
11987
|
<td>
|
|
11913
11988
|
|
|
11914
|
-
`TenantSlug` | `null`
|
|
11989
|
+
`TenantSlug` | `Tenant` | `null`
|
|
11915
11990
|
|
|
11916
11991
|
</td>
|
|
11917
11992
|
<td>
|
|
@@ -11927,7 +12002,31 @@ This variable is often used to scope application logic and data to a specific te
|
|
|
11927
12002
|
</td>
|
|
11928
12003
|
<td>
|
|
11929
12004
|
|
|
11930
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12005
|
+
[libs/nest-crud/src/base/base-user.entity.ts:265](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L265)
|
|
12006
|
+
|
|
12007
|
+
</td>
|
|
12008
|
+
</tr>
|
|
12009
|
+
<tr>
|
|
12010
|
+
<td>
|
|
12011
|
+
|
|
12012
|
+
<a id="property-tenantid"></a> `tenantId?`
|
|
12013
|
+
|
|
12014
|
+
</td>
|
|
12015
|
+
<td>
|
|
12016
|
+
|
|
12017
|
+
`EntityId` | `null`
|
|
12018
|
+
|
|
12019
|
+
</td>
|
|
12020
|
+
<td>
|
|
12021
|
+
|
|
12022
|
+
The unique identifier of the user's tenant.
|
|
12023
|
+
|
|
12024
|
+
Optional foreign key reference used to scope data to a tenant context.
|
|
12025
|
+
|
|
12026
|
+
</td>
|
|
12027
|
+
<td>
|
|
12028
|
+
|
|
12029
|
+
[libs/nest-crud/src/base/base-user.entity.ts:273](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L273)
|
|
11931
12030
|
|
|
11932
12031
|
</td>
|
|
11933
12032
|
</tr>
|
|
@@ -11952,7 +12051,7 @@ and updated whenever the entity is modified.
|
|
|
11952
12051
|
</td>
|
|
11953
12052
|
<td>
|
|
11954
12053
|
|
|
11955
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12054
|
+
[libs/nest-crud/src/base/base-user.entity.ts:77](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L77)
|
|
11956
12055
|
|
|
11957
12056
|
</td>
|
|
11958
12057
|
</tr>
|
|
@@ -11977,7 +12076,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
11977
12076
|
</td>
|
|
11978
12077
|
<td>
|
|
11979
12078
|
|
|
11980
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12079
|
+
[libs/nest-crud/src/base/base-user.entity.ts:124](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L124)
|
|
11981
12080
|
|
|
11982
12081
|
</td>
|
|
11983
12082
|
</tr>
|
|
@@ -12002,7 +12101,7 @@ It is used for the foreign key relationship with the updatedBy field.
|
|
|
12002
12101
|
</td>
|
|
12003
12102
|
<td>
|
|
12004
12103
|
|
|
12005
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12104
|
+
[libs/nest-crud/src/base/base-user.entity.ts:114](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L114)
|
|
12006
12105
|
|
|
12007
12106
|
</td>
|
|
12008
12107
|
</tr>
|
|
@@ -12028,7 +12127,7 @@ alternative authentication methods like email-only authentication.
|
|
|
12028
12127
|
</td>
|
|
12029
12128
|
<td>
|
|
12030
12129
|
|
|
12031
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12130
|
+
[libs/nest-crud/src/base/base-user.entity.ts:192](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-user.entity.ts#L192)
|
|
12032
12131
|
|
|
12033
12132
|
</td>
|
|
12034
12133
|
</tr>
|
|
@@ -12039,7 +12138,7 @@ alternative authentication methods like email-only authentication.
|
|
|
12039
12138
|
|
|
12040
12139
|
### IdsDto
|
|
12041
12140
|
|
|
12042
|
-
Defined in: [libs/nest-crud/src/dtos/ids.dto.ts:10](https://github.com/hichchidev/hichchi/blob/
|
|
12141
|
+
Defined in: [libs/nest-crud/src/dtos/ids.dto.ts:10](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/dtos/ids.dto.ts#L10)
|
|
12043
12142
|
|
|
12044
12143
|
#### Implements
|
|
12045
12144
|
|
|
@@ -12081,7 +12180,7 @@ new IdsDto(): IdsDto;
|
|
|
12081
12180
|
</td>
|
|
12082
12181
|
<td>
|
|
12083
12182
|
|
|
12084
|
-
[libs/nest-crud/src/dtos/ids.dto.ts:14](https://github.com/hichchidev/hichchi/blob/
|
|
12183
|
+
[libs/nest-crud/src/dtos/ids.dto.ts:14](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/dtos/ids.dto.ts#L14)
|
|
12085
12184
|
|
|
12086
12185
|
</td>
|
|
12087
12186
|
</tr>
|
|
@@ -15198,7 +15297,7 @@ node_modules/typeorm/repository/Repository.d.ts:28
|
|
|
15198
15297
|
|
|
15199
15298
|
### Operation
|
|
15200
15299
|
|
|
15201
|
-
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:50](https://github.com/hichchidev/hichchi/blob/
|
|
15300
|
+
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:50](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L50)
|
|
15202
15301
|
|
|
15203
15302
|
CRUD Operations Enum
|
|
15204
15303
|
|
|
@@ -15244,7 +15343,7 @@ and performs any initialization logic required for new entities.
|
|
|
15244
15343
|
</td>
|
|
15245
15344
|
<td>
|
|
15246
15345
|
|
|
15247
|
-
[libs/nest-crud/src/enums/crud.enums.ts:58](https://github.com/hichchidev/hichchi/blob/
|
|
15346
|
+
[libs/nest-crud/src/enums/crud.enums.ts:58](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L58)
|
|
15248
15347
|
|
|
15249
15348
|
</td>
|
|
15250
15349
|
</tr>
|
|
@@ -15270,7 +15369,7 @@ enforce referential integrity constraints, depending on the configuration.
|
|
|
15270
15369
|
</td>
|
|
15271
15370
|
<td>
|
|
15272
15371
|
|
|
15273
|
-
[libs/nest-crud/src/enums/crud.enums.ts:85](https://github.com/hichchidev/hichchi/blob/
|
|
15372
|
+
[libs/nest-crud/src/enums/crud.enums.ts:85](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L85)
|
|
15274
15373
|
|
|
15275
15374
|
</td>
|
|
15276
15375
|
</tr>
|
|
@@ -15296,7 +15395,7 @@ entity already exists in the database.
|
|
|
15296
15395
|
</td>
|
|
15297
15396
|
<td>
|
|
15298
15397
|
|
|
15299
|
-
[libs/nest-crud/src/enums/crud.enums.ts:76](https://github.com/hichchidev/hichchi/blob/
|
|
15398
|
+
[libs/nest-crud/src/enums/crud.enums.ts:76](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L76)
|
|
15300
15399
|
|
|
15301
15400
|
</td>
|
|
15302
15401
|
</tr>
|
|
@@ -15322,7 +15421,7 @@ and may enforce different validation rules than creation.
|
|
|
15322
15421
|
</td>
|
|
15323
15422
|
<td>
|
|
15324
15423
|
|
|
15325
|
-
[libs/nest-crud/src/enums/crud.enums.ts:67](https://github.com/hichchidev/hichchi/blob/
|
|
15424
|
+
[libs/nest-crud/src/enums/crud.enums.ts:67](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L67)
|
|
15326
15425
|
|
|
15327
15426
|
</td>
|
|
15328
15427
|
</tr>
|
|
@@ -15333,7 +15432,7 @@ and may enforce different validation rules than creation.
|
|
|
15333
15432
|
|
|
15334
15433
|
### TypeORMErrorType
|
|
15335
15434
|
|
|
15336
|
-
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:13](https://github.com/hichchidev/hichchi/blob/
|
|
15435
|
+
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:13](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L13)
|
|
15337
15436
|
|
|
15338
15437
|
TypeORM Database Error Types
|
|
15339
15438
|
|
|
@@ -15377,7 +15476,7 @@ often caused by typos in column names or outdated queries after schema changes.
|
|
|
15377
15476
|
</td>
|
|
15378
15477
|
<td>
|
|
15379
15478
|
|
|
15380
|
-
[libs/nest-crud/src/enums/crud.enums.ts:36](https://github.com/hichchidev/hichchi/blob/
|
|
15479
|
+
[libs/nest-crud/src/enums/crud.enums.ts:36](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L36)
|
|
15381
15480
|
|
|
15382
15481
|
</td>
|
|
15383
15482
|
</tr>
|
|
@@ -15400,7 +15499,7 @@ constraint, such as primary keys or columns with unique indexes.
|
|
|
15400
15499
|
</td>
|
|
15401
15500
|
<td>
|
|
15402
15501
|
|
|
15403
|
-
[libs/nest-crud/src/enums/crud.enums.ts:24](https://github.com/hichchidev/hichchi/blob/
|
|
15502
|
+
[libs/nest-crud/src/enums/crud.enums.ts:24](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L24)
|
|
15404
15503
|
|
|
15405
15504
|
</td>
|
|
15406
15505
|
</tr>
|
|
@@ -15423,7 +15522,7 @@ has no default value defined in the database schema.
|
|
|
15423
15522
|
</td>
|
|
15424
15523
|
<td>
|
|
15425
15524
|
|
|
15426
|
-
[libs/nest-crud/src/enums/crud.enums.ts:18](https://github.com/hichchidev/hichchi/blob/
|
|
15525
|
+
[libs/nest-crud/src/enums/crud.enums.ts:18](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L18)
|
|
15427
15526
|
|
|
15428
15527
|
</td>
|
|
15429
15528
|
</tr>
|
|
@@ -15446,7 +15545,7 @@ typically occurring during insert or update operations with invalid foreign key
|
|
|
15446
15545
|
</td>
|
|
15447
15546
|
<td>
|
|
15448
15547
|
|
|
15449
|
-
[libs/nest-crud/src/enums/crud.enums.ts:30](https://github.com/hichchidev/hichchi/blob/
|
|
15548
|
+
[libs/nest-crud/src/enums/crud.enums.ts:30](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/enums/crud.enums.ts#L30)
|
|
15450
15549
|
|
|
15451
15550
|
</td>
|
|
15452
15551
|
</tr>
|
|
@@ -15461,7 +15560,7 @@ typically occurring during insert or update operations with invalid foreign key
|
|
|
15461
15560
|
function Filters(): ParameterDecorator;
|
|
15462
15561
|
```
|
|
15463
15562
|
|
|
15464
|
-
Defined in: [libs/nest-crud/src/decorators/filter.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/
|
|
15563
|
+
Defined in: [libs/nest-crud/src/decorators/filter.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/filter.decorator.ts#L85)
|
|
15465
15564
|
|
|
15466
15565
|
Filter parameter decorator
|
|
15467
15566
|
|
|
@@ -15553,7 +15652,7 @@ export class ProductController {
|
|
|
15553
15652
|
function HichchiEntity(tableName, unique?, skipFkValidation?): EntityDecorator;
|
|
15554
15653
|
```
|
|
15555
15654
|
|
|
15556
|
-
Defined in: [libs/nest-crud/src/decorators/entity.decorator.ts:109](https://github.com/hichchidev/hichchi/blob/
|
|
15655
|
+
Defined in: [libs/nest-crud/src/decorators/entity.decorator.ts:109](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/entity.decorator.ts#L109)
|
|
15557
15656
|
|
|
15558
15657
|
Decorator for creating a new entity with enhanced validation and metadata registration
|
|
15559
15658
|
|
|
@@ -15734,7 +15833,7 @@ If entity naming conventions or relationship definitions are invalid
|
|
|
15734
15833
|
function HichchiEntityExtension(tableName): EntityExtensionDecorator;
|
|
15735
15834
|
```
|
|
15736
15835
|
|
|
15737
|
-
Defined in: [libs/nest-crud/src/decorators/entity-extension.decorator.ts:54](https://github.com/hichchidev/hichchi/blob/
|
|
15836
|
+
Defined in: [libs/nest-crud/src/decorators/entity-extension.decorator.ts:54](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/entity-extension.decorator.ts#L54)
|
|
15738
15837
|
|
|
15739
15838
|
Decorator for creating entity extensions with enhanced validation
|
|
15740
15839
|
|
|
@@ -15840,7 +15939,7 @@ If extension class doesn't extend BaseEntityExtension or has invalid relationshi
|
|
|
15840
15939
|
function HichchiJoinColumn(options?): PropertyDecorator;
|
|
15841
15940
|
```
|
|
15842
15941
|
|
|
15843
|
-
Defined in: [libs/nest-crud/src/decorators/join-column.decorator.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
15942
|
+
Defined in: [libs/nest-crud/src/decorators/join-column.decorator.ts:51](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/join-column.decorator.ts#L51)
|
|
15844
15943
|
|
|
15845
15944
|
Decorator for creating a join column with automatic foreign key constraint naming
|
|
15846
15945
|
|
|
@@ -15929,7 +16028,7 @@ JoinColumn TypeORM's JoinColumn decorator that this extends
|
|
|
15929
16028
|
function HichchiRepository<Entity>(entity): RepositoryDecorator;
|
|
15930
16029
|
```
|
|
15931
16030
|
|
|
15932
|
-
Defined in: [libs/nest-crud/src/decorators/repository.decorator.ts:63](https://github.com/hichchidev/hichchi/blob/
|
|
16031
|
+
Defined in: [libs/nest-crud/src/decorators/repository.decorator.ts:63](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/repository.decorator.ts#L63)
|
|
15933
16032
|
|
|
15934
16033
|
Decorator for creating a repository with automatic dependency injection
|
|
15935
16034
|
|
|
@@ -16049,7 +16148,24 @@ If the target class doesn't extend BaseRepository
|
|
|
16049
16148
|
|
|
16050
16149
|
### Pager()
|
|
16051
16150
|
|
|
16052
|
-
Implementation
|
|
16151
|
+
Implementation signature for all `Pager` overload variants.
|
|
16152
|
+
|
|
16153
|
+
Accepts either:
|
|
16154
|
+
|
|
16155
|
+
- a `PaginationOptions` object, or
|
|
16156
|
+
- numeric `page` and `limit` defaults.
|
|
16157
|
+
|
|
16158
|
+
It extracts pagination from the current HTTP request query and returns
|
|
16159
|
+
a normalized Pagination object when both `page` and `limit`
|
|
16160
|
+
query parameters are present.
|
|
16161
|
+
|
|
16162
|
+
#### Param
|
|
16163
|
+
|
|
16164
|
+
Object defaults or numeric page fallback
|
|
16165
|
+
|
|
16166
|
+
#### Param
|
|
16167
|
+
|
|
16168
|
+
Numeric limit fallback when `input` is numeric
|
|
16053
16169
|
|
|
16054
16170
|
#### Call Signature
|
|
16055
16171
|
|
|
@@ -16057,23 +16173,61 @@ Implementation overload for extracting pagination from request query params.
|
|
|
16057
16173
|
function Pager(): ParameterDecorator;
|
|
16058
16174
|
```
|
|
16059
16175
|
|
|
16060
|
-
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:
|
|
16176
|
+
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:33](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/page.decorator.ts#L33)
|
|
16177
|
+
|
|
16178
|
+
Pagination parameter decorator overload for query-driven pagination.
|
|
16179
|
+
|
|
16180
|
+
This overload reads `page` and `limit` directly from `req.query` and returns
|
|
16181
|
+
a normalized Pagination object with `page`, `limit`, `take`, and `skip`.
|
|
16061
16182
|
|
|
16062
|
-
|
|
16183
|
+
Behavior:
|
|
16184
|
+
|
|
16185
|
+
1. Uses request query values only
|
|
16186
|
+
2. Parses both values as numbers
|
|
16187
|
+
3. Falls back to `1` for invalid page and DEFAULT_ITEMS_PER_PAGE for invalid limit
|
|
16188
|
+
4. Removes `page` and `limit` from `req.query` after extraction
|
|
16189
|
+
5. Returns `undefined` when either query key is missing
|
|
16063
16190
|
|
|
16064
16191
|
##### Returns
|
|
16065
16192
|
|
|
16066
16193
|
`ParameterDecorator`
|
|
16067
16194
|
|
|
16195
|
+
A decorator that injects pagination from query params
|
|
16196
|
+
|
|
16197
|
+
##### Example
|
|
16198
|
+
|
|
16199
|
+
```typescript
|
|
16200
|
+
@Get()
|
|
16201
|
+
list(@Pager() pagination?: Pagination) {
|
|
16202
|
+
return pagination ? this.service.findPaginated(pagination) : this.service.findAll();
|
|
16203
|
+
}
|
|
16204
|
+
```
|
|
16205
|
+
|
|
16206
|
+
##### See
|
|
16207
|
+
|
|
16208
|
+
- Pagination Pagination structure returned by this overload
|
|
16209
|
+
- DEFAULT_ITEMS_PER_PAGE Default page size used for invalid limits
|
|
16210
|
+
|
|
16068
16211
|
#### Call Signature
|
|
16069
16212
|
|
|
16070
16213
|
```ts
|
|
16071
16214
|
function Pager(page, limit): ParameterDecorator;
|
|
16072
16215
|
```
|
|
16073
16216
|
|
|
16074
|
-
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:
|
|
16217
|
+
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:63](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/page.decorator.ts#L63)
|
|
16218
|
+
|
|
16219
|
+
Pagination parameter decorator overload with numeric fallback defaults.
|
|
16075
16220
|
|
|
16076
|
-
|
|
16221
|
+
This overload reads `page` and `limit` from `req.query`, and when those values
|
|
16222
|
+
are present but invalid, applies the provided numeric defaults.
|
|
16223
|
+
|
|
16224
|
+
Behavior:
|
|
16225
|
+
|
|
16226
|
+
1. Parses request query values for `page` and `limit`
|
|
16227
|
+
2. Uses supplied defaults for invalid numeric values
|
|
16228
|
+
3. Computes `skip` using `(page - 1) * take`
|
|
16229
|
+
4. Removes `page` and `limit` from `req.query` after extraction
|
|
16230
|
+
5. Returns `undefined` when either query key is missing
|
|
16077
16231
|
|
|
16078
16232
|
##### Parameters
|
|
16079
16233
|
|
|
@@ -16082,6 +16236,7 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16082
16236
|
<tr>
|
|
16083
16237
|
<th>Parameter</th>
|
|
16084
16238
|
<th>Type</th>
|
|
16239
|
+
<th>Description</th>
|
|
16085
16240
|
</tr>
|
|
16086
16241
|
</thead>
|
|
16087
16242
|
<tbody>
|
|
@@ -16095,6 +16250,11 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16095
16250
|
|
|
16096
16251
|
`number`
|
|
16097
16252
|
|
|
16253
|
+
</td>
|
|
16254
|
+
<td>
|
|
16255
|
+
|
|
16256
|
+
Default page number when query `page` is invalid
|
|
16257
|
+
|
|
16098
16258
|
</td>
|
|
16099
16259
|
</tr>
|
|
16100
16260
|
<tr>
|
|
@@ -16107,6 +16267,11 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16107
16267
|
|
|
16108
16268
|
`number`
|
|
16109
16269
|
|
|
16270
|
+
</td>
|
|
16271
|
+
<td>
|
|
16272
|
+
|
|
16273
|
+
Default page size when query `limit` is invalid
|
|
16274
|
+
|
|
16110
16275
|
</td>
|
|
16111
16276
|
</tr>
|
|
16112
16277
|
</tbody>
|
|
@@ -16116,13 +16281,29 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16116
16281
|
|
|
16117
16282
|
`ParameterDecorator`
|
|
16118
16283
|
|
|
16284
|
+
A decorator that injects pagination with numeric defaults
|
|
16285
|
+
|
|
16286
|
+
##### Example
|
|
16287
|
+
|
|
16288
|
+
```typescript
|
|
16289
|
+
@Get()
|
|
16290
|
+
list(@Pager(1, 25) pagination?: Pagination) {
|
|
16291
|
+
return pagination ? this.service.findPaginated(pagination) : this.service.findAll();
|
|
16292
|
+
}
|
|
16293
|
+
```
|
|
16294
|
+
|
|
16295
|
+
##### See
|
|
16296
|
+
|
|
16297
|
+
- Pagination Pagination structure returned by this overload
|
|
16298
|
+
- DEFAULT_ITEMS_PER_PAGE Built-in fallback page size
|
|
16299
|
+
|
|
16119
16300
|
#### Call Signature
|
|
16120
16301
|
|
|
16121
16302
|
```ts
|
|
16122
16303
|
function Pager(defaultOptions?): ParameterDecorator;
|
|
16123
16304
|
```
|
|
16124
16305
|
|
|
16125
|
-
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:
|
|
16306
|
+
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:168](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/page.decorator.ts#L168)
|
|
16126
16307
|
|
|
16127
16308
|
Pagination parameter decorator
|
|
16128
16309
|
|
|
@@ -16267,7 +16448,7 @@ export class ArticleController {
|
|
|
16267
16448
|
function Search(): ParameterDecorator;
|
|
16268
16449
|
```
|
|
16269
16450
|
|
|
16270
|
-
Defined in: [libs/nest-crud/src/decorators/search.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/
|
|
16451
|
+
Defined in: [libs/nest-crud/src/decorators/search.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/search.decorator.ts#L85)
|
|
16271
16452
|
|
|
16272
16453
|
Search parameter decorator
|
|
16273
16454
|
|
|
@@ -16362,7 +16543,7 @@ export class ProductController {
|
|
|
16362
16543
|
function Sorter(): ParameterDecorator;
|
|
16363
16544
|
```
|
|
16364
16545
|
|
|
16365
|
-
Defined in: [libs/nest-crud/src/decorators/sort.decorator.ts:90](https://github.com/hichchidev/hichchi/blob/
|
|
16546
|
+
Defined in: [libs/nest-crud/src/decorators/sort.decorator.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/decorators/sort.decorator.ts#L90)
|
|
16366
16547
|
|
|
16367
16548
|
Sort parameter decorator
|
|
16368
16549
|
|
|
@@ -16458,7 +16639,7 @@ export class ProductController {
|
|
|
16458
16639
|
|
|
16459
16640
|
### ConnectionOptions
|
|
16460
16641
|
|
|
16461
|
-
Defined in: [libs/nest-crud/src/interfaces/connection-options.interface.ts:45](https://github.com/hichchidev/hichchi/blob/
|
|
16642
|
+
Defined in: [libs/nest-crud/src/interfaces/connection-options.interface.ts:45](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L45)
|
|
16462
16643
|
|
|
16463
16644
|
Database connection configuration options.
|
|
16464
16645
|
|
|
@@ -16549,7 +16730,7 @@ autoLoadEntities: true;
|
|
|
16549
16730
|
</td>
|
|
16550
16731
|
<td>
|
|
16551
16732
|
|
|
16552
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:185](https://github.com/hichchidev/hichchi/blob/
|
|
16733
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:185](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L185)
|
|
16553
16734
|
|
|
16554
16735
|
</td>
|
|
16555
16736
|
</tr>
|
|
@@ -16581,7 +16762,7 @@ charset: "utf8mb4";
|
|
|
16581
16762
|
</td>
|
|
16582
16763
|
<td>
|
|
16583
16764
|
|
|
16584
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:148](https://github.com/hichchidev/hichchi/blob/
|
|
16765
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:148](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L148)
|
|
16585
16766
|
|
|
16586
16767
|
</td>
|
|
16587
16768
|
</tr>
|
|
@@ -16612,7 +16793,7 @@ database: "my_application_db";
|
|
|
16612
16793
|
</td>
|
|
16613
16794
|
<td>
|
|
16614
16795
|
|
|
16615
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:114](https://github.com/hichchidev/hichchi/blob/
|
|
16796
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:114](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L114)
|
|
16616
16797
|
|
|
16617
16798
|
</td>
|
|
16618
16799
|
</tr>
|
|
@@ -16643,7 +16824,7 @@ entities: [__dirname + "/** /*.entity{.ts,.js}"];
|
|
|
16643
16824
|
</td>
|
|
16644
16825
|
<td>
|
|
16645
16826
|
|
|
16646
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:125](https://github.com/hichchidev/hichchi/blob/
|
|
16827
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:125](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L125)
|
|
16647
16828
|
|
|
16648
16829
|
</td>
|
|
16649
16830
|
</tr>
|
|
@@ -16678,7 +16859,7 @@ host: "localhost";
|
|
|
16678
16859
|
</td>
|
|
16679
16860
|
<td>
|
|
16680
16861
|
|
|
16681
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:69](https://github.com/hichchidev/hichchi/blob/
|
|
16862
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:69](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L69)
|
|
16682
16863
|
|
|
16683
16864
|
</td>
|
|
16684
16865
|
</tr>
|
|
@@ -16710,7 +16891,7 @@ false;
|
|
|
16710
16891
|
</td>
|
|
16711
16892
|
<td>
|
|
16712
16893
|
|
|
16713
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:172](https://github.com/hichchidev/hichchi/blob/
|
|
16894
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:172](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L172)
|
|
16714
16895
|
|
|
16715
16896
|
</td>
|
|
16716
16897
|
</tr>
|
|
@@ -16741,7 +16922,7 @@ migrations: [__dirname + "/migrations/*{.ts,.js}"];
|
|
|
16741
16922
|
</td>
|
|
16742
16923
|
<td>
|
|
16743
16924
|
|
|
16744
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:136](https://github.com/hichchidev/hichchi/blob/
|
|
16925
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:136](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L136)
|
|
16745
16926
|
|
|
16746
16927
|
</td>
|
|
16747
16928
|
</tr>
|
|
@@ -16773,7 +16954,7 @@ password: process.env.DB_PASSWORD;
|
|
|
16773
16954
|
</td>
|
|
16774
16955
|
<td>
|
|
16775
16956
|
|
|
16776
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:103](https://github.com/hichchidev/hichchi/blob/
|
|
16957
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:103](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L103)
|
|
16777
16958
|
|
|
16778
16959
|
</td>
|
|
16779
16960
|
</tr>
|
|
@@ -16804,7 +16985,7 @@ port: 3306;
|
|
|
16804
16985
|
</td>
|
|
16805
16986
|
<td>
|
|
16806
16987
|
|
|
16807
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:80](https://github.com/hichchidev/hichchi/blob/
|
|
16988
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:80](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L80)
|
|
16808
16989
|
|
|
16809
16990
|
</td>
|
|
16810
16991
|
</tr>
|
|
@@ -16842,7 +17023,7 @@ synchronize: false;
|
|
|
16842
17023
|
</td>
|
|
16843
17024
|
<td>
|
|
16844
17025
|
|
|
16845
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:161](https://github.com/hichchidev/hichchi/blob/
|
|
17026
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:161](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L161)
|
|
16846
17027
|
|
|
16847
17028
|
</td>
|
|
16848
17029
|
</tr>
|
|
@@ -16874,7 +17055,7 @@ type: "mysql";
|
|
|
16874
17055
|
</td>
|
|
16875
17056
|
<td>
|
|
16876
17057
|
|
|
16877
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
17058
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:56](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L56)
|
|
16878
17059
|
|
|
16879
17060
|
</td>
|
|
16880
17061
|
</tr>
|
|
@@ -16905,7 +17086,7 @@ username: "app_user";
|
|
|
16905
17086
|
</td>
|
|
16906
17087
|
<td>
|
|
16907
17088
|
|
|
16908
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:91](https://github.com/hichchidev/hichchi/blob/
|
|
17089
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:91](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/connection-options.interface.ts#L91)
|
|
16909
17090
|
|
|
16910
17091
|
</td>
|
|
16911
17092
|
</tr>
|
|
@@ -16916,7 +17097,7 @@ username: "app_user";
|
|
|
16916
17097
|
|
|
16917
17098
|
### GetByIdsOptions
|
|
16918
17099
|
|
|
16919
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17100
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:363](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L363)
|
|
16920
17101
|
|
|
16921
17102
|
Options interface for retrieving entities by their IDs.
|
|
16922
17103
|
|
|
@@ -17016,7 +17197,7 @@ ids: ["abc123", "def456"]; // For string IDs
|
|
|
17016
17197
|
</td>
|
|
17017
17198
|
<td>
|
|
17018
17199
|
|
|
17019
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17200
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:375](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L375)
|
|
17020
17201
|
|
|
17021
17202
|
</td>
|
|
17022
17203
|
</tr>
|
|
@@ -17056,7 +17237,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17056
17237
|
</td>
|
|
17057
17238
|
<td>
|
|
17058
17239
|
|
|
17059
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
17240
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17060
17241
|
|
|
17061
17242
|
</td>
|
|
17062
17243
|
</tr>
|
|
@@ -17097,7 +17278,7 @@ options: {
|
|
|
17097
17278
|
</td>
|
|
17098
17279
|
<td>
|
|
17099
17280
|
|
|
17100
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17281
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
17101
17282
|
|
|
17102
17283
|
</td>
|
|
17103
17284
|
</tr>
|
|
@@ -17134,7 +17315,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17134
17315
|
</td>
|
|
17135
17316
|
<td>
|
|
17136
17317
|
|
|
17137
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17318
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
17138
17319
|
|
|
17139
17320
|
</td>
|
|
17140
17321
|
</tr>
|
|
@@ -17146,7 +17327,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17146
17327
|
</td>
|
|
17147
17328
|
<td>
|
|
17148
17329
|
|
|
17149
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17330
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17150
17331
|
|
|
17151
17332
|
</td>
|
|
17152
17333
|
<td>
|
|
@@ -17156,13 +17337,23 @@ Array of entity relation properties to eager-load.
|
|
|
17156
17337
|
Specifies which related entities should be loaded along with the main entity.
|
|
17157
17338
|
This is transformed into TypeORM's relations option internally.
|
|
17158
17339
|
|
|
17159
|
-
**
|
|
17340
|
+
**Examples**
|
|
17160
17341
|
|
|
17161
17342
|
```ts
|
|
17162
|
-
//
|
|
17343
|
+
// Array-style relations
|
|
17163
17344
|
relations: ["profile", "posts"];
|
|
17164
17345
|
```
|
|
17165
17346
|
|
|
17347
|
+
```ts
|
|
17348
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
17349
|
+
relations: { profile: true, posts: true }
|
|
17350
|
+
```
|
|
17351
|
+
|
|
17352
|
+
```ts
|
|
17353
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
17354
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
17355
|
+
```
|
|
17356
|
+
|
|
17166
17357
|
</td>
|
|
17167
17358
|
<td>
|
|
17168
17359
|
|
|
@@ -17171,7 +17362,7 @@ relations: ["profile", "posts"];
|
|
|
17171
17362
|
</td>
|
|
17172
17363
|
<td>
|
|
17173
17364
|
|
|
17174
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17365
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
17175
17366
|
|
|
17176
17367
|
</td>
|
|
17177
17368
|
</tr>
|
|
@@ -17211,7 +17402,7 @@ sort: {
|
|
|
17211
17402
|
</td>
|
|
17212
17403
|
<td>
|
|
17213
17404
|
|
|
17214
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17405
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
17215
17406
|
|
|
17216
17407
|
</td>
|
|
17217
17408
|
</tr>
|
|
@@ -17222,7 +17413,7 @@ sort: {
|
|
|
17222
17413
|
|
|
17223
17414
|
### GetManyOptionsFilter
|
|
17224
17415
|
|
|
17225
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17416
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:472](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L472)
|
|
17226
17417
|
|
|
17227
17418
|
Options for retrieving multiple entities with pagination and filter-based query keys.
|
|
17228
17419
|
|
|
@@ -17294,7 +17485,7 @@ filters: { status: 'active', type: 'user' }
|
|
|
17294
17485
|
</td>
|
|
17295
17486
|
<td>
|
|
17296
17487
|
|
|
17297
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17488
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:106](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L106)
|
|
17298
17489
|
|
|
17299
17490
|
</td>
|
|
17300
17491
|
</tr>
|
|
@@ -17334,7 +17525,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17334
17525
|
</td>
|
|
17335
17526
|
<td>
|
|
17336
17527
|
|
|
17337
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
17528
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17338
17529
|
|
|
17339
17530
|
</td>
|
|
17340
17531
|
</tr>
|
|
@@ -17375,7 +17566,7 @@ options: {
|
|
|
17375
17566
|
</td>
|
|
17376
17567
|
<td>
|
|
17377
17568
|
|
|
17378
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17569
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
17379
17570
|
|
|
17380
17571
|
</td>
|
|
17381
17572
|
</tr>
|
|
@@ -17412,7 +17603,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17412
17603
|
</td>
|
|
17413
17604
|
<td>
|
|
17414
17605
|
|
|
17415
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17606
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
17416
17607
|
|
|
17417
17608
|
</td>
|
|
17418
17609
|
</tr>
|
|
@@ -17424,7 +17615,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17424
17615
|
</td>
|
|
17425
17616
|
<td>
|
|
17426
17617
|
|
|
17427
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17618
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17428
17619
|
|
|
17429
17620
|
</td>
|
|
17430
17621
|
<td>
|
|
@@ -17434,13 +17625,23 @@ Array of entity relation properties to eager-load.
|
|
|
17434
17625
|
Specifies which related entities should be loaded along with the main entity.
|
|
17435
17626
|
This is transformed into TypeORM's relations option internally.
|
|
17436
17627
|
|
|
17437
|
-
**
|
|
17628
|
+
**Examples**
|
|
17438
17629
|
|
|
17439
17630
|
```ts
|
|
17440
|
-
//
|
|
17631
|
+
// Array-style relations
|
|
17441
17632
|
relations: ["profile", "posts"];
|
|
17442
17633
|
```
|
|
17443
17634
|
|
|
17635
|
+
```ts
|
|
17636
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
17637
|
+
relations: { profile: true, posts: true }
|
|
17638
|
+
```
|
|
17639
|
+
|
|
17640
|
+
```ts
|
|
17641
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
17642
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
17643
|
+
```
|
|
17644
|
+
|
|
17444
17645
|
</td>
|
|
17445
17646
|
<td>
|
|
17446
17647
|
|
|
@@ -17449,7 +17650,7 @@ relations: ["profile", "posts"];
|
|
|
17449
17650
|
</td>
|
|
17450
17651
|
<td>
|
|
17451
17652
|
|
|
17452
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17653
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
17453
17654
|
|
|
17454
17655
|
</td>
|
|
17455
17656
|
</tr>
|
|
@@ -17489,7 +17690,7 @@ sort: {
|
|
|
17489
17690
|
</td>
|
|
17490
17691
|
<td>
|
|
17491
17692
|
|
|
17492
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17693
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
17493
17694
|
|
|
17494
17695
|
</td>
|
|
17495
17696
|
</tr>
|
|
@@ -17517,7 +17718,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
17517
17718
|
</td>
|
|
17518
17719
|
<td>
|
|
17519
17720
|
|
|
17520
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17721
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:112](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L112)
|
|
17521
17722
|
|
|
17522
17723
|
</td>
|
|
17523
17724
|
</tr>
|
|
@@ -17528,7 +17729,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
17528
17729
|
|
|
17529
17730
|
### GetManyOptionsNot
|
|
17530
17731
|
|
|
17531
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17732
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:518](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L518)
|
|
17532
17733
|
|
|
17533
17734
|
Options interface for retrieving multiple entities using exclusion-based filtering with pagination.
|
|
17534
17735
|
|
|
@@ -17627,7 +17828,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17627
17828
|
</td>
|
|
17628
17829
|
<td>
|
|
17629
17830
|
|
|
17630
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
17831
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17631
17832
|
|
|
17632
17833
|
</td>
|
|
17633
17834
|
</tr>
|
|
@@ -17663,7 +17864,7 @@ not: { role: 'admin', status: 'deleted' }
|
|
|
17663
17864
|
</td>
|
|
17664
17865
|
<td>
|
|
17665
17866
|
|
|
17666
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17867
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:232](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L232)
|
|
17667
17868
|
|
|
17668
17869
|
</td>
|
|
17669
17870
|
</tr>
|
|
@@ -17704,7 +17905,7 @@ options: {
|
|
|
17704
17905
|
</td>
|
|
17705
17906
|
<td>
|
|
17706
17907
|
|
|
17707
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17908
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
17708
17909
|
|
|
17709
17910
|
</td>
|
|
17710
17911
|
</tr>
|
|
@@ -17741,7 +17942,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17741
17942
|
</td>
|
|
17742
17943
|
<td>
|
|
17743
17944
|
|
|
17744
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17945
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
17745
17946
|
|
|
17746
17947
|
</td>
|
|
17747
17948
|
</tr>
|
|
@@ -17753,7 +17954,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17753
17954
|
</td>
|
|
17754
17955
|
<td>
|
|
17755
17956
|
|
|
17756
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17957
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17757
17958
|
|
|
17758
17959
|
</td>
|
|
17759
17960
|
<td>
|
|
@@ -17763,13 +17964,23 @@ Array of entity relation properties to eager-load.
|
|
|
17763
17964
|
Specifies which related entities should be loaded along with the main entity.
|
|
17764
17965
|
This is transformed into TypeORM's relations option internally.
|
|
17765
17966
|
|
|
17766
|
-
**
|
|
17967
|
+
**Examples**
|
|
17767
17968
|
|
|
17768
17969
|
```ts
|
|
17769
|
-
//
|
|
17970
|
+
// Array-style relations
|
|
17770
17971
|
relations: ["profile", "posts"];
|
|
17771
17972
|
```
|
|
17772
17973
|
|
|
17974
|
+
```ts
|
|
17975
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
17976
|
+
relations: { profile: true, posts: true }
|
|
17977
|
+
```
|
|
17978
|
+
|
|
17979
|
+
```ts
|
|
17980
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
17981
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
17982
|
+
```
|
|
17983
|
+
|
|
17773
17984
|
</td>
|
|
17774
17985
|
<td>
|
|
17775
17986
|
|
|
@@ -17778,7 +17989,7 @@ relations: ["profile", "posts"];
|
|
|
17778
17989
|
</td>
|
|
17779
17990
|
<td>
|
|
17780
17991
|
|
|
17781
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17992
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
17782
17993
|
|
|
17783
17994
|
</td>
|
|
17784
17995
|
</tr>
|
|
@@ -17818,7 +18029,7 @@ sort: {
|
|
|
17818
18029
|
</td>
|
|
17819
18030
|
<td>
|
|
17820
18031
|
|
|
17821
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18032
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
17822
18033
|
|
|
17823
18034
|
</td>
|
|
17824
18035
|
</tr>
|
|
@@ -17846,7 +18057,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
17846
18057
|
</td>
|
|
17847
18058
|
<td>
|
|
17848
18059
|
|
|
17849
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18060
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:238](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L238)
|
|
17850
18061
|
|
|
17851
18062
|
</td>
|
|
17852
18063
|
</tr>
|
|
@@ -17857,7 +18068,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
17857
18068
|
|
|
17858
18069
|
### GetManyOptionsSearch
|
|
17859
18070
|
|
|
17860
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18071
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:495](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L495)
|
|
17861
18072
|
|
|
17862
18073
|
Options interface for retrieving multiple entities using search-based filtering with pagination.
|
|
17863
18074
|
|
|
@@ -17956,7 +18167,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17956
18167
|
</td>
|
|
17957
18168
|
<td>
|
|
17958
18169
|
|
|
17959
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
18170
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17960
18171
|
|
|
17961
18172
|
</td>
|
|
17962
18173
|
</tr>
|
|
@@ -17997,7 +18208,7 @@ options: {
|
|
|
17997
18208
|
</td>
|
|
17998
18209
|
<td>
|
|
17999
18210
|
|
|
18000
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18211
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
18001
18212
|
|
|
18002
18213
|
</td>
|
|
18003
18214
|
</tr>
|
|
@@ -18034,7 +18245,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18034
18245
|
</td>
|
|
18035
18246
|
<td>
|
|
18036
18247
|
|
|
18037
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18248
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
18038
18249
|
|
|
18039
18250
|
</td>
|
|
18040
18251
|
</tr>
|
|
@@ -18046,7 +18257,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18046
18257
|
</td>
|
|
18047
18258
|
<td>
|
|
18048
18259
|
|
|
18049
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18260
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18050
18261
|
|
|
18051
18262
|
</td>
|
|
18052
18263
|
<td>
|
|
@@ -18056,13 +18267,23 @@ Array of entity relation properties to eager-load.
|
|
|
18056
18267
|
Specifies which related entities should be loaded along with the main entity.
|
|
18057
18268
|
This is transformed into TypeORM's relations option internally.
|
|
18058
18269
|
|
|
18059
|
-
**
|
|
18270
|
+
**Examples**
|
|
18060
18271
|
|
|
18061
18272
|
```ts
|
|
18062
|
-
//
|
|
18273
|
+
// Array-style relations
|
|
18063
18274
|
relations: ["profile", "posts"];
|
|
18064
18275
|
```
|
|
18065
18276
|
|
|
18277
|
+
```ts
|
|
18278
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
18279
|
+
relations: { profile: true, posts: true }
|
|
18280
|
+
```
|
|
18281
|
+
|
|
18282
|
+
```ts
|
|
18283
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
18284
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
18285
|
+
```
|
|
18286
|
+
|
|
18066
18287
|
</td>
|
|
18067
18288
|
<td>
|
|
18068
18289
|
|
|
@@ -18071,7 +18292,7 @@ relations: ["profile", "posts"];
|
|
|
18071
18292
|
</td>
|
|
18072
18293
|
<td>
|
|
18073
18294
|
|
|
18074
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18295
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
18075
18296
|
|
|
18076
18297
|
</td>
|
|
18077
18298
|
</tr>
|
|
@@ -18111,7 +18332,7 @@ search: {
|
|
|
18111
18332
|
</td>
|
|
18112
18333
|
<td>
|
|
18113
18334
|
|
|
18114
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18335
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:165](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L165)
|
|
18115
18336
|
|
|
18116
18337
|
</td>
|
|
18117
18338
|
</tr>
|
|
@@ -18151,7 +18372,7 @@ sort: {
|
|
|
18151
18372
|
</td>
|
|
18152
18373
|
<td>
|
|
18153
18374
|
|
|
18154
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18375
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
18155
18376
|
|
|
18156
18377
|
</td>
|
|
18157
18378
|
</tr>
|
|
@@ -18179,7 +18400,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18179
18400
|
</td>
|
|
18180
18401
|
<td>
|
|
18181
18402
|
|
|
18182
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18403
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:171](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L171)
|
|
18183
18404
|
|
|
18184
18405
|
</td>
|
|
18185
18406
|
</tr>
|
|
@@ -18190,7 +18411,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18190
18411
|
|
|
18191
18412
|
### GetManyOptionsWhere
|
|
18192
18413
|
|
|
18193
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18414
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:543](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L543)
|
|
18194
18415
|
|
|
18195
18416
|
Options interface for retrieving multiple entities using direct WHERE clause with pagination.
|
|
18196
18417
|
|
|
@@ -18276,7 +18497,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18276
18497
|
</td>
|
|
18277
18498
|
<td>
|
|
18278
18499
|
|
|
18279
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18500
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:273](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L273)
|
|
18280
18501
|
|
|
18281
18502
|
</td>
|
|
18282
18503
|
</tr>
|
|
@@ -18316,7 +18537,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
18316
18537
|
</td>
|
|
18317
18538
|
<td>
|
|
18318
18539
|
|
|
18319
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
18540
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
18320
18541
|
|
|
18321
18542
|
</td>
|
|
18322
18543
|
</tr>
|
|
@@ -18344,7 +18565,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
18344
18565
|
</td>
|
|
18345
18566
|
<td>
|
|
18346
18567
|
|
|
18347
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18568
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:285](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L285)
|
|
18348
18569
|
|
|
18349
18570
|
</td>
|
|
18350
18571
|
</tr>
|
|
@@ -18385,7 +18606,7 @@ options: {
|
|
|
18385
18606
|
</td>
|
|
18386
18607
|
<td>
|
|
18387
18608
|
|
|
18388
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18609
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
18389
18610
|
|
|
18390
18611
|
</td>
|
|
18391
18612
|
</tr>
|
|
@@ -18422,7 +18643,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18422
18643
|
</td>
|
|
18423
18644
|
<td>
|
|
18424
18645
|
|
|
18425
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18646
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
18426
18647
|
|
|
18427
18648
|
</td>
|
|
18428
18649
|
</tr>
|
|
@@ -18434,7 +18655,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18434
18655
|
</td>
|
|
18435
18656
|
<td>
|
|
18436
18657
|
|
|
18437
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18658
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18438
18659
|
|
|
18439
18660
|
</td>
|
|
18440
18661
|
<td>
|
|
@@ -18444,13 +18665,23 @@ Array of entity relation properties to eager-load.
|
|
|
18444
18665
|
Specifies which related entities should be loaded along with the main entity.
|
|
18445
18666
|
This is transformed into TypeORM's relations option internally.
|
|
18446
18667
|
|
|
18447
|
-
**
|
|
18668
|
+
**Examples**
|
|
18448
18669
|
|
|
18449
18670
|
```ts
|
|
18450
|
-
//
|
|
18671
|
+
// Array-style relations
|
|
18451
18672
|
relations: ["profile", "posts"];
|
|
18452
18673
|
```
|
|
18453
18674
|
|
|
18675
|
+
```ts
|
|
18676
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
18677
|
+
relations: { profile: true, posts: true }
|
|
18678
|
+
```
|
|
18679
|
+
|
|
18680
|
+
```ts
|
|
18681
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
18682
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
18683
|
+
```
|
|
18684
|
+
|
|
18454
18685
|
</td>
|
|
18455
18686
|
<td>
|
|
18456
18687
|
|
|
@@ -18459,7 +18690,7 @@ relations: ["profile", "posts"];
|
|
|
18459
18690
|
</td>
|
|
18460
18691
|
<td>
|
|
18461
18692
|
|
|
18462
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18693
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
18463
18694
|
|
|
18464
18695
|
</td>
|
|
18465
18696
|
</tr>
|
|
@@ -18487,7 +18718,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18487
18718
|
</td>
|
|
18488
18719
|
<td>
|
|
18489
18720
|
|
|
18490
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18721
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:279](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L279)
|
|
18491
18722
|
|
|
18492
18723
|
</td>
|
|
18493
18724
|
</tr>
|
|
@@ -18527,7 +18758,7 @@ sort: {
|
|
|
18527
18758
|
</td>
|
|
18528
18759
|
<td>
|
|
18529
18760
|
|
|
18530
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18761
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
18531
18762
|
|
|
18532
18763
|
</td>
|
|
18533
18764
|
</tr>
|
|
@@ -18573,7 +18804,7 @@ where: [
|
|
|
18573
18804
|
</td>
|
|
18574
18805
|
<td>
|
|
18575
18806
|
|
|
18576
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18807
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:305](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L305)
|
|
18577
18808
|
|
|
18578
18809
|
</td>
|
|
18579
18810
|
</tr>
|
|
@@ -18584,7 +18815,7 @@ where: [
|
|
|
18584
18815
|
|
|
18585
18816
|
### GetOneOptionsFilter
|
|
18586
18817
|
|
|
18587
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18818
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:402](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L402)
|
|
18588
18819
|
|
|
18589
18820
|
Options for retrieving a single entity using filter-based query keys.
|
|
18590
18821
|
|
|
@@ -18660,7 +18891,7 @@ filters: { status: 'active', type: 'user' }
|
|
|
18660
18891
|
</td>
|
|
18661
18892
|
<td>
|
|
18662
18893
|
|
|
18663
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18894
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:106](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L106)
|
|
18664
18895
|
|
|
18665
18896
|
</td>
|
|
18666
18897
|
</tr>
|
|
@@ -18700,7 +18931,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
18700
18931
|
</td>
|
|
18701
18932
|
<td>
|
|
18702
18933
|
|
|
18703
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
18934
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
18704
18935
|
|
|
18705
18936
|
</td>
|
|
18706
18937
|
</tr>
|
|
@@ -18741,7 +18972,7 @@ options: {
|
|
|
18741
18972
|
</td>
|
|
18742
18973
|
<td>
|
|
18743
18974
|
|
|
18744
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18975
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
18745
18976
|
|
|
18746
18977
|
</td>
|
|
18747
18978
|
</tr>
|
|
@@ -18753,7 +18984,7 @@ options: {
|
|
|
18753
18984
|
</td>
|
|
18754
18985
|
<td>
|
|
18755
18986
|
|
|
18756
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18987
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18757
18988
|
|
|
18758
18989
|
</td>
|
|
18759
18990
|
<td>
|
|
@@ -18763,13 +18994,23 @@ Array of entity relation properties to eager-load.
|
|
|
18763
18994
|
Specifies which related entities should be loaded along with the main entity.
|
|
18764
18995
|
This is transformed into TypeORM's relations option internally.
|
|
18765
18996
|
|
|
18766
|
-
**
|
|
18997
|
+
**Examples**
|
|
18767
18998
|
|
|
18768
18999
|
```ts
|
|
18769
|
-
//
|
|
19000
|
+
// Array-style relations
|
|
18770
19001
|
relations: ["profile", "posts"];
|
|
18771
19002
|
```
|
|
18772
19003
|
|
|
19004
|
+
```ts
|
|
19005
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19006
|
+
relations: { profile: true, posts: true }
|
|
19007
|
+
```
|
|
19008
|
+
|
|
19009
|
+
```ts
|
|
19010
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19011
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19012
|
+
```
|
|
19013
|
+
|
|
18773
19014
|
</td>
|
|
18774
19015
|
<td>
|
|
18775
19016
|
|
|
@@ -18778,7 +19019,7 @@ relations: ["profile", "posts"];
|
|
|
18778
19019
|
</td>
|
|
18779
19020
|
<td>
|
|
18780
19021
|
|
|
18781
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19022
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
18782
19023
|
|
|
18783
19024
|
</td>
|
|
18784
19025
|
</tr>
|
|
@@ -18818,7 +19059,7 @@ sort: {
|
|
|
18818
19059
|
</td>
|
|
18819
19060
|
<td>
|
|
18820
19061
|
|
|
18821
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19062
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
18822
19063
|
|
|
18823
19064
|
</td>
|
|
18824
19065
|
</tr>
|
|
@@ -18846,7 +19087,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18846
19087
|
</td>
|
|
18847
19088
|
<td>
|
|
18848
19089
|
|
|
18849
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19090
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:112](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L112)
|
|
18850
19091
|
|
|
18851
19092
|
</td>
|
|
18852
19093
|
</tr>
|
|
@@ -18857,7 +19098,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18857
19098
|
|
|
18858
19099
|
### GetOneOptionsNot
|
|
18859
19100
|
|
|
18860
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19101
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:444](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L444)
|
|
18861
19102
|
|
|
18862
19103
|
Options interface for retrieving a single entity using exclusion-based filtering.
|
|
18863
19104
|
|
|
@@ -18958,7 +19199,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
18958
19199
|
</td>
|
|
18959
19200
|
<td>
|
|
18960
19201
|
|
|
18961
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
19202
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
18962
19203
|
|
|
18963
19204
|
</td>
|
|
18964
19205
|
</tr>
|
|
@@ -18994,7 +19235,7 @@ not: { role: 'admin', status: 'deleted' }
|
|
|
18994
19235
|
</td>
|
|
18995
19236
|
<td>
|
|
18996
19237
|
|
|
18997
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19238
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:232](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L232)
|
|
18998
19239
|
|
|
18999
19240
|
</td>
|
|
19000
19241
|
</tr>
|
|
@@ -19035,7 +19276,7 @@ options: {
|
|
|
19035
19276
|
</td>
|
|
19036
19277
|
<td>
|
|
19037
19278
|
|
|
19038
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19279
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19039
19280
|
|
|
19040
19281
|
</td>
|
|
19041
19282
|
</tr>
|
|
@@ -19047,7 +19288,7 @@ options: {
|
|
|
19047
19288
|
</td>
|
|
19048
19289
|
<td>
|
|
19049
19290
|
|
|
19050
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19291
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19051
19292
|
|
|
19052
19293
|
</td>
|
|
19053
19294
|
<td>
|
|
@@ -19057,13 +19298,23 @@ Array of entity relation properties to eager-load.
|
|
|
19057
19298
|
Specifies which related entities should be loaded along with the main entity.
|
|
19058
19299
|
This is transformed into TypeORM's relations option internally.
|
|
19059
19300
|
|
|
19060
|
-
**
|
|
19301
|
+
**Examples**
|
|
19061
19302
|
|
|
19062
19303
|
```ts
|
|
19063
|
-
//
|
|
19304
|
+
// Array-style relations
|
|
19064
19305
|
relations: ["profile", "posts"];
|
|
19065
19306
|
```
|
|
19066
19307
|
|
|
19308
|
+
```ts
|
|
19309
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19310
|
+
relations: { profile: true, posts: true }
|
|
19311
|
+
```
|
|
19312
|
+
|
|
19313
|
+
```ts
|
|
19314
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19315
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19316
|
+
```
|
|
19317
|
+
|
|
19067
19318
|
</td>
|
|
19068
19319
|
<td>
|
|
19069
19320
|
|
|
@@ -19072,7 +19323,7 @@ relations: ["profile", "posts"];
|
|
|
19072
19323
|
</td>
|
|
19073
19324
|
<td>
|
|
19074
19325
|
|
|
19075
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19326
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
19076
19327
|
|
|
19077
19328
|
</td>
|
|
19078
19329
|
</tr>
|
|
@@ -19112,7 +19363,7 @@ sort: {
|
|
|
19112
19363
|
</td>
|
|
19113
19364
|
<td>
|
|
19114
19365
|
|
|
19115
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19366
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
19116
19367
|
|
|
19117
19368
|
</td>
|
|
19118
19369
|
</tr>
|
|
@@ -19140,7 +19391,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
19140
19391
|
</td>
|
|
19141
19392
|
<td>
|
|
19142
19393
|
|
|
19143
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19394
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:238](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L238)
|
|
19144
19395
|
|
|
19145
19396
|
</td>
|
|
19146
19397
|
</tr>
|
|
@@ -19151,7 +19402,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
19151
19402
|
|
|
19152
19403
|
### GetOneOptionsSearch
|
|
19153
19404
|
|
|
19154
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19405
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:423](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L423)
|
|
19155
19406
|
|
|
19156
19407
|
Options interface for retrieving a single entity using search-based filtering.
|
|
19157
19408
|
|
|
@@ -19252,7 +19503,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
19252
19503
|
</td>
|
|
19253
19504
|
<td>
|
|
19254
19505
|
|
|
19255
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
19506
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
19256
19507
|
|
|
19257
19508
|
</td>
|
|
19258
19509
|
</tr>
|
|
@@ -19293,7 +19544,7 @@ options: {
|
|
|
19293
19544
|
</td>
|
|
19294
19545
|
<td>
|
|
19295
19546
|
|
|
19296
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19547
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19297
19548
|
|
|
19298
19549
|
</td>
|
|
19299
19550
|
</tr>
|
|
@@ -19305,7 +19556,7 @@ options: {
|
|
|
19305
19556
|
</td>
|
|
19306
19557
|
<td>
|
|
19307
19558
|
|
|
19308
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19559
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19309
19560
|
|
|
19310
19561
|
</td>
|
|
19311
19562
|
<td>
|
|
@@ -19315,13 +19566,23 @@ Array of entity relation properties to eager-load.
|
|
|
19315
19566
|
Specifies which related entities should be loaded along with the main entity.
|
|
19316
19567
|
This is transformed into TypeORM's relations option internally.
|
|
19317
19568
|
|
|
19318
|
-
**
|
|
19569
|
+
**Examples**
|
|
19319
19570
|
|
|
19320
19571
|
```ts
|
|
19321
|
-
//
|
|
19572
|
+
// Array-style relations
|
|
19322
19573
|
relations: ["profile", "posts"];
|
|
19323
19574
|
```
|
|
19324
19575
|
|
|
19576
|
+
```ts
|
|
19577
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19578
|
+
relations: { profile: true, posts: true }
|
|
19579
|
+
```
|
|
19580
|
+
|
|
19581
|
+
```ts
|
|
19582
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19583
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19584
|
+
```
|
|
19585
|
+
|
|
19325
19586
|
</td>
|
|
19326
19587
|
<td>
|
|
19327
19588
|
|
|
@@ -19330,7 +19591,7 @@ relations: ["profile", "posts"];
|
|
|
19330
19591
|
</td>
|
|
19331
19592
|
<td>
|
|
19332
19593
|
|
|
19333
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19594
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
19334
19595
|
|
|
19335
19596
|
</td>
|
|
19336
19597
|
</tr>
|
|
@@ -19370,7 +19631,7 @@ search: {
|
|
|
19370
19631
|
</td>
|
|
19371
19632
|
<td>
|
|
19372
19633
|
|
|
19373
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19634
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:165](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L165)
|
|
19374
19635
|
|
|
19375
19636
|
</td>
|
|
19376
19637
|
</tr>
|
|
@@ -19410,7 +19671,7 @@ sort: {
|
|
|
19410
19671
|
</td>
|
|
19411
19672
|
<td>
|
|
19412
19673
|
|
|
19413
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19674
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
19414
19675
|
|
|
19415
19676
|
</td>
|
|
19416
19677
|
</tr>
|
|
@@ -19438,7 +19699,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19438
19699
|
</td>
|
|
19439
19700
|
<td>
|
|
19440
19701
|
|
|
19441
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19702
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:171](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L171)
|
|
19442
19703
|
|
|
19443
19704
|
</td>
|
|
19444
19705
|
</tr>
|
|
@@ -19449,7 +19710,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19449
19710
|
|
|
19450
19711
|
### GetOneOptionsWhere
|
|
19451
19712
|
|
|
19452
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19713
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:467](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L467)
|
|
19453
19714
|
|
|
19454
19715
|
Options interface for retrieving a single entity using direct WHERE clause.
|
|
19455
19716
|
|
|
@@ -19537,7 +19798,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19537
19798
|
</td>
|
|
19538
19799
|
<td>
|
|
19539
19800
|
|
|
19540
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19801
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:273](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L273)
|
|
19541
19802
|
|
|
19542
19803
|
</td>
|
|
19543
19804
|
</tr>
|
|
@@ -19577,7 +19838,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
19577
19838
|
</td>
|
|
19578
19839
|
<td>
|
|
19579
19840
|
|
|
19580
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
19841
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
19581
19842
|
|
|
19582
19843
|
</td>
|
|
19583
19844
|
</tr>
|
|
@@ -19605,7 +19866,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
19605
19866
|
</td>
|
|
19606
19867
|
<td>
|
|
19607
19868
|
|
|
19608
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19869
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:285](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L285)
|
|
19609
19870
|
|
|
19610
19871
|
</td>
|
|
19611
19872
|
</tr>
|
|
@@ -19646,7 +19907,7 @@ options: {
|
|
|
19646
19907
|
</td>
|
|
19647
19908
|
<td>
|
|
19648
19909
|
|
|
19649
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19910
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19650
19911
|
|
|
19651
19912
|
</td>
|
|
19652
19913
|
</tr>
|
|
@@ -19658,7 +19919,7 @@ options: {
|
|
|
19658
19919
|
</td>
|
|
19659
19920
|
<td>
|
|
19660
19921
|
|
|
19661
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19922
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19662
19923
|
|
|
19663
19924
|
</td>
|
|
19664
19925
|
<td>
|
|
@@ -19668,13 +19929,23 @@ Array of entity relation properties to eager-load.
|
|
|
19668
19929
|
Specifies which related entities should be loaded along with the main entity.
|
|
19669
19930
|
This is transformed into TypeORM's relations option internally.
|
|
19670
19931
|
|
|
19671
|
-
**
|
|
19932
|
+
**Examples**
|
|
19672
19933
|
|
|
19673
19934
|
```ts
|
|
19674
|
-
//
|
|
19935
|
+
// Array-style relations
|
|
19675
19936
|
relations: ["profile", "posts"];
|
|
19676
19937
|
```
|
|
19677
19938
|
|
|
19939
|
+
```ts
|
|
19940
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19941
|
+
relations: { profile: true, posts: true }
|
|
19942
|
+
```
|
|
19943
|
+
|
|
19944
|
+
```ts
|
|
19945
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19946
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19947
|
+
```
|
|
19948
|
+
|
|
19678
19949
|
</td>
|
|
19679
19950
|
<td>
|
|
19680
19951
|
|
|
@@ -19683,7 +19954,7 @@ relations: ["profile", "posts"];
|
|
|
19683
19954
|
</td>
|
|
19684
19955
|
<td>
|
|
19685
19956
|
|
|
19686
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19957
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
19687
19958
|
|
|
19688
19959
|
</td>
|
|
19689
19960
|
</tr>
|
|
@@ -19711,7 +19982,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19711
19982
|
</td>
|
|
19712
19983
|
<td>
|
|
19713
19984
|
|
|
19714
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19985
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:279](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L279)
|
|
19715
19986
|
|
|
19716
19987
|
</td>
|
|
19717
19988
|
</tr>
|
|
@@ -19751,7 +20022,7 @@ sort: {
|
|
|
19751
20022
|
</td>
|
|
19752
20023
|
<td>
|
|
19753
20024
|
|
|
19754
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20025
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
19755
20026
|
|
|
19756
20027
|
</td>
|
|
19757
20028
|
</tr>
|
|
@@ -19797,7 +20068,7 @@ where: [
|
|
|
19797
20068
|
</td>
|
|
19798
20069
|
<td>
|
|
19799
20070
|
|
|
19800
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20071
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:305](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L305)
|
|
19801
20072
|
|
|
19802
20073
|
</td>
|
|
19803
20074
|
</tr>
|
|
@@ -19808,7 +20079,7 @@ where: [
|
|
|
19808
20079
|
|
|
19809
20080
|
### PaginatedGetOptions
|
|
19810
20081
|
|
|
19811
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20082
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:327](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L327)
|
|
19812
20083
|
|
|
19813
20084
|
Options interface for paginated CRUD operations.
|
|
19814
20085
|
|
|
@@ -19913,7 +20184,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
19913
20184
|
</td>
|
|
19914
20185
|
<td>
|
|
19915
20186
|
|
|
19916
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20187
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
19917
20188
|
|
|
19918
20189
|
</td>
|
|
19919
20190
|
</tr>
|
|
@@ -19954,7 +20225,7 @@ options: {
|
|
|
19954
20225
|
</td>
|
|
19955
20226
|
<td>
|
|
19956
20227
|
|
|
19957
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20228
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19958
20229
|
|
|
19959
20230
|
</td>
|
|
19960
20231
|
</tr>
|
|
@@ -19991,7 +20262,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
19991
20262
|
</td>
|
|
19992
20263
|
<td>
|
|
19993
20264
|
|
|
19994
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20265
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
19995
20266
|
|
|
19996
20267
|
</td>
|
|
19997
20268
|
</tr>
|
|
@@ -20003,7 +20274,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
20003
20274
|
</td>
|
|
20004
20275
|
<td>
|
|
20005
20276
|
|
|
20006
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20277
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20007
20278
|
|
|
20008
20279
|
</td>
|
|
20009
20280
|
<td>
|
|
@@ -20013,13 +20284,23 @@ Array of entity relation properties to eager-load.
|
|
|
20013
20284
|
Specifies which related entities should be loaded along with the main entity.
|
|
20014
20285
|
This is transformed into TypeORM's relations option internally.
|
|
20015
20286
|
|
|
20016
|
-
**
|
|
20287
|
+
**Examples**
|
|
20017
20288
|
|
|
20018
20289
|
```ts
|
|
20019
|
-
//
|
|
20290
|
+
// Array-style relations
|
|
20020
20291
|
relations: ["profile", "posts"];
|
|
20021
20292
|
```
|
|
20022
20293
|
|
|
20294
|
+
```ts
|
|
20295
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
20296
|
+
relations: { profile: true, posts: true }
|
|
20297
|
+
```
|
|
20298
|
+
|
|
20299
|
+
```ts
|
|
20300
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
20301
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
20302
|
+
```
|
|
20303
|
+
|
|
20023
20304
|
</td>
|
|
20024
20305
|
<td>
|
|
20025
20306
|
|
|
@@ -20028,7 +20309,7 @@ relations: ["profile", "posts"];
|
|
|
20028
20309
|
</td>
|
|
20029
20310
|
<td>
|
|
20030
20311
|
|
|
20031
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20312
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20032
20313
|
|
|
20033
20314
|
</td>
|
|
20034
20315
|
</tr>
|
|
@@ -20068,7 +20349,7 @@ sort: {
|
|
|
20068
20349
|
</td>
|
|
20069
20350
|
<td>
|
|
20070
20351
|
|
|
20071
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20352
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20072
20353
|
|
|
20073
20354
|
</td>
|
|
20074
20355
|
</tr>
|
|
@@ -20079,7 +20360,7 @@ sort: {
|
|
|
20079
20360
|
|
|
20080
20361
|
### QueryOptions
|
|
20081
20362
|
|
|
20082
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:23](https://github.com/hichchidev/hichchi/blob/
|
|
20363
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:23](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L23)
|
|
20083
20364
|
|
|
20084
20365
|
Base options interface for CRUD operations.
|
|
20085
20366
|
|
|
@@ -20177,7 +20458,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20177
20458
|
</td>
|
|
20178
20459
|
<td>
|
|
20179
20460
|
|
|
20180
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20461
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20181
20462
|
|
|
20182
20463
|
</td>
|
|
20183
20464
|
</tr>
|
|
@@ -20213,7 +20494,7 @@ options: {
|
|
|
20213
20494
|
</td>
|
|
20214
20495
|
<td>
|
|
20215
20496
|
|
|
20216
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20497
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
20217
20498
|
|
|
20218
20499
|
</td>
|
|
20219
20500
|
</tr>
|
|
@@ -20225,7 +20506,7 @@ options: {
|
|
|
20225
20506
|
</td>
|
|
20226
20507
|
<td>
|
|
20227
20508
|
|
|
20228
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20509
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20229
20510
|
|
|
20230
20511
|
</td>
|
|
20231
20512
|
<td>
|
|
@@ -20235,17 +20516,27 @@ Array of entity relation properties to eager-load.
|
|
|
20235
20516
|
Specifies which related entities should be loaded along with the main entity.
|
|
20236
20517
|
This is transformed into TypeORM's relations option internally.
|
|
20237
20518
|
|
|
20238
|
-
**
|
|
20519
|
+
**Examples**
|
|
20239
20520
|
|
|
20240
20521
|
```ts
|
|
20241
|
-
//
|
|
20522
|
+
// Array-style relations
|
|
20242
20523
|
relations: ["profile", "posts"];
|
|
20243
20524
|
```
|
|
20244
20525
|
|
|
20526
|
+
```ts
|
|
20527
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
20528
|
+
relations: { profile: true, posts: true }
|
|
20529
|
+
```
|
|
20530
|
+
|
|
20531
|
+
```ts
|
|
20532
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
20533
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
20534
|
+
```
|
|
20535
|
+
|
|
20245
20536
|
</td>
|
|
20246
20537
|
<td>
|
|
20247
20538
|
|
|
20248
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20539
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20249
20540
|
|
|
20250
20541
|
</td>
|
|
20251
20542
|
</tr>
|
|
@@ -20280,7 +20571,7 @@ sort: {
|
|
|
20280
20571
|
</td>
|
|
20281
20572
|
<td>
|
|
20282
20573
|
|
|
20283
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20574
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20284
20575
|
|
|
20285
20576
|
</td>
|
|
20286
20577
|
</tr>
|
|
@@ -20291,7 +20582,7 @@ sort: {
|
|
|
20291
20582
|
|
|
20292
20583
|
### QueryOptionsFilter
|
|
20293
20584
|
|
|
20294
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20585
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:96](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L96)
|
|
20295
20586
|
|
|
20296
20587
|
Query options using the `where`-like filter object.
|
|
20297
20588
|
|
|
@@ -20367,7 +20658,7 @@ filters: { status: 'active', type: 'user' }
|
|
|
20367
20658
|
</td>
|
|
20368
20659
|
<td>
|
|
20369
20660
|
|
|
20370
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20661
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:106](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L106)
|
|
20371
20662
|
|
|
20372
20663
|
</td>
|
|
20373
20664
|
</tr>
|
|
@@ -20407,7 +20698,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20407
20698
|
</td>
|
|
20408
20699
|
<td>
|
|
20409
20700
|
|
|
20410
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20701
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20411
20702
|
|
|
20412
20703
|
</td>
|
|
20413
20704
|
</tr>
|
|
@@ -20448,7 +20739,7 @@ options: {
|
|
|
20448
20739
|
</td>
|
|
20449
20740
|
<td>
|
|
20450
20741
|
|
|
20451
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20742
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
20452
20743
|
|
|
20453
20744
|
</td>
|
|
20454
20745
|
</tr>
|
|
@@ -20460,7 +20751,7 @@ options: {
|
|
|
20460
20751
|
</td>
|
|
20461
20752
|
<td>
|
|
20462
20753
|
|
|
20463
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20754
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20464
20755
|
|
|
20465
20756
|
</td>
|
|
20466
20757
|
<td>
|
|
@@ -20470,13 +20761,23 @@ Array of entity relation properties to eager-load.
|
|
|
20470
20761
|
Specifies which related entities should be loaded along with the main entity.
|
|
20471
20762
|
This is transformed into TypeORM's relations option internally.
|
|
20472
20763
|
|
|
20473
|
-
**
|
|
20764
|
+
**Examples**
|
|
20474
20765
|
|
|
20475
20766
|
```ts
|
|
20476
|
-
//
|
|
20767
|
+
// Array-style relations
|
|
20477
20768
|
relations: ["profile", "posts"];
|
|
20478
20769
|
```
|
|
20479
20770
|
|
|
20771
|
+
```ts
|
|
20772
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
20773
|
+
relations: { profile: true, posts: true }
|
|
20774
|
+
```
|
|
20775
|
+
|
|
20776
|
+
```ts
|
|
20777
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
20778
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
20779
|
+
```
|
|
20780
|
+
|
|
20480
20781
|
</td>
|
|
20481
20782
|
<td>
|
|
20482
20783
|
|
|
@@ -20485,7 +20786,7 @@ relations: ["profile", "posts"];
|
|
|
20485
20786
|
</td>
|
|
20486
20787
|
<td>
|
|
20487
20788
|
|
|
20488
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20789
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20489
20790
|
|
|
20490
20791
|
</td>
|
|
20491
20792
|
</tr>
|
|
@@ -20525,7 +20826,7 @@ sort: {
|
|
|
20525
20826
|
</td>
|
|
20526
20827
|
<td>
|
|
20527
20828
|
|
|
20528
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20829
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20529
20830
|
|
|
20530
20831
|
</td>
|
|
20531
20832
|
</tr>
|
|
@@ -20553,7 +20854,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
20553
20854
|
</td>
|
|
20554
20855
|
<td>
|
|
20555
20856
|
|
|
20556
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20857
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:112](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L112)
|
|
20557
20858
|
|
|
20558
20859
|
</td>
|
|
20559
20860
|
</tr>
|
|
@@ -20564,7 +20865,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
20564
20865
|
|
|
20565
20866
|
### QueryOptionsNot
|
|
20566
20867
|
|
|
20567
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20868
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:205](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L205)
|
|
20568
20869
|
|
|
20569
20870
|
Options interface for exclusion-based CRUD operations.
|
|
20570
20871
|
|
|
@@ -20671,7 +20972,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20671
20972
|
</td>
|
|
20672
20973
|
<td>
|
|
20673
20974
|
|
|
20674
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20975
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20675
20976
|
|
|
20676
20977
|
</td>
|
|
20677
20978
|
</tr>
|
|
@@ -20707,7 +21008,7 @@ not: { role: 'admin', status: 'deleted' }
|
|
|
20707
21008
|
</td>
|
|
20708
21009
|
<td>
|
|
20709
21010
|
|
|
20710
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21011
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:232](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L232)
|
|
20711
21012
|
|
|
20712
21013
|
</td>
|
|
20713
21014
|
</tr>
|
|
@@ -20748,7 +21049,7 @@ options: {
|
|
|
20748
21049
|
</td>
|
|
20749
21050
|
<td>
|
|
20750
21051
|
|
|
20751
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21052
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
20752
21053
|
|
|
20753
21054
|
</td>
|
|
20754
21055
|
</tr>
|
|
@@ -20760,7 +21061,7 @@ options: {
|
|
|
20760
21061
|
</td>
|
|
20761
21062
|
<td>
|
|
20762
21063
|
|
|
20763
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21064
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20764
21065
|
|
|
20765
21066
|
</td>
|
|
20766
21067
|
<td>
|
|
@@ -20770,13 +21071,23 @@ Array of entity relation properties to eager-load.
|
|
|
20770
21071
|
Specifies which related entities should be loaded along with the main entity.
|
|
20771
21072
|
This is transformed into TypeORM's relations option internally.
|
|
20772
21073
|
|
|
20773
|
-
**
|
|
21074
|
+
**Examples**
|
|
20774
21075
|
|
|
20775
21076
|
```ts
|
|
20776
|
-
//
|
|
21077
|
+
// Array-style relations
|
|
20777
21078
|
relations: ["profile", "posts"];
|
|
20778
21079
|
```
|
|
20779
21080
|
|
|
21081
|
+
```ts
|
|
21082
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
21083
|
+
relations: { profile: true, posts: true }
|
|
21084
|
+
```
|
|
21085
|
+
|
|
21086
|
+
```ts
|
|
21087
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
21088
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
21089
|
+
```
|
|
21090
|
+
|
|
20780
21091
|
</td>
|
|
20781
21092
|
<td>
|
|
20782
21093
|
|
|
@@ -20785,7 +21096,7 @@ relations: ["profile", "posts"];
|
|
|
20785
21096
|
</td>
|
|
20786
21097
|
<td>
|
|
20787
21098
|
|
|
20788
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21099
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20789
21100
|
|
|
20790
21101
|
</td>
|
|
20791
21102
|
</tr>
|
|
@@ -20825,7 +21136,7 @@ sort: {
|
|
|
20825
21136
|
</td>
|
|
20826
21137
|
<td>
|
|
20827
21138
|
|
|
20828
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21139
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20829
21140
|
|
|
20830
21141
|
</td>
|
|
20831
21142
|
</tr>
|
|
@@ -20853,7 +21164,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
20853
21164
|
</td>
|
|
20854
21165
|
<td>
|
|
20855
21166
|
|
|
20856
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21167
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:238](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L238)
|
|
20857
21168
|
|
|
20858
21169
|
</td>
|
|
20859
21170
|
</tr>
|
|
@@ -20864,7 +21175,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
20864
21175
|
|
|
20865
21176
|
### QueryOptionsSearch
|
|
20866
21177
|
|
|
20867
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21178
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:140](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L140)
|
|
20868
21179
|
|
|
20869
21180
|
Options interface for search-based CRUD operations.
|
|
20870
21181
|
|
|
@@ -20971,7 +21282,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20971
21282
|
</td>
|
|
20972
21283
|
<td>
|
|
20973
21284
|
|
|
20974
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
21285
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20975
21286
|
|
|
20976
21287
|
</td>
|
|
20977
21288
|
</tr>
|
|
@@ -21012,7 +21323,7 @@ options: {
|
|
|
21012
21323
|
</td>
|
|
21013
21324
|
<td>
|
|
21014
21325
|
|
|
21015
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21326
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
21016
21327
|
|
|
21017
21328
|
</td>
|
|
21018
21329
|
</tr>
|
|
@@ -21024,7 +21335,7 @@ options: {
|
|
|
21024
21335
|
</td>
|
|
21025
21336
|
<td>
|
|
21026
21337
|
|
|
21027
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21338
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21028
21339
|
|
|
21029
21340
|
</td>
|
|
21030
21341
|
<td>
|
|
@@ -21034,13 +21345,23 @@ Array of entity relation properties to eager-load.
|
|
|
21034
21345
|
Specifies which related entities should be loaded along with the main entity.
|
|
21035
21346
|
This is transformed into TypeORM's relations option internally.
|
|
21036
21347
|
|
|
21037
|
-
**
|
|
21348
|
+
**Examples**
|
|
21038
21349
|
|
|
21039
21350
|
```ts
|
|
21040
|
-
//
|
|
21351
|
+
// Array-style relations
|
|
21041
21352
|
relations: ["profile", "posts"];
|
|
21042
21353
|
```
|
|
21043
21354
|
|
|
21355
|
+
```ts
|
|
21356
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
21357
|
+
relations: { profile: true, posts: true }
|
|
21358
|
+
```
|
|
21359
|
+
|
|
21360
|
+
```ts
|
|
21361
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
21362
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
21363
|
+
```
|
|
21364
|
+
|
|
21044
21365
|
</td>
|
|
21045
21366
|
<td>
|
|
21046
21367
|
|
|
@@ -21049,7 +21370,7 @@ relations: ["profile", "posts"];
|
|
|
21049
21370
|
</td>
|
|
21050
21371
|
<td>
|
|
21051
21372
|
|
|
21052
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21373
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
21053
21374
|
|
|
21054
21375
|
</td>
|
|
21055
21376
|
</tr>
|
|
@@ -21089,7 +21410,7 @@ search: {
|
|
|
21089
21410
|
</td>
|
|
21090
21411
|
<td>
|
|
21091
21412
|
|
|
21092
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21413
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:165](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L165)
|
|
21093
21414
|
|
|
21094
21415
|
</td>
|
|
21095
21416
|
</tr>
|
|
@@ -21129,7 +21450,7 @@ sort: {
|
|
|
21129
21450
|
</td>
|
|
21130
21451
|
<td>
|
|
21131
21452
|
|
|
21132
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21453
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
21133
21454
|
|
|
21134
21455
|
</td>
|
|
21135
21456
|
</tr>
|
|
@@ -21157,7 +21478,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21157
21478
|
</td>
|
|
21158
21479
|
<td>
|
|
21159
21480
|
|
|
21160
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21481
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:171](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L171)
|
|
21161
21482
|
|
|
21162
21483
|
</td>
|
|
21163
21484
|
</tr>
|
|
@@ -21168,7 +21489,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21168
21489
|
|
|
21169
21490
|
### QueryOptionsWhere
|
|
21170
21491
|
|
|
21171
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21492
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:268](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L268)
|
|
21172
21493
|
|
|
21173
21494
|
Options interface for direct WHERE clause CRUD operations.
|
|
21174
21495
|
|
|
@@ -21262,7 +21583,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21262
21583
|
</td>
|
|
21263
21584
|
<td>
|
|
21264
21585
|
|
|
21265
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21586
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:273](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L273)
|
|
21266
21587
|
|
|
21267
21588
|
</td>
|
|
21268
21589
|
</tr>
|
|
@@ -21302,7 +21623,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
21302
21623
|
</td>
|
|
21303
21624
|
<td>
|
|
21304
21625
|
|
|
21305
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
21626
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
21306
21627
|
|
|
21307
21628
|
</td>
|
|
21308
21629
|
</tr>
|
|
@@ -21330,7 +21651,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
21330
21651
|
</td>
|
|
21331
21652
|
<td>
|
|
21332
21653
|
|
|
21333
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21654
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:285](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L285)
|
|
21334
21655
|
|
|
21335
21656
|
</td>
|
|
21336
21657
|
</tr>
|
|
@@ -21371,7 +21692,7 @@ options: {
|
|
|
21371
21692
|
</td>
|
|
21372
21693
|
<td>
|
|
21373
21694
|
|
|
21374
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21695
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
21375
21696
|
|
|
21376
21697
|
</td>
|
|
21377
21698
|
</tr>
|
|
@@ -21383,7 +21704,7 @@ options: {
|
|
|
21383
21704
|
</td>
|
|
21384
21705
|
<td>
|
|
21385
21706
|
|
|
21386
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21707
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21387
21708
|
|
|
21388
21709
|
</td>
|
|
21389
21710
|
<td>
|
|
@@ -21393,13 +21714,23 @@ Array of entity relation properties to eager-load.
|
|
|
21393
21714
|
Specifies which related entities should be loaded along with the main entity.
|
|
21394
21715
|
This is transformed into TypeORM's relations option internally.
|
|
21395
21716
|
|
|
21396
|
-
**
|
|
21717
|
+
**Examples**
|
|
21397
21718
|
|
|
21398
21719
|
```ts
|
|
21399
|
-
//
|
|
21720
|
+
// Array-style relations
|
|
21400
21721
|
relations: ["profile", "posts"];
|
|
21401
21722
|
```
|
|
21402
21723
|
|
|
21724
|
+
```ts
|
|
21725
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
21726
|
+
relations: { profile: true, posts: true }
|
|
21727
|
+
```
|
|
21728
|
+
|
|
21729
|
+
```ts
|
|
21730
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
21731
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
21732
|
+
```
|
|
21733
|
+
|
|
21403
21734
|
</td>
|
|
21404
21735
|
<td>
|
|
21405
21736
|
|
|
@@ -21408,7 +21739,7 @@ relations: ["profile", "posts"];
|
|
|
21408
21739
|
</td>
|
|
21409
21740
|
<td>
|
|
21410
21741
|
|
|
21411
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21742
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
21412
21743
|
|
|
21413
21744
|
</td>
|
|
21414
21745
|
</tr>
|
|
@@ -21436,7 +21767,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21436
21767
|
</td>
|
|
21437
21768
|
<td>
|
|
21438
21769
|
|
|
21439
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21770
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:279](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L279)
|
|
21440
21771
|
|
|
21441
21772
|
</td>
|
|
21442
21773
|
</tr>
|
|
@@ -21476,7 +21807,7 @@ sort: {
|
|
|
21476
21807
|
</td>
|
|
21477
21808
|
<td>
|
|
21478
21809
|
|
|
21479
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21810
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
21480
21811
|
|
|
21481
21812
|
</td>
|
|
21482
21813
|
</tr>
|
|
@@ -21522,7 +21853,7 @@ where: [
|
|
|
21522
21853
|
</td>
|
|
21523
21854
|
<td>
|
|
21524
21855
|
|
|
21525
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21856
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:305](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L305)
|
|
21526
21857
|
|
|
21527
21858
|
</td>
|
|
21528
21859
|
</tr>
|
|
@@ -21533,7 +21864,7 @@ where: [
|
|
|
21533
21864
|
|
|
21534
21865
|
### SaveOptionsWithSkip
|
|
21535
21866
|
|
|
21536
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21867
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:574](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L574)
|
|
21537
21868
|
|
|
21538
21869
|
Extended save options interface with skip creation functionality.
|
|
21539
21870
|
|
|
@@ -21744,7 +22075,7 @@ skipCreate: true; // Only update existing entities, don't create new ones
|
|
|
21744
22075
|
</td>
|
|
21745
22076
|
<td>
|
|
21746
22077
|
|
|
21747
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22078
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:587](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L587)
|
|
21748
22079
|
|
|
21749
22080
|
</td>
|
|
21750
22081
|
</tr>
|
|
@@ -21789,7 +22120,7 @@ node_modules/typeorm/repository/SaveOptions.d.ts:19
|
|
|
21789
22120
|
type DatabaseTypes = "mysql" | "mariadb" | "postgres";
|
|
21790
22121
|
```
|
|
21791
22122
|
|
|
21792
|
-
Defined in: [libs/nest-crud/src/types/database.types.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
22123
|
+
Defined in: [libs/nest-crud/src/types/database.types.ts:37](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/database.types.ts#L37)
|
|
21793
22124
|
|
|
21794
22125
|
Supported database types for application connections.
|
|
21795
22126
|
|
|
@@ -21836,7 +22167,7 @@ const connectionOptions: ConnectionOptions = {
|
|
|
21836
22167
|
type EntityDecorator = (target) => void;
|
|
21837
22168
|
```
|
|
21838
22169
|
|
|
21839
|
-
Defined in: [libs/nest-crud/src/types/decorator.types.ts:64](https://github.com/hichchidev/hichchi/blob/
|
|
22170
|
+
Defined in: [libs/nest-crud/src/types/decorator.types.ts:64](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/decorator.types.ts#L64)
|
|
21840
22171
|
|
|
21841
22172
|
Type definition for decorators that target standard entity classes
|
|
21842
22173
|
|
|
@@ -21919,7 +22250,7 @@ export class UserEntity extends BaseEntity {
|
|
|
21919
22250
|
type EntityExtensionDecorator = (target) => void;
|
|
21920
22251
|
```
|
|
21921
22252
|
|
|
21922
|
-
Defined in: [libs/nest-crud/src/types/decorator.types.ts:108](https://github.com/hichchidev/hichchi/blob/
|
|
22253
|
+
Defined in: [libs/nest-crud/src/types/decorator.types.ts:108](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/decorator.types.ts#L108)
|
|
21923
22254
|
|
|
21924
22255
|
Type definition for decorators that target extended entity classes
|
|
21925
22256
|
|
|
@@ -22007,7 +22338,7 @@ export class ProductEntity extends BaseEntityExtension {
|
|
|
22007
22338
|
type EntityOptionUnique = object;
|
|
22008
22339
|
```
|
|
22009
22340
|
|
|
22010
|
-
Defined in: [libs/nest-crud/src/types/entity-option-unique.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
22341
|
+
Defined in: [libs/nest-crud/src/types/entity-option-unique.ts:51](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/entity-option-unique.ts#L51)
|
|
22011
22342
|
|
|
22012
22343
|
Configuration type for defining unique constraints on entity fields.
|
|
22013
22344
|
|
|
@@ -22085,7 +22416,7 @@ type FilterOptions<Entity> = {
|
|
|
22085
22416
|
};
|
|
22086
22417
|
```
|
|
22087
22418
|
|
|
22088
|
-
Defined in: [libs/nest-crud/src/types/filter-options.type.ts:60](https://github.com/hichchidev/hichchi/blob/
|
|
22419
|
+
Defined in: [libs/nest-crud/src/types/filter-options.type.ts:60](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/filter-options.type.ts#L60)
|
|
22089
22420
|
|
|
22090
22421
|
A recursive type for building structured filter conditions for entity queries.
|
|
22091
22422
|
|
|
@@ -22186,10 +22517,11 @@ type FindConditions<Entity> =
|
|
|
22186
22517
|
| Date[]
|
|
22187
22518
|
| ObjectId
|
|
22188
22519
|
| ObjectId[]
|
|
22189
|
-
| QueryDeepPartial<Entity
|
|
22520
|
+
| QueryDeepPartial<Entity>
|
|
22521
|
+
| QueryDeepPartial<Entity>[];
|
|
22190
22522
|
```
|
|
22191
22523
|
|
|
22192
|
-
Defined in: [libs/nest-crud/src/types/find-conditions.type.ts:59](https://github.com/hichchidev/hichchi/blob/
|
|
22524
|
+
Defined in: [libs/nest-crud/src/types/find-conditions.type.ts:59](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/find-conditions.type.ts#L59)
|
|
22193
22525
|
|
|
22194
22526
|
A flexible type for defining query conditions when finding entities.
|
|
22195
22527
|
|
|
@@ -22278,7 +22610,7 @@ async function findUsers(conditions: FindConditions<User>): Promise<User[]> {
|
|
|
22278
22610
|
type GetAllOptions<Entity> = PaginatedGetOptions<Entity>;
|
|
22279
22611
|
```
|
|
22280
22612
|
|
|
22281
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22613
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:666](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L666)
|
|
22282
22614
|
|
|
22283
22615
|
Simple options type for retrieving all entities with pagination.
|
|
22284
22616
|
|
|
@@ -22331,7 +22663,7 @@ const [users, count] = await userService.findAll(options);
|
|
|
22331
22663
|
type GetByIdOptions<Entity> = Omit<QueryOptions<Entity>, "sort">;
|
|
22332
22664
|
```
|
|
22333
22665
|
|
|
22334
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22666
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:397](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L397)
|
|
22335
22667
|
|
|
22336
22668
|
Options interface for retrieving a single entity by its ID.
|
|
22337
22669
|
|
|
@@ -22387,7 +22719,7 @@ type GetManyOptions<Entity> =
|
|
|
22387
22719
|
| GetManyOptionsWhere<Entity>;
|
|
22388
22720
|
```
|
|
22389
22721
|
|
|
22390
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22722
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:701](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L701)
|
|
22391
22723
|
|
|
22392
22724
|
Union type for all options interfaces for retrieving multiple entities with pagination.
|
|
22393
22725
|
|
|
@@ -22459,7 +22791,7 @@ type GetOneOptions<Entity> =
|
|
|
22459
22791
|
| GetOneOptionsWhere<Entity>;
|
|
22460
22792
|
```
|
|
22461
22793
|
|
|
22462
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22794
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:642](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L642)
|
|
22463
22795
|
|
|
22464
22796
|
Union type for all options interfaces for retrieving a single entity.
|
|
22465
22797
|
|
|
@@ -22518,7 +22850,7 @@ type GetOptions<Entity> =
|
|
|
22518
22850
|
| (QueryOptionsWhere<Entity> & PaginatedGetOptions<Entity>);
|
|
22519
22851
|
```
|
|
22520
22852
|
|
|
22521
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22853
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:614](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L614)
|
|
22522
22854
|
|
|
22523
22855
|
Comprehensive options type for retrieving entities with various filtering approaches and pagination.
|
|
22524
22856
|
|
|
@@ -22575,7 +22907,7 @@ const [users, count] = await getUsers({
|
|
|
22575
22907
|
type RepositoryDecorator = <T>(target) => T | void;
|
|
22576
22908
|
```
|
|
22577
22909
|
|
|
22578
|
-
Defined in: [libs/nest-crud/src/types/repository-decorator.type.ts:47](https://github.com/hichchidev/hichchi/blob/
|
|
22910
|
+
Defined in: [libs/nest-crud/src/types/repository-decorator.type.ts:47](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/repository-decorator.type.ts#L47)
|
|
22579
22911
|
|
|
22580
22912
|
Type definition for repository class decorators.
|
|
22581
22913
|
|
|
@@ -22695,7 +23027,7 @@ class UserRepository extends BaseRepository<User> {
|
|
|
22695
23027
|
type SaveAndGetOptions<Entity> = SaveOptionsWithSkip & GetByIdOptions<Entity>;
|
|
22696
23028
|
```
|
|
22697
23029
|
|
|
22698
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
23030
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:744](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L744)
|
|
22699
23031
|
|
|
22700
23032
|
Combined options type for save-and-get operations.
|
|
22701
23033
|
|
|
@@ -22766,7 +23098,7 @@ const updatedUser = await userService.saveAndGet(userData, options);
|
|
|
22766
23098
|
type SortOptions<Entity> = FindOptionsOrder<Entity>;
|
|
22767
23099
|
```
|
|
22768
23100
|
|
|
22769
|
-
Defined in: [libs/nest-crud/src/types/sort-options.type.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
23101
|
+
Defined in: [libs/nest-crud/src/types/sort-options.type.ts:56](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/sort-options.type.ts#L56)
|
|
22770
23102
|
|
|
22771
23103
|
Type alias for TypeORM's sorting configuration.
|
|
22772
23104
|
|
|
@@ -22858,7 +23190,7 @@ const users = await userRepository.find({
|
|
|
22858
23190
|
type TypeORMErrorHandler = (error) => Error | void;
|
|
22859
23191
|
```
|
|
22860
23192
|
|
|
22861
|
-
Defined in: [libs/nest-crud/src/types/error-handler.type.ts:54](https://github.com/hichchidev/hichchi/blob/
|
|
23193
|
+
Defined in: [libs/nest-crud/src/types/error-handler.type.ts:54](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/types/error-handler.type.ts#L54)
|
|
22862
23194
|
|
|
22863
23195
|
A function type for custom TypeORM error handling.
|
|
22864
23196
|
|
|
@@ -22961,7 +23293,7 @@ try {
|
|
|
22961
23293
|
const BaseEntityTemplateRelations: string[];
|
|
22962
23294
|
```
|
|
22963
23295
|
|
|
22964
|
-
Defined in: [libs/nest-crud/src/base/base-entity.ts:19](https://github.com/hichchidev/hichchi/blob/
|
|
23296
|
+
Defined in: [libs/nest-crud/src/base/base-entity.ts:19](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/base/base-entity.ts#L19)
|
|
22965
23297
|
|
|
22966
23298
|
List of standard relation properties in the BaseEntity
|
|
22967
23299
|
|
|
@@ -22985,7 +23317,7 @@ standard relations from foreign key constraint validation.
|
|
|
22985
23317
|
const CONNECTION_OPTIONS: "CONNECTION_OPTIONS" = "CONNECTION_OPTIONS";
|
|
22986
23318
|
```
|
|
22987
23319
|
|
|
22988
|
-
Defined in: [libs/nest-crud/src/tokens.ts:29](https://github.com/hichchidev/hichchi/blob/
|
|
23320
|
+
Defined in: [libs/nest-crud/src/tokens.ts:29](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/tokens.ts#L29)
|
|
22989
23321
|
|
|
22990
23322
|
Token for database connection options
|
|
22991
23323
|
|
|
@@ -23025,7 +23357,7 @@ export class AppModule {}
|
|
|
23025
23357
|
const DEFAULT_MAX_RECURSION_DEPTH: 10 = 10;
|
|
23026
23358
|
```
|
|
23027
23359
|
|
|
23028
|
-
Defined in: [libs/nest-crud/src/constants.ts:21](https://github.com/hichchidev/hichchi/blob/
|
|
23360
|
+
Defined in: [libs/nest-crud/src/constants.ts:21](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L21)
|
|
23029
23361
|
|
|
23030
23362
|
Default maximum recursion depth for deep object operations
|
|
23031
23363
|
|
|
@@ -23057,7 +23389,7 @@ toQueryDeepPartialEntity Function that uses this constant to limit recursion dep
|
|
|
23057
23389
|
const EXTRACT_INVALID_COLUMN_REGEX: RegExp;
|
|
23058
23390
|
```
|
|
23059
23391
|
|
|
23060
|
-
Defined in: [libs/nest-crud/src/constants.ts:106](https://github.com/hichchidev/hichchi/blob/
|
|
23392
|
+
Defined in: [libs/nest-crud/src/constants.ts:106](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L106)
|
|
23061
23393
|
|
|
23062
23394
|
Regular expression for extracting column names from database column not found errors
|
|
23063
23395
|
|
|
@@ -23087,7 +23419,7 @@ EntityUtils.handleError Method that uses this pattern to extract column names fr
|
|
|
23087
23419
|
const EXTRACT_INVALID_QUERY_FIELD_REGEX: RegExp;
|
|
23088
23420
|
```
|
|
23089
23421
|
|
|
23090
|
-
Defined in: [libs/nest-crud/src/constants.ts:86](https://github.com/hichchidev/hichchi/blob/
|
|
23422
|
+
Defined in: [libs/nest-crud/src/constants.ts:86](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L86)
|
|
23091
23423
|
|
|
23092
23424
|
Regular expression for extracting field names from TypeORM property not found errors
|
|
23093
23425
|
|
|
@@ -23117,7 +23449,7 @@ EntityUtils.handleError Method that uses this pattern to extract field names fro
|
|
|
23117
23449
|
const FK_CONSTRAINT_REGEX: RegExp;
|
|
23118
23450
|
```
|
|
23119
23451
|
|
|
23120
|
-
Defined in: [libs/nest-crud/src/constants.ts:66](https://github.com/hichchidev/hichchi/blob/
|
|
23452
|
+
Defined in: [libs/nest-crud/src/constants.ts:66](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L66)
|
|
23121
23453
|
|
|
23122
23454
|
Regular expression for validating foreign key constraint naming convention
|
|
23123
23455
|
|
|
@@ -23150,7 +23482,7 @@ The format is: FK_entityName_relatedEntityName
|
|
|
23150
23482
|
const ID_PATH: "id" = "id";
|
|
23151
23483
|
```
|
|
23152
23484
|
|
|
23153
|
-
Defined in: [libs/nest-crud/src/constants.ts:108](https://github.com/hichchidev/hichchi/blob/
|
|
23485
|
+
Defined in: [libs/nest-crud/src/constants.ts:108](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L108)
|
|
23154
23486
|
|
|
23155
23487
|
---
|
|
23156
23488
|
|
|
@@ -23160,7 +23492,7 @@ Defined in: [libs/nest-crud/src/constants.ts:108](https://github.com/hichchidev/
|
|
|
23160
23492
|
const ID_PATH_VAR: ":id";
|
|
23161
23493
|
```
|
|
23162
23494
|
|
|
23163
|
-
Defined in: [libs/nest-crud/src/constants.ts:110](https://github.com/hichchidev/hichchi/blob/
|
|
23495
|
+
Defined in: [libs/nest-crud/src/constants.ts:110](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L110)
|
|
23164
23496
|
|
|
23165
23497
|
---
|
|
23166
23498
|
|
|
@@ -23221,7 +23553,7 @@ Defined in: node_modules/@nestjs/typeorm/dist/common/typeorm.decorators.d.ts:4
|
|
|
23221
23553
|
const UNIQUE_CONSTRAINT_REGEX: RegExp;
|
|
23222
23554
|
```
|
|
23223
23555
|
|
|
23224
|
-
Defined in: [libs/nest-crud/src/constants.ts:43](https://github.com/hichchidev/hichchi/blob/
|
|
23556
|
+
Defined in: [libs/nest-crud/src/constants.ts:43](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/constants.ts#L43)
|
|
23225
23557
|
|
|
23226
23558
|
Regular expression for validating unique constraint naming convention
|
|
23227
23559
|
|
|
@@ -23253,7 +23585,7 @@ The format is: UNIQUE_entityName_fieldName
|
|
|
23253
23585
|
const USER_ENTITY_TABLE_NAME: "users" = "users";
|
|
23254
23586
|
```
|
|
23255
23587
|
|
|
23256
|
-
Defined in: [libs/nest-crud/src/tokens.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
23588
|
+
Defined in: [libs/nest-crud/src/tokens.ts:56](https://github.com/hichchidev/hichchi/blob/7a34875f41fbc37ae8354ec8276cde73a8661476/libs/nest-crud/src/tokens.ts#L56)
|
|
23257
23589
|
|
|
23258
23590
|
Standard table name for user entities
|
|
23259
23591
|
|