@hichchi/nest-crud 0.0.7 → 0.0.9
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 +689 -356
- 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 +60 -12
- package/base/base-user.entity.js +68 -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
|
|
@@ -1437,7 +1441,7 @@ Complete technical reference for all classes, interfaces, methods, and types in
|
|
|
1437
1441
|
- [BulkDeleteDto](#bulkdeletedto-1)
|
|
1438
1442
|
- [`abstract` CrudService](#abstract-crudservice)
|
|
1439
1443
|
- [HichchiCrudModule](#hichchicrudmodule)
|
|
1440
|
-
- [HichchiUserEntity](#hichchiuserentity
|
|
1444
|
+
- [`abstract` HichchiUserEntity](#abstract-hichchiuserentity)
|
|
1441
1445
|
- [IdsDto](#idsdto)
|
|
1442
1446
|
- [Repository](#repository)
|
|
1443
1447
|
- [Enumerations](#enumerations)
|
|
@@ -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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/crud.module.ts#L35)
|
|
11149
11162
|
|
|
11150
11163
|
Module for integrating TypeORM with NestJS and providing CRUD functionality
|
|
11151
11164
|
|
|
@@ -11168,7 +11181,7 @@ and in feature modules (via `forFeature`) to register specific entities.
|
|
|
11168
11181
|
|
|
11169
11182
|
- [BaseEntity](#baseentity) The base entity class that custom entities should extend
|
|
11170
11183
|
- [BaseEntityExtension](#baseentityextension) Alternative base entity with extended functionality
|
|
11171
|
-
- [HichchiUserEntity](#hichchiuserentity) Specialized entity for user management
|
|
11184
|
+
- [HichchiUserEntity](#abstract-hichchiuserentity) Specialized entity for user management
|
|
11172
11185
|
- EntityUtils Utility class for entity operations
|
|
11173
11186
|
|
|
11174
11187
|
#### Constructors
|
|
@@ -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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/crud.module.ts#L206)
|
|
11340
11353
|
|
|
11341
11354
|
Validates entities for registration with the HichchiCrudModule
|
|
11342
11355
|
|
|
@@ -11394,14 +11407,14 @@ Array of entity classes to validate
|
|
|
11394
11407
|
|
|
11395
11408
|
- [BaseEntity](#baseentity) The primary base entity class
|
|
11396
11409
|
- [BaseEntityExtension](#baseentityextension) Alternative base entity with extended functionality
|
|
11397
|
-
- [HichchiUserEntity](#hichchiuserentity) Specialized entity for user management
|
|
11410
|
+
- [HichchiUserEntity](#abstract-hichchiuserentity) Specialized entity for user management
|
|
11398
11411
|
- [forFeature](#forfeature) The method that uses this validation
|
|
11399
11412
|
|
|
11400
11413
|
---
|
|
11401
11414
|
|
|
11402
|
-
### HichchiUserEntity
|
|
11415
|
+
### `abstract` HichchiUserEntity
|
|
11403
11416
|
|
|
11404
|
-
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:
|
|
11417
|
+
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:52](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L52)
|
|
11405
11418
|
|
|
11406
11419
|
Base user entity class that provides common user fields and functionality
|
|
11407
11420
|
|
|
@@ -11414,6 +11427,7 @@ Key features:
|
|
|
11414
11427
|
|
|
11415
11428
|
- Provides firstName, lastName, and fullName properties required by UserInfo
|
|
11416
11429
|
- Automatically maintains the fullName property based on firstName and lastName
|
|
11430
|
+
- Provides extensibility points for role and tenant features so implementations can add them only when needed, while still aligning with Role Guards and tenant utilities like CurrentTenantId decorators
|
|
11417
11431
|
- Inherits all audit tracking capabilities from BaseEntity
|
|
11418
11432
|
|
|
11419
11433
|
Application-specific user entities should extend this class and add additional
|
|
@@ -11445,7 +11459,7 @@ UserInfo The interface that defines the required user properties
|
|
|
11445
11459
|
|
|
11446
11460
|
#### Implements
|
|
11447
11461
|
|
|
11448
|
-
- `
|
|
11462
|
+
- `User`
|
|
11449
11463
|
- `Model`
|
|
11450
11464
|
|
|
11451
11465
|
#### Constructors
|
|
@@ -11458,7 +11472,7 @@ new HichchiUserEntity(): HichchiUserEntity;
|
|
|
11458
11472
|
|
|
11459
11473
|
###### Returns
|
|
11460
11474
|
|
|
11461
|
-
[`HichchiUserEntity`](#hichchiuserentity)
|
|
11475
|
+
[`HichchiUserEntity`](#abstract-hichchiuserentity)
|
|
11462
11476
|
|
|
11463
11477
|
#### Methods
|
|
11464
11478
|
|
|
@@ -11468,7 +11482,7 @@ new HichchiUserEntity(): HichchiUserEntity;
|
|
|
11468
11482
|
protected optional afterLoad(): void;
|
|
11469
11483
|
```
|
|
11470
11484
|
|
|
11471
|
-
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:
|
|
11485
|
+
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:300](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L300)
|
|
11472
11486
|
|
|
11473
11487
|
Lifecycle hook that runs after an entity is loaded from the database
|
|
11474
11488
|
|
|
@@ -11491,7 +11505,7 @@ UserInfo The interface that defines the user information structure
|
|
|
11491
11505
|
protected optional beforeInsert(): void;
|
|
11492
11506
|
```
|
|
11493
11507
|
|
|
11494
|
-
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:
|
|
11508
|
+
Defined in: [libs/nest-crud/src/base/base-user.entity.ts:285](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L285)
|
|
11495
11509
|
|
|
11496
11510
|
Lifecycle hooks that run before an entity is inserted or updated
|
|
11497
11511
|
|
|
@@ -11528,12 +11542,15 @@ concatenating the firstName and lastName properties.
|
|
|
11528
11542
|
</td>
|
|
11529
11543
|
<td>
|
|
11530
11544
|
|
|
11531
|
-
|
|
11545
|
+
URL or path to the user's profile avatar image.
|
|
11546
|
+
|
|
11547
|
+
This field is optional and may be populated from uploaded images or
|
|
11548
|
+
third-party identity providers.
|
|
11532
11549
|
|
|
11533
11550
|
</td>
|
|
11534
11551
|
<td>
|
|
11535
11552
|
|
|
11536
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11553
|
+
[libs/nest-crud/src/base/base-user.entity.ts:221](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L221)
|
|
11537
11554
|
|
|
11538
11555
|
</td>
|
|
11539
11556
|
</tr>
|
|
@@ -11558,7 +11575,7 @@ It is not nullable and cannot be changed after creation.
|
|
|
11558
11575
|
</td>
|
|
11559
11576
|
<td>
|
|
11560
11577
|
|
|
11561
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11578
|
+
[libs/nest-crud/src/base/base-user.entity.ts:69](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L69)
|
|
11562
11579
|
|
|
11563
11580
|
</td>
|
|
11564
11581
|
</tr>
|
|
@@ -11583,7 +11600,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
11583
11600
|
</td>
|
|
11584
11601
|
<td>
|
|
11585
11602
|
|
|
11586
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11603
|
+
[libs/nest-crud/src/base/base-user.entity.ts:106](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L106)
|
|
11587
11604
|
|
|
11588
11605
|
</td>
|
|
11589
11606
|
</tr>
|
|
@@ -11608,7 +11625,7 @@ It is used for the foreign key relationship with the createdBy field.
|
|
|
11608
11625
|
</td>
|
|
11609
11626
|
<td>
|
|
11610
11627
|
|
|
11611
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11628
|
+
[libs/nest-crud/src/base/base-user.entity.ts:96](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L96)
|
|
11612
11629
|
|
|
11613
11630
|
</td>
|
|
11614
11631
|
</tr>
|
|
@@ -11633,7 +11650,7 @@ soft delete functionality. When this field has a value, the entity is considered
|
|
|
11633
11650
|
</td>
|
|
11634
11651
|
<td>
|
|
11635
11652
|
|
|
11636
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11653
|
+
[libs/nest-crud/src/base/base-user.entity.ts:87](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L87)
|
|
11637
11654
|
|
|
11638
11655
|
</td>
|
|
11639
11656
|
</tr>
|
|
@@ -11658,7 +11675,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
11658
11675
|
</td>
|
|
11659
11676
|
<td>
|
|
11660
11677
|
|
|
11661
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11678
|
+
[libs/nest-crud/src/base/base-user.entity.ts:144](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L144)
|
|
11662
11679
|
|
|
11663
11680
|
</td>
|
|
11664
11681
|
</tr>
|
|
@@ -11683,7 +11700,7 @@ It is used for the foreign key relationship with the deletedBy field.
|
|
|
11683
11700
|
</td>
|
|
11684
11701
|
<td>
|
|
11685
11702
|
|
|
11686
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11703
|
+
[libs/nest-crud/src/base/base-user.entity.ts:134](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L134)
|
|
11687
11704
|
|
|
11688
11705
|
</td>
|
|
11689
11706
|
</tr>
|
|
@@ -11709,7 +11726,7 @@ or uses alternative authentication methods.
|
|
|
11709
11726
|
</td>
|
|
11710
11727
|
<td>
|
|
11711
11728
|
|
|
11712
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11729
|
+
[libs/nest-crud/src/base/base-user.entity.ts:183](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L183)
|
|
11713
11730
|
|
|
11714
11731
|
</td>
|
|
11715
11732
|
</tr>
|
|
@@ -11726,12 +11743,15 @@ or uses alternative authentication methods.
|
|
|
11726
11743
|
</td>
|
|
11727
11744
|
<td>
|
|
11728
11745
|
|
|
11729
|
-
|
|
11746
|
+
Indicates whether the user's email address has been verified.
|
|
11747
|
+
|
|
11748
|
+
Used to enforce verification-dependent flows and prevent unverified
|
|
11749
|
+
accounts from accessing restricted features.
|
|
11730
11750
|
|
|
11731
11751
|
</td>
|
|
11732
11752
|
<td>
|
|
11733
11753
|
|
|
11734
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11754
|
+
[libs/nest-crud/src/base/base-user.entity.ts:212](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L212)
|
|
11735
11755
|
|
|
11736
11756
|
</td>
|
|
11737
11757
|
</tr>
|
|
@@ -11757,7 +11777,7 @@ be null.
|
|
|
11757
11777
|
</td>
|
|
11758
11778
|
<td>
|
|
11759
11779
|
|
|
11760
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11780
|
+
[libs/nest-crud/src/base/base-user.entity.ts:154](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L154)
|
|
11761
11781
|
|
|
11762
11782
|
</td>
|
|
11763
11783
|
</tr>
|
|
@@ -11783,7 +11803,7 @@ automatically maintained by the beforeInsert and beforeUpdate hooks.
|
|
|
11783
11803
|
</td>
|
|
11784
11804
|
<td>
|
|
11785
11805
|
|
|
11786
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11806
|
+
[libs/nest-crud/src/base/base-user.entity.ts:173](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L173)
|
|
11787
11807
|
|
|
11788
11808
|
</td>
|
|
11789
11809
|
</tr>
|
|
@@ -11808,7 +11828,7 @@ It serves as the primary key for the entity in the database.
|
|
|
11808
11828
|
</td>
|
|
11809
11829
|
<td>
|
|
11810
11830
|
|
|
11811
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11831
|
+
[libs/nest-crud/src/base/base-user.entity.ts:60](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L60)
|
|
11812
11832
|
|
|
11813
11833
|
</td>
|
|
11814
11834
|
</tr>
|
|
@@ -11833,7 +11853,7 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11833
11853
|
</td>
|
|
11834
11854
|
<td>
|
|
11835
11855
|
|
|
11836
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11856
|
+
[libs/nest-crud/src/base/base-user.entity.ts:163](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L163)
|
|
11837
11857
|
|
|
11838
11858
|
</td>
|
|
11839
11859
|
</tr>
|
|
@@ -11850,12 +11870,15 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11850
11870
|
</td>
|
|
11851
11871
|
<td>
|
|
11852
11872
|
|
|
11853
|
-
|
|
11873
|
+
The user's password (stored in hashed form).
|
|
11874
|
+
|
|
11875
|
+
This value is excluded from serialized responses and should never contain
|
|
11876
|
+
plaintext credentials. It may be null for users authenticated via external providers.
|
|
11854
11877
|
|
|
11855
11878
|
</td>
|
|
11856
11879
|
<td>
|
|
11857
11880
|
|
|
11858
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11881
|
+
[libs/nest-crud/src/base/base-user.entity.ts:203](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L203)
|
|
11859
11882
|
|
|
11860
11883
|
</td>
|
|
11861
11884
|
</tr>
|
|
@@ -11872,12 +11895,63 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11872
11895
|
</td>
|
|
11873
11896
|
<td>
|
|
11874
11897
|
|
|
11875
|
-
|
|
11898
|
+
Additional profile information associated with the user.
|
|
11899
|
+
|
|
11900
|
+
Stores provider-specific or extended profile attributes in JSON format.
|
|
11901
|
+
|
|
11902
|
+
</td>
|
|
11903
|
+
<td>
|
|
11904
|
+
|
|
11905
|
+
[libs/nest-crud/src/base/base-user.entity.ts:229](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L229)
|
|
11906
|
+
|
|
11907
|
+
</td>
|
|
11908
|
+
</tr>
|
|
11909
|
+
<tr>
|
|
11910
|
+
<td>
|
|
11911
|
+
|
|
11912
|
+
<a id="property-role"></a> `role?`
|
|
11913
|
+
|
|
11914
|
+
</td>
|
|
11915
|
+
<td>
|
|
11916
|
+
|
|
11917
|
+
`string` | `Role`<`string`, `string`> | `null`
|
|
11876
11918
|
|
|
11877
11919
|
</td>
|
|
11878
11920
|
<td>
|
|
11879
11921
|
|
|
11880
|
-
|
|
11922
|
+
The authorization role assigned to the user.
|
|
11923
|
+
|
|
11924
|
+
Stores either a role identifier string or a populated role object,
|
|
11925
|
+
depending on how the entity is loaded and mapped.
|
|
11926
|
+
|
|
11927
|
+
</td>
|
|
11928
|
+
<td>
|
|
11929
|
+
|
|
11930
|
+
[libs/nest-crud/src/base/base-user.entity.ts:246](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L246)
|
|
11931
|
+
|
|
11932
|
+
</td>
|
|
11933
|
+
</tr>
|
|
11934
|
+
<tr>
|
|
11935
|
+
<td>
|
|
11936
|
+
|
|
11937
|
+
<a id="property-roleid"></a> `roleId?`
|
|
11938
|
+
|
|
11939
|
+
</td>
|
|
11940
|
+
<td>
|
|
11941
|
+
|
|
11942
|
+
`EntityId` | `null`
|
|
11943
|
+
|
|
11944
|
+
</td>
|
|
11945
|
+
<td>
|
|
11946
|
+
|
|
11947
|
+
The unique identifier of the user's role.
|
|
11948
|
+
|
|
11949
|
+
Optional foreign key reference to the role entity for direct relational access.
|
|
11950
|
+
|
|
11951
|
+
</td>
|
|
11952
|
+
<td>
|
|
11953
|
+
|
|
11954
|
+
[libs/nest-crud/src/base/base-user.entity.ts:254](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L254)
|
|
11881
11955
|
|
|
11882
11956
|
</td>
|
|
11883
11957
|
</tr>
|
|
@@ -11894,24 +11968,26 @@ for formal addressing and identification. It is required and cannot be null.
|
|
|
11894
11968
|
</td>
|
|
11895
11969
|
<td>
|
|
11896
11970
|
|
|
11897
|
-
|
|
11971
|
+
Authentication provider used when the account was created.
|
|
11972
|
+
|
|
11973
|
+
Determines which sign-in flow and credential requirements apply to the user.
|
|
11898
11974
|
|
|
11899
11975
|
</td>
|
|
11900
11976
|
<td>
|
|
11901
11977
|
|
|
11902
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
11978
|
+
[libs/nest-crud/src/base/base-user.entity.ts:237](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L237)
|
|
11903
11979
|
|
|
11904
11980
|
</td>
|
|
11905
11981
|
</tr>
|
|
11906
11982
|
<tr>
|
|
11907
11983
|
<td>
|
|
11908
11984
|
|
|
11909
|
-
<a id="property-tenant"></a> `tenant
|
|
11985
|
+
<a id="property-tenant"></a> `tenant?`
|
|
11910
11986
|
|
|
11911
11987
|
</td>
|
|
11912
11988
|
<td>
|
|
11913
11989
|
|
|
11914
|
-
`TenantSlug` | `null`
|
|
11990
|
+
`TenantSlug` | `Tenant` | `null`
|
|
11915
11991
|
|
|
11916
11992
|
</td>
|
|
11917
11993
|
<td>
|
|
@@ -11927,7 +12003,31 @@ This variable is often used to scope application logic and data to a specific te
|
|
|
11927
12003
|
</td>
|
|
11928
12004
|
<td>
|
|
11929
12005
|
|
|
11930
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12006
|
+
[libs/nest-crud/src/base/base-user.entity.ts:266](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L266)
|
|
12007
|
+
|
|
12008
|
+
</td>
|
|
12009
|
+
</tr>
|
|
12010
|
+
<tr>
|
|
12011
|
+
<td>
|
|
12012
|
+
|
|
12013
|
+
<a id="property-tenantid"></a> `tenantId?`
|
|
12014
|
+
|
|
12015
|
+
</td>
|
|
12016
|
+
<td>
|
|
12017
|
+
|
|
12018
|
+
`EntityId` | `null`
|
|
12019
|
+
|
|
12020
|
+
</td>
|
|
12021
|
+
<td>
|
|
12022
|
+
|
|
12023
|
+
The unique identifier of the user's tenant.
|
|
12024
|
+
|
|
12025
|
+
Optional foreign key reference used to scope data to a tenant context.
|
|
12026
|
+
|
|
12027
|
+
</td>
|
|
12028
|
+
<td>
|
|
12029
|
+
|
|
12030
|
+
[libs/nest-crud/src/base/base-user.entity.ts:274](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L274)
|
|
11931
12031
|
|
|
11932
12032
|
</td>
|
|
11933
12033
|
</tr>
|
|
@@ -11952,7 +12052,7 @@ and updated whenever the entity is modified.
|
|
|
11952
12052
|
</td>
|
|
11953
12053
|
<td>
|
|
11954
12054
|
|
|
11955
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12055
|
+
[libs/nest-crud/src/base/base-user.entity.ts:78](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L78)
|
|
11956
12056
|
|
|
11957
12057
|
</td>
|
|
11958
12058
|
</tr>
|
|
@@ -11977,7 +12077,7 @@ It is automatically loaded when the entity is retrieved with relations.
|
|
|
11977
12077
|
</td>
|
|
11978
12078
|
<td>
|
|
11979
12079
|
|
|
11980
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12080
|
+
[libs/nest-crud/src/base/base-user.entity.ts:125](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L125)
|
|
11981
12081
|
|
|
11982
12082
|
</td>
|
|
11983
12083
|
</tr>
|
|
@@ -12002,7 +12102,7 @@ It is used for the foreign key relationship with the updatedBy field.
|
|
|
12002
12102
|
</td>
|
|
12003
12103
|
<td>
|
|
12004
12104
|
|
|
12005
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12105
|
+
[libs/nest-crud/src/base/base-user.entity.ts:115](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L115)
|
|
12006
12106
|
|
|
12007
12107
|
</td>
|
|
12008
12108
|
</tr>
|
|
@@ -12028,7 +12128,7 @@ alternative authentication methods like email-only authentication.
|
|
|
12028
12128
|
</td>
|
|
12029
12129
|
<td>
|
|
12030
12130
|
|
|
12031
|
-
[libs/nest-crud/src/base/base-user.entity.ts:
|
|
12131
|
+
[libs/nest-crud/src/base/base-user.entity.ts:193](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-user.entity.ts#L193)
|
|
12032
12132
|
|
|
12033
12133
|
</td>
|
|
12034
12134
|
</tr>
|
|
@@ -12039,7 +12139,7 @@ alternative authentication methods like email-only authentication.
|
|
|
12039
12139
|
|
|
12040
12140
|
### IdsDto
|
|
12041
12141
|
|
|
12042
|
-
Defined in: [libs/nest-crud/src/dtos/ids.dto.ts:10](https://github.com/hichchidev/hichchi/blob/
|
|
12142
|
+
Defined in: [libs/nest-crud/src/dtos/ids.dto.ts:10](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/dtos/ids.dto.ts#L10)
|
|
12043
12143
|
|
|
12044
12144
|
#### Implements
|
|
12045
12145
|
|
|
@@ -12081,7 +12181,7 @@ new IdsDto(): IdsDto;
|
|
|
12081
12181
|
</td>
|
|
12082
12182
|
<td>
|
|
12083
12183
|
|
|
12084
|
-
[libs/nest-crud/src/dtos/ids.dto.ts:14](https://github.com/hichchidev/hichchi/blob/
|
|
12184
|
+
[libs/nest-crud/src/dtos/ids.dto.ts:14](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/dtos/ids.dto.ts#L14)
|
|
12085
12185
|
|
|
12086
12186
|
</td>
|
|
12087
12187
|
</tr>
|
|
@@ -15198,7 +15298,7 @@ node_modules/typeorm/repository/Repository.d.ts:28
|
|
|
15198
15298
|
|
|
15199
15299
|
### Operation
|
|
15200
15300
|
|
|
15201
|
-
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:50](https://github.com/hichchidev/hichchi/blob/
|
|
15301
|
+
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:50](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L50)
|
|
15202
15302
|
|
|
15203
15303
|
CRUD Operations Enum
|
|
15204
15304
|
|
|
@@ -15244,7 +15344,7 @@ and performs any initialization logic required for new entities.
|
|
|
15244
15344
|
</td>
|
|
15245
15345
|
<td>
|
|
15246
15346
|
|
|
15247
|
-
[libs/nest-crud/src/enums/crud.enums.ts:58](https://github.com/hichchidev/hichchi/blob/
|
|
15347
|
+
[libs/nest-crud/src/enums/crud.enums.ts:58](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L58)
|
|
15248
15348
|
|
|
15249
15349
|
</td>
|
|
15250
15350
|
</tr>
|
|
@@ -15270,7 +15370,7 @@ enforce referential integrity constraints, depending on the configuration.
|
|
|
15270
15370
|
</td>
|
|
15271
15371
|
<td>
|
|
15272
15372
|
|
|
15273
|
-
[libs/nest-crud/src/enums/crud.enums.ts:85](https://github.com/hichchidev/hichchi/blob/
|
|
15373
|
+
[libs/nest-crud/src/enums/crud.enums.ts:85](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L85)
|
|
15274
15374
|
|
|
15275
15375
|
</td>
|
|
15276
15376
|
</tr>
|
|
@@ -15296,7 +15396,7 @@ entity already exists in the database.
|
|
|
15296
15396
|
</td>
|
|
15297
15397
|
<td>
|
|
15298
15398
|
|
|
15299
|
-
[libs/nest-crud/src/enums/crud.enums.ts:76](https://github.com/hichchidev/hichchi/blob/
|
|
15399
|
+
[libs/nest-crud/src/enums/crud.enums.ts:76](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L76)
|
|
15300
15400
|
|
|
15301
15401
|
</td>
|
|
15302
15402
|
</tr>
|
|
@@ -15322,7 +15422,7 @@ and may enforce different validation rules than creation.
|
|
|
15322
15422
|
</td>
|
|
15323
15423
|
<td>
|
|
15324
15424
|
|
|
15325
|
-
[libs/nest-crud/src/enums/crud.enums.ts:67](https://github.com/hichchidev/hichchi/blob/
|
|
15425
|
+
[libs/nest-crud/src/enums/crud.enums.ts:67](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L67)
|
|
15326
15426
|
|
|
15327
15427
|
</td>
|
|
15328
15428
|
</tr>
|
|
@@ -15333,7 +15433,7 @@ and may enforce different validation rules than creation.
|
|
|
15333
15433
|
|
|
15334
15434
|
### TypeORMErrorType
|
|
15335
15435
|
|
|
15336
|
-
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:13](https://github.com/hichchidev/hichchi/blob/
|
|
15436
|
+
Defined in: [libs/nest-crud/src/enums/crud.enums.ts:13](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L13)
|
|
15337
15437
|
|
|
15338
15438
|
TypeORM Database Error Types
|
|
15339
15439
|
|
|
@@ -15377,7 +15477,7 @@ often caused by typos in column names or outdated queries after schema changes.
|
|
|
15377
15477
|
</td>
|
|
15378
15478
|
<td>
|
|
15379
15479
|
|
|
15380
|
-
[libs/nest-crud/src/enums/crud.enums.ts:36](https://github.com/hichchidev/hichchi/blob/
|
|
15480
|
+
[libs/nest-crud/src/enums/crud.enums.ts:36](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L36)
|
|
15381
15481
|
|
|
15382
15482
|
</td>
|
|
15383
15483
|
</tr>
|
|
@@ -15400,7 +15500,7 @@ constraint, such as primary keys or columns with unique indexes.
|
|
|
15400
15500
|
</td>
|
|
15401
15501
|
<td>
|
|
15402
15502
|
|
|
15403
|
-
[libs/nest-crud/src/enums/crud.enums.ts:24](https://github.com/hichchidev/hichchi/blob/
|
|
15503
|
+
[libs/nest-crud/src/enums/crud.enums.ts:24](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L24)
|
|
15404
15504
|
|
|
15405
15505
|
</td>
|
|
15406
15506
|
</tr>
|
|
@@ -15423,7 +15523,7 @@ has no default value defined in the database schema.
|
|
|
15423
15523
|
</td>
|
|
15424
15524
|
<td>
|
|
15425
15525
|
|
|
15426
|
-
[libs/nest-crud/src/enums/crud.enums.ts:18](https://github.com/hichchidev/hichchi/blob/
|
|
15526
|
+
[libs/nest-crud/src/enums/crud.enums.ts:18](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L18)
|
|
15427
15527
|
|
|
15428
15528
|
</td>
|
|
15429
15529
|
</tr>
|
|
@@ -15446,7 +15546,7 @@ typically occurring during insert or update operations with invalid foreign key
|
|
|
15446
15546
|
</td>
|
|
15447
15547
|
<td>
|
|
15448
15548
|
|
|
15449
|
-
[libs/nest-crud/src/enums/crud.enums.ts:30](https://github.com/hichchidev/hichchi/blob/
|
|
15549
|
+
[libs/nest-crud/src/enums/crud.enums.ts:30](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/enums/crud.enums.ts#L30)
|
|
15450
15550
|
|
|
15451
15551
|
</td>
|
|
15452
15552
|
</tr>
|
|
@@ -15461,7 +15561,7 @@ typically occurring during insert or update operations with invalid foreign key
|
|
|
15461
15561
|
function Filters(): ParameterDecorator;
|
|
15462
15562
|
```
|
|
15463
15563
|
|
|
15464
|
-
Defined in: [libs/nest-crud/src/decorators/filter.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/
|
|
15564
|
+
Defined in: [libs/nest-crud/src/decorators/filter.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/filter.decorator.ts#L85)
|
|
15465
15565
|
|
|
15466
15566
|
Filter parameter decorator
|
|
15467
15567
|
|
|
@@ -15553,7 +15653,7 @@ export class ProductController {
|
|
|
15553
15653
|
function HichchiEntity(tableName, unique?, skipFkValidation?): EntityDecorator;
|
|
15554
15654
|
```
|
|
15555
15655
|
|
|
15556
|
-
Defined in: [libs/nest-crud/src/decorators/entity.decorator.ts:109](https://github.com/hichchidev/hichchi/blob/
|
|
15656
|
+
Defined in: [libs/nest-crud/src/decorators/entity.decorator.ts:109](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/entity.decorator.ts#L109)
|
|
15557
15657
|
|
|
15558
15658
|
Decorator for creating a new entity with enhanced validation and metadata registration
|
|
15559
15659
|
|
|
@@ -15734,7 +15834,7 @@ If entity naming conventions or relationship definitions are invalid
|
|
|
15734
15834
|
function HichchiEntityExtension(tableName): EntityExtensionDecorator;
|
|
15735
15835
|
```
|
|
15736
15836
|
|
|
15737
|
-
Defined in: [libs/nest-crud/src/decorators/entity-extension.decorator.ts:54](https://github.com/hichchidev/hichchi/blob/
|
|
15837
|
+
Defined in: [libs/nest-crud/src/decorators/entity-extension.decorator.ts:54](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/entity-extension.decorator.ts#L54)
|
|
15738
15838
|
|
|
15739
15839
|
Decorator for creating entity extensions with enhanced validation
|
|
15740
15840
|
|
|
@@ -15840,7 +15940,7 @@ If extension class doesn't extend BaseEntityExtension or has invalid relationshi
|
|
|
15840
15940
|
function HichchiJoinColumn(options?): PropertyDecorator;
|
|
15841
15941
|
```
|
|
15842
15942
|
|
|
15843
|
-
Defined in: [libs/nest-crud/src/decorators/join-column.decorator.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
15943
|
+
Defined in: [libs/nest-crud/src/decorators/join-column.decorator.ts:51](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/join-column.decorator.ts#L51)
|
|
15844
15944
|
|
|
15845
15945
|
Decorator for creating a join column with automatic foreign key constraint naming
|
|
15846
15946
|
|
|
@@ -15929,7 +16029,7 @@ JoinColumn TypeORM's JoinColumn decorator that this extends
|
|
|
15929
16029
|
function HichchiRepository<Entity>(entity): RepositoryDecorator;
|
|
15930
16030
|
```
|
|
15931
16031
|
|
|
15932
|
-
Defined in: [libs/nest-crud/src/decorators/repository.decorator.ts:63](https://github.com/hichchidev/hichchi/blob/
|
|
16032
|
+
Defined in: [libs/nest-crud/src/decorators/repository.decorator.ts:63](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/repository.decorator.ts#L63)
|
|
15933
16033
|
|
|
15934
16034
|
Decorator for creating a repository with automatic dependency injection
|
|
15935
16035
|
|
|
@@ -16049,7 +16149,24 @@ If the target class doesn't extend BaseRepository
|
|
|
16049
16149
|
|
|
16050
16150
|
### Pager()
|
|
16051
16151
|
|
|
16052
|
-
Implementation
|
|
16152
|
+
Implementation signature for all `Pager` overload variants.
|
|
16153
|
+
|
|
16154
|
+
Accepts either:
|
|
16155
|
+
|
|
16156
|
+
- a `PaginationOptions` object, or
|
|
16157
|
+
- numeric `page` and `limit` defaults.
|
|
16158
|
+
|
|
16159
|
+
It extracts pagination from the current HTTP request query and returns
|
|
16160
|
+
a normalized Pagination object when both `page` and `limit`
|
|
16161
|
+
query parameters are present.
|
|
16162
|
+
|
|
16163
|
+
#### Param
|
|
16164
|
+
|
|
16165
|
+
Object defaults or numeric page fallback
|
|
16166
|
+
|
|
16167
|
+
#### Param
|
|
16168
|
+
|
|
16169
|
+
Numeric limit fallback when `input` is numeric
|
|
16053
16170
|
|
|
16054
16171
|
#### Call Signature
|
|
16055
16172
|
|
|
@@ -16057,23 +16174,61 @@ Implementation overload for extracting pagination from request query params.
|
|
|
16057
16174
|
function Pager(): ParameterDecorator;
|
|
16058
16175
|
```
|
|
16059
16176
|
|
|
16060
|
-
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:
|
|
16177
|
+
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:33](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/page.decorator.ts#L33)
|
|
16178
|
+
|
|
16179
|
+
Pagination parameter decorator overload for query-driven pagination.
|
|
16180
|
+
|
|
16181
|
+
This overload reads `page` and `limit` directly from `req.query` and returns
|
|
16182
|
+
a normalized Pagination object with `page`, `limit`, `take`, and `skip`.
|
|
16061
16183
|
|
|
16062
|
-
|
|
16184
|
+
Behavior:
|
|
16185
|
+
|
|
16186
|
+
1. Uses request query values only
|
|
16187
|
+
2. Parses both values as numbers
|
|
16188
|
+
3. Falls back to `1` for invalid page and DEFAULT_ITEMS_PER_PAGE for invalid limit
|
|
16189
|
+
4. Removes `page` and `limit` from `req.query` after extraction
|
|
16190
|
+
5. Returns `undefined` when either query key is missing
|
|
16063
16191
|
|
|
16064
16192
|
##### Returns
|
|
16065
16193
|
|
|
16066
16194
|
`ParameterDecorator`
|
|
16067
16195
|
|
|
16196
|
+
A decorator that injects pagination from query params
|
|
16197
|
+
|
|
16198
|
+
##### Example
|
|
16199
|
+
|
|
16200
|
+
```typescript
|
|
16201
|
+
@Get()
|
|
16202
|
+
list(@Pager() pagination?: Pagination) {
|
|
16203
|
+
return pagination ? this.service.findPaginated(pagination) : this.service.findAll();
|
|
16204
|
+
}
|
|
16205
|
+
```
|
|
16206
|
+
|
|
16207
|
+
##### See
|
|
16208
|
+
|
|
16209
|
+
- Pagination Pagination structure returned by this overload
|
|
16210
|
+
- DEFAULT_ITEMS_PER_PAGE Default page size used for invalid limits
|
|
16211
|
+
|
|
16068
16212
|
#### Call Signature
|
|
16069
16213
|
|
|
16070
16214
|
```ts
|
|
16071
16215
|
function Pager(page, limit): ParameterDecorator;
|
|
16072
16216
|
```
|
|
16073
16217
|
|
|
16074
|
-
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:
|
|
16218
|
+
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:63](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/page.decorator.ts#L63)
|
|
16219
|
+
|
|
16220
|
+
Pagination parameter decorator overload with numeric fallback defaults.
|
|
16075
16221
|
|
|
16076
|
-
|
|
16222
|
+
This overload reads `page` and `limit` from `req.query`, and when those values
|
|
16223
|
+
are present but invalid, applies the provided numeric defaults.
|
|
16224
|
+
|
|
16225
|
+
Behavior:
|
|
16226
|
+
|
|
16227
|
+
1. Parses request query values for `page` and `limit`
|
|
16228
|
+
2. Uses supplied defaults for invalid numeric values
|
|
16229
|
+
3. Computes `skip` using `(page - 1) * take`
|
|
16230
|
+
4. Removes `page` and `limit` from `req.query` after extraction
|
|
16231
|
+
5. Returns `undefined` when either query key is missing
|
|
16077
16232
|
|
|
16078
16233
|
##### Parameters
|
|
16079
16234
|
|
|
@@ -16082,6 +16237,7 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16082
16237
|
<tr>
|
|
16083
16238
|
<th>Parameter</th>
|
|
16084
16239
|
<th>Type</th>
|
|
16240
|
+
<th>Description</th>
|
|
16085
16241
|
</tr>
|
|
16086
16242
|
</thead>
|
|
16087
16243
|
<tbody>
|
|
@@ -16095,6 +16251,11 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16095
16251
|
|
|
16096
16252
|
`number`
|
|
16097
16253
|
|
|
16254
|
+
</td>
|
|
16255
|
+
<td>
|
|
16256
|
+
|
|
16257
|
+
Default page number when query `page` is invalid
|
|
16258
|
+
|
|
16098
16259
|
</td>
|
|
16099
16260
|
</tr>
|
|
16100
16261
|
<tr>
|
|
@@ -16107,6 +16268,11 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16107
16268
|
|
|
16108
16269
|
`number`
|
|
16109
16270
|
|
|
16271
|
+
</td>
|
|
16272
|
+
<td>
|
|
16273
|
+
|
|
16274
|
+
Default page size when query `limit` is invalid
|
|
16275
|
+
|
|
16110
16276
|
</td>
|
|
16111
16277
|
</tr>
|
|
16112
16278
|
</tbody>
|
|
@@ -16116,13 +16282,29 @@ Extracts pagination and falls back to provided defaults when parsed values are i
|
|
|
16116
16282
|
|
|
16117
16283
|
`ParameterDecorator`
|
|
16118
16284
|
|
|
16285
|
+
A decorator that injects pagination with numeric defaults
|
|
16286
|
+
|
|
16287
|
+
##### Example
|
|
16288
|
+
|
|
16289
|
+
```typescript
|
|
16290
|
+
@Get()
|
|
16291
|
+
list(@Pager(1, 25) pagination?: Pagination) {
|
|
16292
|
+
return pagination ? this.service.findPaginated(pagination) : this.service.findAll();
|
|
16293
|
+
}
|
|
16294
|
+
```
|
|
16295
|
+
|
|
16296
|
+
##### See
|
|
16297
|
+
|
|
16298
|
+
- Pagination Pagination structure returned by this overload
|
|
16299
|
+
- DEFAULT_ITEMS_PER_PAGE Built-in fallback page size
|
|
16300
|
+
|
|
16119
16301
|
#### Call Signature
|
|
16120
16302
|
|
|
16121
16303
|
```ts
|
|
16122
16304
|
function Pager(defaultOptions?): ParameterDecorator;
|
|
16123
16305
|
```
|
|
16124
16306
|
|
|
16125
|
-
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:
|
|
16307
|
+
Defined in: [libs/nest-crud/src/decorators/page.decorator.ts:168](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/page.decorator.ts#L168)
|
|
16126
16308
|
|
|
16127
16309
|
Pagination parameter decorator
|
|
16128
16310
|
|
|
@@ -16267,7 +16449,7 @@ export class ArticleController {
|
|
|
16267
16449
|
function Search(): ParameterDecorator;
|
|
16268
16450
|
```
|
|
16269
16451
|
|
|
16270
|
-
Defined in: [libs/nest-crud/src/decorators/search.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/
|
|
16452
|
+
Defined in: [libs/nest-crud/src/decorators/search.decorator.ts:85](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/search.decorator.ts#L85)
|
|
16271
16453
|
|
|
16272
16454
|
Search parameter decorator
|
|
16273
16455
|
|
|
@@ -16362,7 +16544,7 @@ export class ProductController {
|
|
|
16362
16544
|
function Sorter(): ParameterDecorator;
|
|
16363
16545
|
```
|
|
16364
16546
|
|
|
16365
|
-
Defined in: [libs/nest-crud/src/decorators/sort.decorator.ts:90](https://github.com/hichchidev/hichchi/blob/
|
|
16547
|
+
Defined in: [libs/nest-crud/src/decorators/sort.decorator.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/decorators/sort.decorator.ts#L90)
|
|
16366
16548
|
|
|
16367
16549
|
Sort parameter decorator
|
|
16368
16550
|
|
|
@@ -16458,7 +16640,7 @@ export class ProductController {
|
|
|
16458
16640
|
|
|
16459
16641
|
### ConnectionOptions
|
|
16460
16642
|
|
|
16461
|
-
Defined in: [libs/nest-crud/src/interfaces/connection-options.interface.ts:45](https://github.com/hichchidev/hichchi/blob/
|
|
16643
|
+
Defined in: [libs/nest-crud/src/interfaces/connection-options.interface.ts:45](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L45)
|
|
16462
16644
|
|
|
16463
16645
|
Database connection configuration options.
|
|
16464
16646
|
|
|
@@ -16549,7 +16731,7 @@ autoLoadEntities: true;
|
|
|
16549
16731
|
</td>
|
|
16550
16732
|
<td>
|
|
16551
16733
|
|
|
16552
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:185](https://github.com/hichchidev/hichchi/blob/
|
|
16734
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:185](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L185)
|
|
16553
16735
|
|
|
16554
16736
|
</td>
|
|
16555
16737
|
</tr>
|
|
@@ -16581,7 +16763,7 @@ charset: "utf8mb4";
|
|
|
16581
16763
|
</td>
|
|
16582
16764
|
<td>
|
|
16583
16765
|
|
|
16584
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:148](https://github.com/hichchidev/hichchi/blob/
|
|
16766
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:148](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L148)
|
|
16585
16767
|
|
|
16586
16768
|
</td>
|
|
16587
16769
|
</tr>
|
|
@@ -16612,7 +16794,7 @@ database: "my_application_db";
|
|
|
16612
16794
|
</td>
|
|
16613
16795
|
<td>
|
|
16614
16796
|
|
|
16615
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:114](https://github.com/hichchidev/hichchi/blob/
|
|
16797
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:114](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L114)
|
|
16616
16798
|
|
|
16617
16799
|
</td>
|
|
16618
16800
|
</tr>
|
|
@@ -16643,7 +16825,7 @@ entities: [__dirname + "/** /*.entity{.ts,.js}"];
|
|
|
16643
16825
|
</td>
|
|
16644
16826
|
<td>
|
|
16645
16827
|
|
|
16646
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:125](https://github.com/hichchidev/hichchi/blob/
|
|
16828
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:125](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L125)
|
|
16647
16829
|
|
|
16648
16830
|
</td>
|
|
16649
16831
|
</tr>
|
|
@@ -16678,7 +16860,7 @@ host: "localhost";
|
|
|
16678
16860
|
</td>
|
|
16679
16861
|
<td>
|
|
16680
16862
|
|
|
16681
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:69](https://github.com/hichchidev/hichchi/blob/
|
|
16863
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:69](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L69)
|
|
16682
16864
|
|
|
16683
16865
|
</td>
|
|
16684
16866
|
</tr>
|
|
@@ -16710,7 +16892,7 @@ false;
|
|
|
16710
16892
|
</td>
|
|
16711
16893
|
<td>
|
|
16712
16894
|
|
|
16713
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:172](https://github.com/hichchidev/hichchi/blob/
|
|
16895
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:172](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L172)
|
|
16714
16896
|
|
|
16715
16897
|
</td>
|
|
16716
16898
|
</tr>
|
|
@@ -16741,7 +16923,7 @@ migrations: [__dirname + "/migrations/*{.ts,.js}"];
|
|
|
16741
16923
|
</td>
|
|
16742
16924
|
<td>
|
|
16743
16925
|
|
|
16744
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:136](https://github.com/hichchidev/hichchi/blob/
|
|
16926
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:136](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L136)
|
|
16745
16927
|
|
|
16746
16928
|
</td>
|
|
16747
16929
|
</tr>
|
|
@@ -16773,7 +16955,7 @@ password: process.env.DB_PASSWORD;
|
|
|
16773
16955
|
</td>
|
|
16774
16956
|
<td>
|
|
16775
16957
|
|
|
16776
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:103](https://github.com/hichchidev/hichchi/blob/
|
|
16958
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:103](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L103)
|
|
16777
16959
|
|
|
16778
16960
|
</td>
|
|
16779
16961
|
</tr>
|
|
@@ -16804,7 +16986,7 @@ port: 3306;
|
|
|
16804
16986
|
</td>
|
|
16805
16987
|
<td>
|
|
16806
16988
|
|
|
16807
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:80](https://github.com/hichchidev/hichchi/blob/
|
|
16989
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:80](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L80)
|
|
16808
16990
|
|
|
16809
16991
|
</td>
|
|
16810
16992
|
</tr>
|
|
@@ -16842,7 +17024,7 @@ synchronize: false;
|
|
|
16842
17024
|
</td>
|
|
16843
17025
|
<td>
|
|
16844
17026
|
|
|
16845
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:161](https://github.com/hichchidev/hichchi/blob/
|
|
17027
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:161](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L161)
|
|
16846
17028
|
|
|
16847
17029
|
</td>
|
|
16848
17030
|
</tr>
|
|
@@ -16874,7 +17056,7 @@ type: "mysql";
|
|
|
16874
17056
|
</td>
|
|
16875
17057
|
<td>
|
|
16876
17058
|
|
|
16877
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
17059
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:56](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L56)
|
|
16878
17060
|
|
|
16879
17061
|
</td>
|
|
16880
17062
|
</tr>
|
|
@@ -16905,7 +17087,7 @@ username: "app_user";
|
|
|
16905
17087
|
</td>
|
|
16906
17088
|
<td>
|
|
16907
17089
|
|
|
16908
|
-
[libs/nest-crud/src/interfaces/connection-options.interface.ts:91](https://github.com/hichchidev/hichchi/blob/
|
|
17090
|
+
[libs/nest-crud/src/interfaces/connection-options.interface.ts:91](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/connection-options.interface.ts#L91)
|
|
16909
17091
|
|
|
16910
17092
|
</td>
|
|
16911
17093
|
</tr>
|
|
@@ -16916,7 +17098,7 @@ username: "app_user";
|
|
|
16916
17098
|
|
|
16917
17099
|
### GetByIdsOptions
|
|
16918
17100
|
|
|
16919
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17101
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:363](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L363)
|
|
16920
17102
|
|
|
16921
17103
|
Options interface for retrieving entities by their IDs.
|
|
16922
17104
|
|
|
@@ -17016,7 +17198,7 @@ ids: ["abc123", "def456"]; // For string IDs
|
|
|
17016
17198
|
</td>
|
|
17017
17199
|
<td>
|
|
17018
17200
|
|
|
17019
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17201
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:375](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L375)
|
|
17020
17202
|
|
|
17021
17203
|
</td>
|
|
17022
17204
|
</tr>
|
|
@@ -17056,7 +17238,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17056
17238
|
</td>
|
|
17057
17239
|
<td>
|
|
17058
17240
|
|
|
17059
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
17241
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17060
17242
|
|
|
17061
17243
|
</td>
|
|
17062
17244
|
</tr>
|
|
@@ -17097,7 +17279,7 @@ options: {
|
|
|
17097
17279
|
</td>
|
|
17098
17280
|
<td>
|
|
17099
17281
|
|
|
17100
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17282
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
17101
17283
|
|
|
17102
17284
|
</td>
|
|
17103
17285
|
</tr>
|
|
@@ -17134,7 +17316,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17134
17316
|
</td>
|
|
17135
17317
|
<td>
|
|
17136
17318
|
|
|
17137
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17319
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
17138
17320
|
|
|
17139
17321
|
</td>
|
|
17140
17322
|
</tr>
|
|
@@ -17146,7 +17328,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17146
17328
|
</td>
|
|
17147
17329
|
<td>
|
|
17148
17330
|
|
|
17149
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17331
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17150
17332
|
|
|
17151
17333
|
</td>
|
|
17152
17334
|
<td>
|
|
@@ -17156,13 +17338,23 @@ Array of entity relation properties to eager-load.
|
|
|
17156
17338
|
Specifies which related entities should be loaded along with the main entity.
|
|
17157
17339
|
This is transformed into TypeORM's relations option internally.
|
|
17158
17340
|
|
|
17159
|
-
**
|
|
17341
|
+
**Examples**
|
|
17160
17342
|
|
|
17161
17343
|
```ts
|
|
17162
|
-
//
|
|
17344
|
+
// Array-style relations
|
|
17163
17345
|
relations: ["profile", "posts"];
|
|
17164
17346
|
```
|
|
17165
17347
|
|
|
17348
|
+
```ts
|
|
17349
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
17350
|
+
relations: { profile: true, posts: true }
|
|
17351
|
+
```
|
|
17352
|
+
|
|
17353
|
+
```ts
|
|
17354
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
17355
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
17356
|
+
```
|
|
17357
|
+
|
|
17166
17358
|
</td>
|
|
17167
17359
|
<td>
|
|
17168
17360
|
|
|
@@ -17171,7 +17363,7 @@ relations: ["profile", "posts"];
|
|
|
17171
17363
|
</td>
|
|
17172
17364
|
<td>
|
|
17173
17365
|
|
|
17174
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17366
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
17175
17367
|
|
|
17176
17368
|
</td>
|
|
17177
17369
|
</tr>
|
|
@@ -17211,7 +17403,7 @@ sort: {
|
|
|
17211
17403
|
</td>
|
|
17212
17404
|
<td>
|
|
17213
17405
|
|
|
17214
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17406
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
17215
17407
|
|
|
17216
17408
|
</td>
|
|
17217
17409
|
</tr>
|
|
@@ -17222,7 +17414,7 @@ sort: {
|
|
|
17222
17414
|
|
|
17223
17415
|
### GetManyOptionsFilter
|
|
17224
17416
|
|
|
17225
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17417
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:472](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L472)
|
|
17226
17418
|
|
|
17227
17419
|
Options for retrieving multiple entities with pagination and filter-based query keys.
|
|
17228
17420
|
|
|
@@ -17294,7 +17486,7 @@ filters: { status: 'active', type: 'user' }
|
|
|
17294
17486
|
</td>
|
|
17295
17487
|
<td>
|
|
17296
17488
|
|
|
17297
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17489
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:106](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L106)
|
|
17298
17490
|
|
|
17299
17491
|
</td>
|
|
17300
17492
|
</tr>
|
|
@@ -17334,7 +17526,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17334
17526
|
</td>
|
|
17335
17527
|
<td>
|
|
17336
17528
|
|
|
17337
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
17529
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17338
17530
|
|
|
17339
17531
|
</td>
|
|
17340
17532
|
</tr>
|
|
@@ -17375,7 +17567,7 @@ options: {
|
|
|
17375
17567
|
</td>
|
|
17376
17568
|
<td>
|
|
17377
17569
|
|
|
17378
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17570
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
17379
17571
|
|
|
17380
17572
|
</td>
|
|
17381
17573
|
</tr>
|
|
@@ -17412,7 +17604,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17412
17604
|
</td>
|
|
17413
17605
|
<td>
|
|
17414
17606
|
|
|
17415
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17607
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
17416
17608
|
|
|
17417
17609
|
</td>
|
|
17418
17610
|
</tr>
|
|
@@ -17424,7 +17616,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17424
17616
|
</td>
|
|
17425
17617
|
<td>
|
|
17426
17618
|
|
|
17427
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17619
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17428
17620
|
|
|
17429
17621
|
</td>
|
|
17430
17622
|
<td>
|
|
@@ -17434,13 +17626,23 @@ Array of entity relation properties to eager-load.
|
|
|
17434
17626
|
Specifies which related entities should be loaded along with the main entity.
|
|
17435
17627
|
This is transformed into TypeORM's relations option internally.
|
|
17436
17628
|
|
|
17437
|
-
**
|
|
17629
|
+
**Examples**
|
|
17438
17630
|
|
|
17439
17631
|
```ts
|
|
17440
|
-
//
|
|
17632
|
+
// Array-style relations
|
|
17441
17633
|
relations: ["profile", "posts"];
|
|
17442
17634
|
```
|
|
17443
17635
|
|
|
17636
|
+
```ts
|
|
17637
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
17638
|
+
relations: { profile: true, posts: true }
|
|
17639
|
+
```
|
|
17640
|
+
|
|
17641
|
+
```ts
|
|
17642
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
17643
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
17644
|
+
```
|
|
17645
|
+
|
|
17444
17646
|
</td>
|
|
17445
17647
|
<td>
|
|
17446
17648
|
|
|
@@ -17449,7 +17651,7 @@ relations: ["profile", "posts"];
|
|
|
17449
17651
|
</td>
|
|
17450
17652
|
<td>
|
|
17451
17653
|
|
|
17452
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17654
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
17453
17655
|
|
|
17454
17656
|
</td>
|
|
17455
17657
|
</tr>
|
|
@@ -17489,7 +17691,7 @@ sort: {
|
|
|
17489
17691
|
</td>
|
|
17490
17692
|
<td>
|
|
17491
17693
|
|
|
17492
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17694
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
17493
17695
|
|
|
17494
17696
|
</td>
|
|
17495
17697
|
</tr>
|
|
@@ -17517,7 +17719,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
17517
17719
|
</td>
|
|
17518
17720
|
<td>
|
|
17519
17721
|
|
|
17520
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17722
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:112](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L112)
|
|
17521
17723
|
|
|
17522
17724
|
</td>
|
|
17523
17725
|
</tr>
|
|
@@ -17528,7 +17730,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
17528
17730
|
|
|
17529
17731
|
### GetManyOptionsNot
|
|
17530
17732
|
|
|
17531
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17733
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:518](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L518)
|
|
17532
17734
|
|
|
17533
17735
|
Options interface for retrieving multiple entities using exclusion-based filtering with pagination.
|
|
17534
17736
|
|
|
@@ -17627,7 +17829,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17627
17829
|
</td>
|
|
17628
17830
|
<td>
|
|
17629
17831
|
|
|
17630
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
17832
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17631
17833
|
|
|
17632
17834
|
</td>
|
|
17633
17835
|
</tr>
|
|
@@ -17663,7 +17865,7 @@ not: { role: 'admin', status: 'deleted' }
|
|
|
17663
17865
|
</td>
|
|
17664
17866
|
<td>
|
|
17665
17867
|
|
|
17666
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17868
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:232](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L232)
|
|
17667
17869
|
|
|
17668
17870
|
</td>
|
|
17669
17871
|
</tr>
|
|
@@ -17704,7 +17906,7 @@ options: {
|
|
|
17704
17906
|
</td>
|
|
17705
17907
|
<td>
|
|
17706
17908
|
|
|
17707
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17909
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
17708
17910
|
|
|
17709
17911
|
</td>
|
|
17710
17912
|
</tr>
|
|
@@ -17741,7 +17943,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17741
17943
|
</td>
|
|
17742
17944
|
<td>
|
|
17743
17945
|
|
|
17744
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17946
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
17745
17947
|
|
|
17746
17948
|
</td>
|
|
17747
17949
|
</tr>
|
|
@@ -17753,7 +17955,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
17753
17955
|
</td>
|
|
17754
17956
|
<td>
|
|
17755
17957
|
|
|
17756
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17958
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
17757
17959
|
|
|
17758
17960
|
</td>
|
|
17759
17961
|
<td>
|
|
@@ -17763,13 +17965,23 @@ Array of entity relation properties to eager-load.
|
|
|
17763
17965
|
Specifies which related entities should be loaded along with the main entity.
|
|
17764
17966
|
This is transformed into TypeORM's relations option internally.
|
|
17765
17967
|
|
|
17766
|
-
**
|
|
17968
|
+
**Examples**
|
|
17767
17969
|
|
|
17768
17970
|
```ts
|
|
17769
|
-
//
|
|
17971
|
+
// Array-style relations
|
|
17770
17972
|
relations: ["profile", "posts"];
|
|
17771
17973
|
```
|
|
17772
17974
|
|
|
17975
|
+
```ts
|
|
17976
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
17977
|
+
relations: { profile: true, posts: true }
|
|
17978
|
+
```
|
|
17979
|
+
|
|
17980
|
+
```ts
|
|
17981
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
17982
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
17983
|
+
```
|
|
17984
|
+
|
|
17773
17985
|
</td>
|
|
17774
17986
|
<td>
|
|
17775
17987
|
|
|
@@ -17778,7 +17990,7 @@ relations: ["profile", "posts"];
|
|
|
17778
17990
|
</td>
|
|
17779
17991
|
<td>
|
|
17780
17992
|
|
|
17781
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
17993
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
17782
17994
|
|
|
17783
17995
|
</td>
|
|
17784
17996
|
</tr>
|
|
@@ -17818,7 +18030,7 @@ sort: {
|
|
|
17818
18030
|
</td>
|
|
17819
18031
|
<td>
|
|
17820
18032
|
|
|
17821
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18033
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
17822
18034
|
|
|
17823
18035
|
</td>
|
|
17824
18036
|
</tr>
|
|
@@ -17846,7 +18058,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
17846
18058
|
</td>
|
|
17847
18059
|
<td>
|
|
17848
18060
|
|
|
17849
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18061
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:238](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L238)
|
|
17850
18062
|
|
|
17851
18063
|
</td>
|
|
17852
18064
|
</tr>
|
|
@@ -17857,7 +18069,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
17857
18069
|
|
|
17858
18070
|
### GetManyOptionsSearch
|
|
17859
18071
|
|
|
17860
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18072
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:495](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L495)
|
|
17861
18073
|
|
|
17862
18074
|
Options interface for retrieving multiple entities using search-based filtering with pagination.
|
|
17863
18075
|
|
|
@@ -17956,7 +18168,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
17956
18168
|
</td>
|
|
17957
18169
|
<td>
|
|
17958
18170
|
|
|
17959
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
18171
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
17960
18172
|
|
|
17961
18173
|
</td>
|
|
17962
18174
|
</tr>
|
|
@@ -17997,7 +18209,7 @@ options: {
|
|
|
17997
18209
|
</td>
|
|
17998
18210
|
<td>
|
|
17999
18211
|
|
|
18000
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18212
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
18001
18213
|
|
|
18002
18214
|
</td>
|
|
18003
18215
|
</tr>
|
|
@@ -18034,7 +18246,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18034
18246
|
</td>
|
|
18035
18247
|
<td>
|
|
18036
18248
|
|
|
18037
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18249
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
18038
18250
|
|
|
18039
18251
|
</td>
|
|
18040
18252
|
</tr>
|
|
@@ -18046,7 +18258,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18046
18258
|
</td>
|
|
18047
18259
|
<td>
|
|
18048
18260
|
|
|
18049
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18261
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18050
18262
|
|
|
18051
18263
|
</td>
|
|
18052
18264
|
<td>
|
|
@@ -18056,13 +18268,23 @@ Array of entity relation properties to eager-load.
|
|
|
18056
18268
|
Specifies which related entities should be loaded along with the main entity.
|
|
18057
18269
|
This is transformed into TypeORM's relations option internally.
|
|
18058
18270
|
|
|
18059
|
-
**
|
|
18271
|
+
**Examples**
|
|
18060
18272
|
|
|
18061
18273
|
```ts
|
|
18062
|
-
//
|
|
18274
|
+
// Array-style relations
|
|
18063
18275
|
relations: ["profile", "posts"];
|
|
18064
18276
|
```
|
|
18065
18277
|
|
|
18278
|
+
```ts
|
|
18279
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
18280
|
+
relations: { profile: true, posts: true }
|
|
18281
|
+
```
|
|
18282
|
+
|
|
18283
|
+
```ts
|
|
18284
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
18285
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
18286
|
+
```
|
|
18287
|
+
|
|
18066
18288
|
</td>
|
|
18067
18289
|
<td>
|
|
18068
18290
|
|
|
@@ -18071,7 +18293,7 @@ relations: ["profile", "posts"];
|
|
|
18071
18293
|
</td>
|
|
18072
18294
|
<td>
|
|
18073
18295
|
|
|
18074
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18296
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
18075
18297
|
|
|
18076
18298
|
</td>
|
|
18077
18299
|
</tr>
|
|
@@ -18111,7 +18333,7 @@ search: {
|
|
|
18111
18333
|
</td>
|
|
18112
18334
|
<td>
|
|
18113
18335
|
|
|
18114
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18336
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:165](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L165)
|
|
18115
18337
|
|
|
18116
18338
|
</td>
|
|
18117
18339
|
</tr>
|
|
@@ -18151,7 +18373,7 @@ sort: {
|
|
|
18151
18373
|
</td>
|
|
18152
18374
|
<td>
|
|
18153
18375
|
|
|
18154
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18376
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
18155
18377
|
|
|
18156
18378
|
</td>
|
|
18157
18379
|
</tr>
|
|
@@ -18179,7 +18401,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18179
18401
|
</td>
|
|
18180
18402
|
<td>
|
|
18181
18403
|
|
|
18182
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18404
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:171](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L171)
|
|
18183
18405
|
|
|
18184
18406
|
</td>
|
|
18185
18407
|
</tr>
|
|
@@ -18190,7 +18412,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18190
18412
|
|
|
18191
18413
|
### GetManyOptionsWhere
|
|
18192
18414
|
|
|
18193
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18415
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:543](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L543)
|
|
18194
18416
|
|
|
18195
18417
|
Options interface for retrieving multiple entities using direct WHERE clause with pagination.
|
|
18196
18418
|
|
|
@@ -18276,7 +18498,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18276
18498
|
</td>
|
|
18277
18499
|
<td>
|
|
18278
18500
|
|
|
18279
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18501
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:273](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L273)
|
|
18280
18502
|
|
|
18281
18503
|
</td>
|
|
18282
18504
|
</tr>
|
|
@@ -18316,7 +18538,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
18316
18538
|
</td>
|
|
18317
18539
|
<td>
|
|
18318
18540
|
|
|
18319
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
18541
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
18320
18542
|
|
|
18321
18543
|
</td>
|
|
18322
18544
|
</tr>
|
|
@@ -18344,7 +18566,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
18344
18566
|
</td>
|
|
18345
18567
|
<td>
|
|
18346
18568
|
|
|
18347
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18569
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:285](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L285)
|
|
18348
18570
|
|
|
18349
18571
|
</td>
|
|
18350
18572
|
</tr>
|
|
@@ -18385,7 +18607,7 @@ options: {
|
|
|
18385
18607
|
</td>
|
|
18386
18608
|
<td>
|
|
18387
18609
|
|
|
18388
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18610
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
18389
18611
|
|
|
18390
18612
|
</td>
|
|
18391
18613
|
</tr>
|
|
@@ -18422,7 +18644,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18422
18644
|
</td>
|
|
18423
18645
|
<td>
|
|
18424
18646
|
|
|
18425
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18647
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
18426
18648
|
|
|
18427
18649
|
</td>
|
|
18428
18650
|
</tr>
|
|
@@ -18434,7 +18656,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
18434
18656
|
</td>
|
|
18435
18657
|
<td>
|
|
18436
18658
|
|
|
18437
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18659
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18438
18660
|
|
|
18439
18661
|
</td>
|
|
18440
18662
|
<td>
|
|
@@ -18444,13 +18666,23 @@ Array of entity relation properties to eager-load.
|
|
|
18444
18666
|
Specifies which related entities should be loaded along with the main entity.
|
|
18445
18667
|
This is transformed into TypeORM's relations option internally.
|
|
18446
18668
|
|
|
18447
|
-
**
|
|
18669
|
+
**Examples**
|
|
18448
18670
|
|
|
18449
18671
|
```ts
|
|
18450
|
-
//
|
|
18672
|
+
// Array-style relations
|
|
18451
18673
|
relations: ["profile", "posts"];
|
|
18452
18674
|
```
|
|
18453
18675
|
|
|
18676
|
+
```ts
|
|
18677
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
18678
|
+
relations: { profile: true, posts: true }
|
|
18679
|
+
```
|
|
18680
|
+
|
|
18681
|
+
```ts
|
|
18682
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
18683
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
18684
|
+
```
|
|
18685
|
+
|
|
18454
18686
|
</td>
|
|
18455
18687
|
<td>
|
|
18456
18688
|
|
|
@@ -18459,7 +18691,7 @@ relations: ["profile", "posts"];
|
|
|
18459
18691
|
</td>
|
|
18460
18692
|
<td>
|
|
18461
18693
|
|
|
18462
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18694
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
18463
18695
|
|
|
18464
18696
|
</td>
|
|
18465
18697
|
</tr>
|
|
@@ -18487,7 +18719,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18487
18719
|
</td>
|
|
18488
18720
|
<td>
|
|
18489
18721
|
|
|
18490
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18722
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:279](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L279)
|
|
18491
18723
|
|
|
18492
18724
|
</td>
|
|
18493
18725
|
</tr>
|
|
@@ -18527,7 +18759,7 @@ sort: {
|
|
|
18527
18759
|
</td>
|
|
18528
18760
|
<td>
|
|
18529
18761
|
|
|
18530
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18762
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
18531
18763
|
|
|
18532
18764
|
</td>
|
|
18533
18765
|
</tr>
|
|
@@ -18573,7 +18805,7 @@ where: [
|
|
|
18573
18805
|
</td>
|
|
18574
18806
|
<td>
|
|
18575
18807
|
|
|
18576
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18808
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:305](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L305)
|
|
18577
18809
|
|
|
18578
18810
|
</td>
|
|
18579
18811
|
</tr>
|
|
@@ -18584,7 +18816,7 @@ where: [
|
|
|
18584
18816
|
|
|
18585
18817
|
### GetOneOptionsFilter
|
|
18586
18818
|
|
|
18587
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18819
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:402](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L402)
|
|
18588
18820
|
|
|
18589
18821
|
Options for retrieving a single entity using filter-based query keys.
|
|
18590
18822
|
|
|
@@ -18660,7 +18892,7 @@ filters: { status: 'active', type: 'user' }
|
|
|
18660
18892
|
</td>
|
|
18661
18893
|
<td>
|
|
18662
18894
|
|
|
18663
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18895
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:106](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L106)
|
|
18664
18896
|
|
|
18665
18897
|
</td>
|
|
18666
18898
|
</tr>
|
|
@@ -18700,7 +18932,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
18700
18932
|
</td>
|
|
18701
18933
|
<td>
|
|
18702
18934
|
|
|
18703
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
18935
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
18704
18936
|
|
|
18705
18937
|
</td>
|
|
18706
18938
|
</tr>
|
|
@@ -18741,7 +18973,7 @@ options: {
|
|
|
18741
18973
|
</td>
|
|
18742
18974
|
<td>
|
|
18743
18975
|
|
|
18744
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
18976
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
18745
18977
|
|
|
18746
18978
|
</td>
|
|
18747
18979
|
</tr>
|
|
@@ -18753,7 +18985,7 @@ options: {
|
|
|
18753
18985
|
</td>
|
|
18754
18986
|
<td>
|
|
18755
18987
|
|
|
18756
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18988
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
18757
18989
|
|
|
18758
18990
|
</td>
|
|
18759
18991
|
<td>
|
|
@@ -18763,13 +18995,23 @@ Array of entity relation properties to eager-load.
|
|
|
18763
18995
|
Specifies which related entities should be loaded along with the main entity.
|
|
18764
18996
|
This is transformed into TypeORM's relations option internally.
|
|
18765
18997
|
|
|
18766
|
-
**
|
|
18998
|
+
**Examples**
|
|
18767
18999
|
|
|
18768
19000
|
```ts
|
|
18769
|
-
//
|
|
19001
|
+
// Array-style relations
|
|
18770
19002
|
relations: ["profile", "posts"];
|
|
18771
19003
|
```
|
|
18772
19004
|
|
|
19005
|
+
```ts
|
|
19006
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19007
|
+
relations: { profile: true, posts: true }
|
|
19008
|
+
```
|
|
19009
|
+
|
|
19010
|
+
```ts
|
|
19011
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19012
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19013
|
+
```
|
|
19014
|
+
|
|
18773
19015
|
</td>
|
|
18774
19016
|
<td>
|
|
18775
19017
|
|
|
@@ -18778,7 +19020,7 @@ relations: ["profile", "posts"];
|
|
|
18778
19020
|
</td>
|
|
18779
19021
|
<td>
|
|
18780
19022
|
|
|
18781
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19023
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
18782
19024
|
|
|
18783
19025
|
</td>
|
|
18784
19026
|
</tr>
|
|
@@ -18818,7 +19060,7 @@ sort: {
|
|
|
18818
19060
|
</td>
|
|
18819
19061
|
<td>
|
|
18820
19062
|
|
|
18821
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19063
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
18822
19064
|
|
|
18823
19065
|
</td>
|
|
18824
19066
|
</tr>
|
|
@@ -18846,7 +19088,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18846
19088
|
</td>
|
|
18847
19089
|
<td>
|
|
18848
19090
|
|
|
18849
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19091
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:112](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L112)
|
|
18850
19092
|
|
|
18851
19093
|
</td>
|
|
18852
19094
|
</tr>
|
|
@@ -18857,7 +19099,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
18857
19099
|
|
|
18858
19100
|
### GetOneOptionsNot
|
|
18859
19101
|
|
|
18860
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19102
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:444](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L444)
|
|
18861
19103
|
|
|
18862
19104
|
Options interface for retrieving a single entity using exclusion-based filtering.
|
|
18863
19105
|
|
|
@@ -18958,7 +19200,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
18958
19200
|
</td>
|
|
18959
19201
|
<td>
|
|
18960
19202
|
|
|
18961
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
19203
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
18962
19204
|
|
|
18963
19205
|
</td>
|
|
18964
19206
|
</tr>
|
|
@@ -18994,7 +19236,7 @@ not: { role: 'admin', status: 'deleted' }
|
|
|
18994
19236
|
</td>
|
|
18995
19237
|
<td>
|
|
18996
19238
|
|
|
18997
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19239
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:232](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L232)
|
|
18998
19240
|
|
|
18999
19241
|
</td>
|
|
19000
19242
|
</tr>
|
|
@@ -19035,7 +19277,7 @@ options: {
|
|
|
19035
19277
|
</td>
|
|
19036
19278
|
<td>
|
|
19037
19279
|
|
|
19038
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19280
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19039
19281
|
|
|
19040
19282
|
</td>
|
|
19041
19283
|
</tr>
|
|
@@ -19047,7 +19289,7 @@ options: {
|
|
|
19047
19289
|
</td>
|
|
19048
19290
|
<td>
|
|
19049
19291
|
|
|
19050
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19292
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19051
19293
|
|
|
19052
19294
|
</td>
|
|
19053
19295
|
<td>
|
|
@@ -19057,13 +19299,23 @@ Array of entity relation properties to eager-load.
|
|
|
19057
19299
|
Specifies which related entities should be loaded along with the main entity.
|
|
19058
19300
|
This is transformed into TypeORM's relations option internally.
|
|
19059
19301
|
|
|
19060
|
-
**
|
|
19302
|
+
**Examples**
|
|
19061
19303
|
|
|
19062
19304
|
```ts
|
|
19063
|
-
//
|
|
19305
|
+
// Array-style relations
|
|
19064
19306
|
relations: ["profile", "posts"];
|
|
19065
19307
|
```
|
|
19066
19308
|
|
|
19309
|
+
```ts
|
|
19310
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19311
|
+
relations: { profile: true, posts: true }
|
|
19312
|
+
```
|
|
19313
|
+
|
|
19314
|
+
```ts
|
|
19315
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19316
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19317
|
+
```
|
|
19318
|
+
|
|
19067
19319
|
</td>
|
|
19068
19320
|
<td>
|
|
19069
19321
|
|
|
@@ -19072,7 +19324,7 @@ relations: ["profile", "posts"];
|
|
|
19072
19324
|
</td>
|
|
19073
19325
|
<td>
|
|
19074
19326
|
|
|
19075
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19327
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
19076
19328
|
|
|
19077
19329
|
</td>
|
|
19078
19330
|
</tr>
|
|
@@ -19112,7 +19364,7 @@ sort: {
|
|
|
19112
19364
|
</td>
|
|
19113
19365
|
<td>
|
|
19114
19366
|
|
|
19115
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19367
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
19116
19368
|
|
|
19117
19369
|
</td>
|
|
19118
19370
|
</tr>
|
|
@@ -19140,7 +19392,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
19140
19392
|
</td>
|
|
19141
19393
|
<td>
|
|
19142
19394
|
|
|
19143
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19395
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:238](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L238)
|
|
19144
19396
|
|
|
19145
19397
|
</td>
|
|
19146
19398
|
</tr>
|
|
@@ -19151,7 +19403,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
19151
19403
|
|
|
19152
19404
|
### GetOneOptionsSearch
|
|
19153
19405
|
|
|
19154
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19406
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:423](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L423)
|
|
19155
19407
|
|
|
19156
19408
|
Options interface for retrieving a single entity using search-based filtering.
|
|
19157
19409
|
|
|
@@ -19252,7 +19504,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
19252
19504
|
</td>
|
|
19253
19505
|
<td>
|
|
19254
19506
|
|
|
19255
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
19507
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
19256
19508
|
|
|
19257
19509
|
</td>
|
|
19258
19510
|
</tr>
|
|
@@ -19293,7 +19545,7 @@ options: {
|
|
|
19293
19545
|
</td>
|
|
19294
19546
|
<td>
|
|
19295
19547
|
|
|
19296
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19548
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19297
19549
|
|
|
19298
19550
|
</td>
|
|
19299
19551
|
</tr>
|
|
@@ -19305,7 +19557,7 @@ options: {
|
|
|
19305
19557
|
</td>
|
|
19306
19558
|
<td>
|
|
19307
19559
|
|
|
19308
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19560
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19309
19561
|
|
|
19310
19562
|
</td>
|
|
19311
19563
|
<td>
|
|
@@ -19315,13 +19567,23 @@ Array of entity relation properties to eager-load.
|
|
|
19315
19567
|
Specifies which related entities should be loaded along with the main entity.
|
|
19316
19568
|
This is transformed into TypeORM's relations option internally.
|
|
19317
19569
|
|
|
19318
|
-
**
|
|
19570
|
+
**Examples**
|
|
19319
19571
|
|
|
19320
19572
|
```ts
|
|
19321
|
-
//
|
|
19573
|
+
// Array-style relations
|
|
19322
19574
|
relations: ["profile", "posts"];
|
|
19323
19575
|
```
|
|
19324
19576
|
|
|
19577
|
+
```ts
|
|
19578
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19579
|
+
relations: { profile: true, posts: true }
|
|
19580
|
+
```
|
|
19581
|
+
|
|
19582
|
+
```ts
|
|
19583
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19584
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19585
|
+
```
|
|
19586
|
+
|
|
19325
19587
|
</td>
|
|
19326
19588
|
<td>
|
|
19327
19589
|
|
|
@@ -19330,7 +19592,7 @@ relations: ["profile", "posts"];
|
|
|
19330
19592
|
</td>
|
|
19331
19593
|
<td>
|
|
19332
19594
|
|
|
19333
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19595
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
19334
19596
|
|
|
19335
19597
|
</td>
|
|
19336
19598
|
</tr>
|
|
@@ -19370,7 +19632,7 @@ search: {
|
|
|
19370
19632
|
</td>
|
|
19371
19633
|
<td>
|
|
19372
19634
|
|
|
19373
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19635
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:165](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L165)
|
|
19374
19636
|
|
|
19375
19637
|
</td>
|
|
19376
19638
|
</tr>
|
|
@@ -19410,7 +19672,7 @@ sort: {
|
|
|
19410
19672
|
</td>
|
|
19411
19673
|
<td>
|
|
19412
19674
|
|
|
19413
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19675
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
19414
19676
|
|
|
19415
19677
|
</td>
|
|
19416
19678
|
</tr>
|
|
@@ -19438,7 +19700,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19438
19700
|
</td>
|
|
19439
19701
|
<td>
|
|
19440
19702
|
|
|
19441
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19703
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:171](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L171)
|
|
19442
19704
|
|
|
19443
19705
|
</td>
|
|
19444
19706
|
</tr>
|
|
@@ -19449,7 +19711,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19449
19711
|
|
|
19450
19712
|
### GetOneOptionsWhere
|
|
19451
19713
|
|
|
19452
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19714
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:467](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L467)
|
|
19453
19715
|
|
|
19454
19716
|
Options interface for retrieving a single entity using direct WHERE clause.
|
|
19455
19717
|
|
|
@@ -19537,7 +19799,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19537
19799
|
</td>
|
|
19538
19800
|
<td>
|
|
19539
19801
|
|
|
19540
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19802
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:273](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L273)
|
|
19541
19803
|
|
|
19542
19804
|
</td>
|
|
19543
19805
|
</tr>
|
|
@@ -19577,7 +19839,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
19577
19839
|
</td>
|
|
19578
19840
|
<td>
|
|
19579
19841
|
|
|
19580
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
19842
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
19581
19843
|
|
|
19582
19844
|
</td>
|
|
19583
19845
|
</tr>
|
|
@@ -19605,7 +19867,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
19605
19867
|
</td>
|
|
19606
19868
|
<td>
|
|
19607
19869
|
|
|
19608
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19870
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:285](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L285)
|
|
19609
19871
|
|
|
19610
19872
|
</td>
|
|
19611
19873
|
</tr>
|
|
@@ -19646,7 +19908,7 @@ options: {
|
|
|
19646
19908
|
</td>
|
|
19647
19909
|
<td>
|
|
19648
19910
|
|
|
19649
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19911
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19650
19912
|
|
|
19651
19913
|
</td>
|
|
19652
19914
|
</tr>
|
|
@@ -19658,7 +19920,7 @@ options: {
|
|
|
19658
19920
|
</td>
|
|
19659
19921
|
<td>
|
|
19660
19922
|
|
|
19661
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19923
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
19662
19924
|
|
|
19663
19925
|
</td>
|
|
19664
19926
|
<td>
|
|
@@ -19668,13 +19930,23 @@ Array of entity relation properties to eager-load.
|
|
|
19668
19930
|
Specifies which related entities should be loaded along with the main entity.
|
|
19669
19931
|
This is transformed into TypeORM's relations option internally.
|
|
19670
19932
|
|
|
19671
|
-
**
|
|
19933
|
+
**Examples**
|
|
19672
19934
|
|
|
19673
19935
|
```ts
|
|
19674
|
-
//
|
|
19936
|
+
// Array-style relations
|
|
19675
19937
|
relations: ["profile", "posts"];
|
|
19676
19938
|
```
|
|
19677
19939
|
|
|
19940
|
+
```ts
|
|
19941
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
19942
|
+
relations: { profile: true, posts: true }
|
|
19943
|
+
```
|
|
19944
|
+
|
|
19945
|
+
```ts
|
|
19946
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
19947
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
19948
|
+
```
|
|
19949
|
+
|
|
19678
19950
|
</td>
|
|
19679
19951
|
<td>
|
|
19680
19952
|
|
|
@@ -19683,7 +19955,7 @@ relations: ["profile", "posts"];
|
|
|
19683
19955
|
</td>
|
|
19684
19956
|
<td>
|
|
19685
19957
|
|
|
19686
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19958
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
19687
19959
|
|
|
19688
19960
|
</td>
|
|
19689
19961
|
</tr>
|
|
@@ -19711,7 +19983,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
19711
19983
|
</td>
|
|
19712
19984
|
<td>
|
|
19713
19985
|
|
|
19714
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
19986
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:279](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L279)
|
|
19715
19987
|
|
|
19716
19988
|
</td>
|
|
19717
19989
|
</tr>
|
|
@@ -19751,7 +20023,7 @@ sort: {
|
|
|
19751
20023
|
</td>
|
|
19752
20024
|
<td>
|
|
19753
20025
|
|
|
19754
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20026
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
19755
20027
|
|
|
19756
20028
|
</td>
|
|
19757
20029
|
</tr>
|
|
@@ -19797,7 +20069,7 @@ where: [
|
|
|
19797
20069
|
</td>
|
|
19798
20070
|
<td>
|
|
19799
20071
|
|
|
19800
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20072
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:305](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L305)
|
|
19801
20073
|
|
|
19802
20074
|
</td>
|
|
19803
20075
|
</tr>
|
|
@@ -19808,7 +20080,7 @@ where: [
|
|
|
19808
20080
|
|
|
19809
20081
|
### PaginatedGetOptions
|
|
19810
20082
|
|
|
19811
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20083
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:327](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L327)
|
|
19812
20084
|
|
|
19813
20085
|
Options interface for paginated CRUD operations.
|
|
19814
20086
|
|
|
@@ -19913,7 +20185,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
19913
20185
|
</td>
|
|
19914
20186
|
<td>
|
|
19915
20187
|
|
|
19916
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20188
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
19917
20189
|
|
|
19918
20190
|
</td>
|
|
19919
20191
|
</tr>
|
|
@@ -19954,7 +20226,7 @@ options: {
|
|
|
19954
20226
|
</td>
|
|
19955
20227
|
<td>
|
|
19956
20228
|
|
|
19957
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20229
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
19958
20230
|
|
|
19959
20231
|
</td>
|
|
19960
20232
|
</tr>
|
|
@@ -19991,7 +20263,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
19991
20263
|
</td>
|
|
19992
20264
|
<td>
|
|
19993
20265
|
|
|
19994
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20266
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:338](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L338)
|
|
19995
20267
|
|
|
19996
20268
|
</td>
|
|
19997
20269
|
</tr>
|
|
@@ -20003,7 +20275,7 @@ pagination: { page: 2, limit: 25 } // Get 25 items from the second page
|
|
|
20003
20275
|
</td>
|
|
20004
20276
|
<td>
|
|
20005
20277
|
|
|
20006
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20278
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20007
20279
|
|
|
20008
20280
|
</td>
|
|
20009
20281
|
<td>
|
|
@@ -20013,13 +20285,23 @@ Array of entity relation properties to eager-load.
|
|
|
20013
20285
|
Specifies which related entities should be loaded along with the main entity.
|
|
20014
20286
|
This is transformed into TypeORM's relations option internally.
|
|
20015
20287
|
|
|
20016
|
-
**
|
|
20288
|
+
**Examples**
|
|
20017
20289
|
|
|
20018
20290
|
```ts
|
|
20019
|
-
//
|
|
20291
|
+
// Array-style relations
|
|
20020
20292
|
relations: ["profile", "posts"];
|
|
20021
20293
|
```
|
|
20022
20294
|
|
|
20295
|
+
```ts
|
|
20296
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
20297
|
+
relations: { profile: true, posts: true }
|
|
20298
|
+
```
|
|
20299
|
+
|
|
20300
|
+
```ts
|
|
20301
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
20302
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
20303
|
+
```
|
|
20304
|
+
|
|
20023
20305
|
</td>
|
|
20024
20306
|
<td>
|
|
20025
20307
|
|
|
@@ -20028,7 +20310,7 @@ relations: ["profile", "posts"];
|
|
|
20028
20310
|
</td>
|
|
20029
20311
|
<td>
|
|
20030
20312
|
|
|
20031
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20313
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20032
20314
|
|
|
20033
20315
|
</td>
|
|
20034
20316
|
</tr>
|
|
@@ -20068,7 +20350,7 @@ sort: {
|
|
|
20068
20350
|
</td>
|
|
20069
20351
|
<td>
|
|
20070
20352
|
|
|
20071
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20353
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20072
20354
|
|
|
20073
20355
|
</td>
|
|
20074
20356
|
</tr>
|
|
@@ -20079,7 +20361,7 @@ sort: {
|
|
|
20079
20361
|
|
|
20080
20362
|
### QueryOptions
|
|
20081
20363
|
|
|
20082
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:23](https://github.com/hichchidev/hichchi/blob/
|
|
20364
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:23](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L23)
|
|
20083
20365
|
|
|
20084
20366
|
Base options interface for CRUD operations.
|
|
20085
20367
|
|
|
@@ -20177,7 +20459,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20177
20459
|
</td>
|
|
20178
20460
|
<td>
|
|
20179
20461
|
|
|
20180
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20462
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20181
20463
|
|
|
20182
20464
|
</td>
|
|
20183
20465
|
</tr>
|
|
@@ -20213,7 +20495,7 @@ options: {
|
|
|
20213
20495
|
</td>
|
|
20214
20496
|
<td>
|
|
20215
20497
|
|
|
20216
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20498
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
20217
20499
|
|
|
20218
20500
|
</td>
|
|
20219
20501
|
</tr>
|
|
@@ -20225,7 +20507,7 @@ options: {
|
|
|
20225
20507
|
</td>
|
|
20226
20508
|
<td>
|
|
20227
20509
|
|
|
20228
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20510
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20229
20511
|
|
|
20230
20512
|
</td>
|
|
20231
20513
|
<td>
|
|
@@ -20235,17 +20517,27 @@ Array of entity relation properties to eager-load.
|
|
|
20235
20517
|
Specifies which related entities should be loaded along with the main entity.
|
|
20236
20518
|
This is transformed into TypeORM's relations option internally.
|
|
20237
20519
|
|
|
20238
|
-
**
|
|
20520
|
+
**Examples**
|
|
20239
20521
|
|
|
20240
20522
|
```ts
|
|
20241
|
-
//
|
|
20523
|
+
// Array-style relations
|
|
20242
20524
|
relations: ["profile", "posts"];
|
|
20243
20525
|
```
|
|
20244
20526
|
|
|
20527
|
+
```ts
|
|
20528
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
20529
|
+
relations: { profile: true, posts: true }
|
|
20530
|
+
```
|
|
20531
|
+
|
|
20532
|
+
```ts
|
|
20533
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
20534
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
20535
|
+
```
|
|
20536
|
+
|
|
20245
20537
|
</td>
|
|
20246
20538
|
<td>
|
|
20247
20539
|
|
|
20248
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20540
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20249
20541
|
|
|
20250
20542
|
</td>
|
|
20251
20543
|
</tr>
|
|
@@ -20280,7 +20572,7 @@ sort: {
|
|
|
20280
20572
|
</td>
|
|
20281
20573
|
<td>
|
|
20282
20574
|
|
|
20283
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20575
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20284
20576
|
|
|
20285
20577
|
</td>
|
|
20286
20578
|
</tr>
|
|
@@ -20291,7 +20583,7 @@ sort: {
|
|
|
20291
20583
|
|
|
20292
20584
|
### QueryOptionsFilter
|
|
20293
20585
|
|
|
20294
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20586
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:96](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L96)
|
|
20295
20587
|
|
|
20296
20588
|
Query options using the `where`-like filter object.
|
|
20297
20589
|
|
|
@@ -20367,7 +20659,7 @@ filters: { status: 'active', type: 'user' }
|
|
|
20367
20659
|
</td>
|
|
20368
20660
|
<td>
|
|
20369
20661
|
|
|
20370
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20662
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:106](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L106)
|
|
20371
20663
|
|
|
20372
20664
|
</td>
|
|
20373
20665
|
</tr>
|
|
@@ -20407,7 +20699,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20407
20699
|
</td>
|
|
20408
20700
|
<td>
|
|
20409
20701
|
|
|
20410
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20702
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20411
20703
|
|
|
20412
20704
|
</td>
|
|
20413
20705
|
</tr>
|
|
@@ -20448,7 +20740,7 @@ options: {
|
|
|
20448
20740
|
</td>
|
|
20449
20741
|
<td>
|
|
20450
20742
|
|
|
20451
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20743
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
20452
20744
|
|
|
20453
20745
|
</td>
|
|
20454
20746
|
</tr>
|
|
@@ -20460,7 +20752,7 @@ options: {
|
|
|
20460
20752
|
</td>
|
|
20461
20753
|
<td>
|
|
20462
20754
|
|
|
20463
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20755
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20464
20756
|
|
|
20465
20757
|
</td>
|
|
20466
20758
|
<td>
|
|
@@ -20470,13 +20762,23 @@ Array of entity relation properties to eager-load.
|
|
|
20470
20762
|
Specifies which related entities should be loaded along with the main entity.
|
|
20471
20763
|
This is transformed into TypeORM's relations option internally.
|
|
20472
20764
|
|
|
20473
|
-
**
|
|
20765
|
+
**Examples**
|
|
20474
20766
|
|
|
20475
20767
|
```ts
|
|
20476
|
-
//
|
|
20768
|
+
// Array-style relations
|
|
20477
20769
|
relations: ["profile", "posts"];
|
|
20478
20770
|
```
|
|
20479
20771
|
|
|
20772
|
+
```ts
|
|
20773
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
20774
|
+
relations: { profile: true, posts: true }
|
|
20775
|
+
```
|
|
20776
|
+
|
|
20777
|
+
```ts
|
|
20778
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
20779
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
20780
|
+
```
|
|
20781
|
+
|
|
20480
20782
|
</td>
|
|
20481
20783
|
<td>
|
|
20482
20784
|
|
|
@@ -20485,7 +20787,7 @@ relations: ["profile", "posts"];
|
|
|
20485
20787
|
</td>
|
|
20486
20788
|
<td>
|
|
20487
20789
|
|
|
20488
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20790
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20489
20791
|
|
|
20490
20792
|
</td>
|
|
20491
20793
|
</tr>
|
|
@@ -20525,7 +20827,7 @@ sort: {
|
|
|
20525
20827
|
</td>
|
|
20526
20828
|
<td>
|
|
20527
20829
|
|
|
20528
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20830
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20529
20831
|
|
|
20530
20832
|
</td>
|
|
20531
20833
|
</tr>
|
|
@@ -20553,7 +20855,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
20553
20855
|
</td>
|
|
20554
20856
|
<td>
|
|
20555
20857
|
|
|
20556
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20858
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:112](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L112)
|
|
20557
20859
|
|
|
20558
20860
|
</td>
|
|
20559
20861
|
</tr>
|
|
@@ -20564,7 +20866,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
20564
20866
|
|
|
20565
20867
|
### QueryOptionsNot
|
|
20566
20868
|
|
|
20567
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
20869
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:205](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L205)
|
|
20568
20870
|
|
|
20569
20871
|
Options interface for exclusion-based CRUD operations.
|
|
20570
20872
|
|
|
@@ -20671,7 +20973,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20671
20973
|
</td>
|
|
20672
20974
|
<td>
|
|
20673
20975
|
|
|
20674
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
20976
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20675
20977
|
|
|
20676
20978
|
</td>
|
|
20677
20979
|
</tr>
|
|
@@ -20707,7 +21009,7 @@ not: { role: 'admin', status: 'deleted' }
|
|
|
20707
21009
|
</td>
|
|
20708
21010
|
<td>
|
|
20709
21011
|
|
|
20710
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21012
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:232](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L232)
|
|
20711
21013
|
|
|
20712
21014
|
</td>
|
|
20713
21015
|
</tr>
|
|
@@ -20748,7 +21050,7 @@ options: {
|
|
|
20748
21050
|
</td>
|
|
20749
21051
|
<td>
|
|
20750
21052
|
|
|
20751
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21053
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
20752
21054
|
|
|
20753
21055
|
</td>
|
|
20754
21056
|
</tr>
|
|
@@ -20760,7 +21062,7 @@ options: {
|
|
|
20760
21062
|
</td>
|
|
20761
21063
|
<td>
|
|
20762
21064
|
|
|
20763
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21065
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
20764
21066
|
|
|
20765
21067
|
</td>
|
|
20766
21068
|
<td>
|
|
@@ -20770,13 +21072,23 @@ Array of entity relation properties to eager-load.
|
|
|
20770
21072
|
Specifies which related entities should be loaded along with the main entity.
|
|
20771
21073
|
This is transformed into TypeORM's relations option internally.
|
|
20772
21074
|
|
|
20773
|
-
**
|
|
21075
|
+
**Examples**
|
|
20774
21076
|
|
|
20775
21077
|
```ts
|
|
20776
|
-
//
|
|
21078
|
+
// Array-style relations
|
|
20777
21079
|
relations: ["profile", "posts"];
|
|
20778
21080
|
```
|
|
20779
21081
|
|
|
21082
|
+
```ts
|
|
21083
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
21084
|
+
relations: { profile: true, posts: true }
|
|
21085
|
+
```
|
|
21086
|
+
|
|
21087
|
+
```ts
|
|
21088
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
21089
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
21090
|
+
```
|
|
21091
|
+
|
|
20780
21092
|
</td>
|
|
20781
21093
|
<td>
|
|
20782
21094
|
|
|
@@ -20785,7 +21097,7 @@ relations: ["profile", "posts"];
|
|
|
20785
21097
|
</td>
|
|
20786
21098
|
<td>
|
|
20787
21099
|
|
|
20788
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21100
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
20789
21101
|
|
|
20790
21102
|
</td>
|
|
20791
21103
|
</tr>
|
|
@@ -20825,7 +21137,7 @@ sort: {
|
|
|
20825
21137
|
</td>
|
|
20826
21138
|
<td>
|
|
20827
21139
|
|
|
20828
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21140
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
20829
21141
|
|
|
20830
21142
|
</td>
|
|
20831
21143
|
</tr>
|
|
@@ -20853,7 +21165,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
20853
21165
|
</td>
|
|
20854
21166
|
<td>
|
|
20855
21167
|
|
|
20856
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21168
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:238](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L238)
|
|
20857
21169
|
|
|
20858
21170
|
</td>
|
|
20859
21171
|
</tr>
|
|
@@ -20864,7 +21176,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
20864
21176
|
|
|
20865
21177
|
### QueryOptionsSearch
|
|
20866
21178
|
|
|
20867
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21179
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:140](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L140)
|
|
20868
21180
|
|
|
20869
21181
|
Options interface for search-based CRUD operations.
|
|
20870
21182
|
|
|
@@ -20971,7 +21283,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
20971
21283
|
</td>
|
|
20972
21284
|
<td>
|
|
20973
21285
|
|
|
20974
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
21286
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
20975
21287
|
|
|
20976
21288
|
</td>
|
|
20977
21289
|
</tr>
|
|
@@ -21012,7 +21324,7 @@ options: {
|
|
|
21012
21324
|
</td>
|
|
21013
21325
|
<td>
|
|
21014
21326
|
|
|
21015
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21327
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
21016
21328
|
|
|
21017
21329
|
</td>
|
|
21018
21330
|
</tr>
|
|
@@ -21024,7 +21336,7 @@ options: {
|
|
|
21024
21336
|
</td>
|
|
21025
21337
|
<td>
|
|
21026
21338
|
|
|
21027
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21339
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21028
21340
|
|
|
21029
21341
|
</td>
|
|
21030
21342
|
<td>
|
|
@@ -21034,13 +21346,23 @@ Array of entity relation properties to eager-load.
|
|
|
21034
21346
|
Specifies which related entities should be loaded along with the main entity.
|
|
21035
21347
|
This is transformed into TypeORM's relations option internally.
|
|
21036
21348
|
|
|
21037
|
-
**
|
|
21349
|
+
**Examples**
|
|
21038
21350
|
|
|
21039
21351
|
```ts
|
|
21040
|
-
//
|
|
21352
|
+
// Array-style relations
|
|
21041
21353
|
relations: ["profile", "posts"];
|
|
21042
21354
|
```
|
|
21043
21355
|
|
|
21356
|
+
```ts
|
|
21357
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
21358
|
+
relations: { profile: true, posts: true }
|
|
21359
|
+
```
|
|
21360
|
+
|
|
21361
|
+
```ts
|
|
21362
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
21363
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
21364
|
+
```
|
|
21365
|
+
|
|
21044
21366
|
</td>
|
|
21045
21367
|
<td>
|
|
21046
21368
|
|
|
@@ -21049,7 +21371,7 @@ relations: ["profile", "posts"];
|
|
|
21049
21371
|
</td>
|
|
21050
21372
|
<td>
|
|
21051
21373
|
|
|
21052
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21374
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
21053
21375
|
|
|
21054
21376
|
</td>
|
|
21055
21377
|
</tr>
|
|
@@ -21089,7 +21411,7 @@ search: {
|
|
|
21089
21411
|
</td>
|
|
21090
21412
|
<td>
|
|
21091
21413
|
|
|
21092
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21414
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:165](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L165)
|
|
21093
21415
|
|
|
21094
21416
|
</td>
|
|
21095
21417
|
</tr>
|
|
@@ -21129,7 +21451,7 @@ sort: {
|
|
|
21129
21451
|
</td>
|
|
21130
21452
|
<td>
|
|
21131
21453
|
|
|
21132
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21454
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
21133
21455
|
|
|
21134
21456
|
</td>
|
|
21135
21457
|
</tr>
|
|
@@ -21157,7 +21479,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21157
21479
|
</td>
|
|
21158
21480
|
<td>
|
|
21159
21481
|
|
|
21160
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21482
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:171](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L171)
|
|
21161
21483
|
|
|
21162
21484
|
</td>
|
|
21163
21485
|
</tr>
|
|
@@ -21168,7 +21490,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21168
21490
|
|
|
21169
21491
|
### QueryOptionsWhere
|
|
21170
21492
|
|
|
21171
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21493
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:268](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L268)
|
|
21172
21494
|
|
|
21173
21495
|
Options interface for direct WHERE clause CRUD operations.
|
|
21174
21496
|
|
|
@@ -21262,7 +21584,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21262
21584
|
</td>
|
|
21263
21585
|
<td>
|
|
21264
21586
|
|
|
21265
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21587
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:273](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L273)
|
|
21266
21588
|
|
|
21267
21589
|
</td>
|
|
21268
21590
|
</tr>
|
|
@@ -21302,7 +21624,7 @@ async createUserWithProfile(data, manager: EntityManager) {
|
|
|
21302
21624
|
</td>
|
|
21303
21625
|
<td>
|
|
21304
21626
|
|
|
21305
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
21627
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L37)
|
|
21306
21628
|
|
|
21307
21629
|
</td>
|
|
21308
21630
|
</tr>
|
|
@@ -21330,7 +21652,7 @@ Use NotOptions for exclusion-based filtering or WhereOptions for direct where cl
|
|
|
21330
21652
|
</td>
|
|
21331
21653
|
<td>
|
|
21332
21654
|
|
|
21333
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21655
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:285](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L285)
|
|
21334
21656
|
|
|
21335
21657
|
</td>
|
|
21336
21658
|
</tr>
|
|
@@ -21371,7 +21693,7 @@ options: {
|
|
|
21371
21693
|
</td>
|
|
21372
21694
|
<td>
|
|
21373
21695
|
|
|
21374
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21696
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:75](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L75)
|
|
21375
21697
|
|
|
21376
21698
|
</td>
|
|
21377
21699
|
</tr>
|
|
@@ -21383,7 +21705,7 @@ options: {
|
|
|
21383
21705
|
</td>
|
|
21384
21706
|
<td>
|
|
21385
21707
|
|
|
21386
|
-
(keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21708
|
+
| `FindOptionsRelations`<`Entity`> | (keyof `Entity` | `` `${keyof Entity}.${string}` ``)\[]
|
|
21387
21709
|
|
|
21388
21710
|
</td>
|
|
21389
21711
|
<td>
|
|
@@ -21393,13 +21715,23 @@ Array of entity relation properties to eager-load.
|
|
|
21393
21715
|
Specifies which related entities should be loaded along with the main entity.
|
|
21394
21716
|
This is transformed into TypeORM's relations option internally.
|
|
21395
21717
|
|
|
21396
|
-
**
|
|
21718
|
+
**Examples**
|
|
21397
21719
|
|
|
21398
21720
|
```ts
|
|
21399
|
-
//
|
|
21721
|
+
// Array-style relations
|
|
21400
21722
|
relations: ["profile", "posts"];
|
|
21401
21723
|
```
|
|
21402
21724
|
|
|
21725
|
+
```ts
|
|
21726
|
+
// FindOptionsRelations<Entity> object-style relations
|
|
21727
|
+
relations: { profile: true, posts: true }
|
|
21728
|
+
```
|
|
21729
|
+
|
|
21730
|
+
```ts
|
|
21731
|
+
// Nested FindOptionsRelations<Entity> object-style relations
|
|
21732
|
+
relations: { profile: true, posts: { author: true, comments: true } }
|
|
21733
|
+
```
|
|
21734
|
+
|
|
21403
21735
|
</td>
|
|
21404
21736
|
<td>
|
|
21405
21737
|
|
|
@@ -21408,7 +21740,7 @@ relations: ["profile", "posts"];
|
|
|
21408
21740
|
</td>
|
|
21409
21741
|
<td>
|
|
21410
21742
|
|
|
21411
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21743
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L59)
|
|
21412
21744
|
|
|
21413
21745
|
</td>
|
|
21414
21746
|
</tr>
|
|
@@ -21436,7 +21768,7 @@ Use SearchOptions for search-based filtering or WhereOptions for direct where cl
|
|
|
21436
21768
|
</td>
|
|
21437
21769
|
<td>
|
|
21438
21770
|
|
|
21439
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21771
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:279](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L279)
|
|
21440
21772
|
|
|
21441
21773
|
</td>
|
|
21442
21774
|
</tr>
|
|
@@ -21476,7 +21808,7 @@ sort: {
|
|
|
21476
21808
|
</td>
|
|
21477
21809
|
<td>
|
|
21478
21810
|
|
|
21479
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21811
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:90](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L90)
|
|
21480
21812
|
|
|
21481
21813
|
</td>
|
|
21482
21814
|
</tr>
|
|
@@ -21522,7 +21854,7 @@ where: [
|
|
|
21522
21854
|
</td>
|
|
21523
21855
|
<td>
|
|
21524
21856
|
|
|
21525
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21857
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:305](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L305)
|
|
21526
21858
|
|
|
21527
21859
|
</td>
|
|
21528
21860
|
</tr>
|
|
@@ -21533,7 +21865,7 @@ where: [
|
|
|
21533
21865
|
|
|
21534
21866
|
### SaveOptionsWithSkip
|
|
21535
21867
|
|
|
21536
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
21868
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:574](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L574)
|
|
21537
21869
|
|
|
21538
21870
|
Extended save options interface with skip creation functionality.
|
|
21539
21871
|
|
|
@@ -21744,7 +22076,7 @@ skipCreate: true; // Only update existing entities, don't create new ones
|
|
|
21744
22076
|
</td>
|
|
21745
22077
|
<td>
|
|
21746
22078
|
|
|
21747
|
-
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22079
|
+
[libs/nest-crud/src/interfaces/crud-options.interfaces.ts:587](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L587)
|
|
21748
22080
|
|
|
21749
22081
|
</td>
|
|
21750
22082
|
</tr>
|
|
@@ -21789,7 +22121,7 @@ node_modules/typeorm/repository/SaveOptions.d.ts:19
|
|
|
21789
22121
|
type DatabaseTypes = "mysql" | "mariadb" | "postgres";
|
|
21790
22122
|
```
|
|
21791
22123
|
|
|
21792
|
-
Defined in: [libs/nest-crud/src/types/database.types.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
22124
|
+
Defined in: [libs/nest-crud/src/types/database.types.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/database.types.ts#L37)
|
|
21793
22125
|
|
|
21794
22126
|
Supported database types for application connections.
|
|
21795
22127
|
|
|
@@ -21836,7 +22168,7 @@ const connectionOptions: ConnectionOptions = {
|
|
|
21836
22168
|
type EntityDecorator = (target) => void;
|
|
21837
22169
|
```
|
|
21838
22170
|
|
|
21839
|
-
Defined in: [libs/nest-crud/src/types/decorator.types.ts:64](https://github.com/hichchidev/hichchi/blob/
|
|
22171
|
+
Defined in: [libs/nest-crud/src/types/decorator.types.ts:64](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/decorator.types.ts#L64)
|
|
21840
22172
|
|
|
21841
22173
|
Type definition for decorators that target standard entity classes
|
|
21842
22174
|
|
|
@@ -21866,7 +22198,7 @@ modifies the target class or registers metadata about the class.
|
|
|
21866
22198
|
</td>
|
|
21867
22199
|
<td>
|
|
21868
22200
|
|
|
21869
|
-
`Type`<[`BaseEntity`](#baseentity) | [`HichchiUserEntity`](#hichchiuserentity)>
|
|
22201
|
+
`Type`< | [`BaseEntity`](#baseentity) | [`HichchiUserEntity`](#abstract-hichchiuserentity)>
|
|
21870
22202
|
|
|
21871
22203
|
</td>
|
|
21872
22204
|
<td>
|
|
@@ -21907,7 +22239,7 @@ export class UserEntity extends BaseEntity {
|
|
|
21907
22239
|
#### See
|
|
21908
22240
|
|
|
21909
22241
|
- [BaseEntity](#baseentity) The base class that decorated entities must extend
|
|
21910
|
-
- [HichchiUserEntity](#hichchiuserentity) The base user class that decorated entities must extend
|
|
22242
|
+
- [HichchiUserEntity](#abstract-hichchiuserentity) The base user class that decorated entities must extend
|
|
21911
22243
|
- [HichchiEntity](#hichchientity) The primary entity decorator
|
|
21912
22244
|
- [EntityExtensionDecorator](#entityextensiondecorator) Similar type for entity extensions
|
|
21913
22245
|
|
|
@@ -21919,7 +22251,7 @@ export class UserEntity extends BaseEntity {
|
|
|
21919
22251
|
type EntityExtensionDecorator = (target) => void;
|
|
21920
22252
|
```
|
|
21921
22253
|
|
|
21922
|
-
Defined in: [libs/nest-crud/src/types/decorator.types.ts:108](https://github.com/hichchidev/hichchi/blob/
|
|
22254
|
+
Defined in: [libs/nest-crud/src/types/decorator.types.ts:108](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/decorator.types.ts#L108)
|
|
21923
22255
|
|
|
21924
22256
|
Type definition for decorators that target extended entity classes
|
|
21925
22257
|
|
|
@@ -22007,7 +22339,7 @@ export class ProductEntity extends BaseEntityExtension {
|
|
|
22007
22339
|
type EntityOptionUnique = object;
|
|
22008
22340
|
```
|
|
22009
22341
|
|
|
22010
|
-
Defined in: [libs/nest-crud/src/types/entity-option-unique.ts:51](https://github.com/hichchidev/hichchi/blob/
|
|
22342
|
+
Defined in: [libs/nest-crud/src/types/entity-option-unique.ts:51](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/entity-option-unique.ts#L51)
|
|
22011
22343
|
|
|
22012
22344
|
Configuration type for defining unique constraints on entity fields.
|
|
22013
22345
|
|
|
@@ -22085,7 +22417,7 @@ type FilterOptions<Entity> = {
|
|
|
22085
22417
|
};
|
|
22086
22418
|
```
|
|
22087
22419
|
|
|
22088
|
-
Defined in: [libs/nest-crud/src/types/filter-options.type.ts:60](https://github.com/hichchidev/hichchi/blob/
|
|
22420
|
+
Defined in: [libs/nest-crud/src/types/filter-options.type.ts:60](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/filter-options.type.ts#L60)
|
|
22089
22421
|
|
|
22090
22422
|
A recursive type for building structured filter conditions for entity queries.
|
|
22091
22423
|
|
|
@@ -22186,10 +22518,11 @@ type FindConditions<Entity> =
|
|
|
22186
22518
|
| Date[]
|
|
22187
22519
|
| ObjectId
|
|
22188
22520
|
| ObjectId[]
|
|
22189
|
-
| QueryDeepPartial<Entity
|
|
22521
|
+
| QueryDeepPartial<Entity>
|
|
22522
|
+
| QueryDeepPartial<Entity>[];
|
|
22190
22523
|
```
|
|
22191
22524
|
|
|
22192
|
-
Defined in: [libs/nest-crud/src/types/find-conditions.type.ts:59](https://github.com/hichchidev/hichchi/blob/
|
|
22525
|
+
Defined in: [libs/nest-crud/src/types/find-conditions.type.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/find-conditions.type.ts#L59)
|
|
22193
22526
|
|
|
22194
22527
|
A flexible type for defining query conditions when finding entities.
|
|
22195
22528
|
|
|
@@ -22278,7 +22611,7 @@ async function findUsers(conditions: FindConditions<User>): Promise<User[]> {
|
|
|
22278
22611
|
type GetAllOptions<Entity> = PaginatedGetOptions<Entity>;
|
|
22279
22612
|
```
|
|
22280
22613
|
|
|
22281
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22614
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:666](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L666)
|
|
22282
22615
|
|
|
22283
22616
|
Simple options type for retrieving all entities with pagination.
|
|
22284
22617
|
|
|
@@ -22331,7 +22664,7 @@ const [users, count] = await userService.findAll(options);
|
|
|
22331
22664
|
type GetByIdOptions<Entity> = Omit<QueryOptions<Entity>, "sort">;
|
|
22332
22665
|
```
|
|
22333
22666
|
|
|
22334
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22667
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:397](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L397)
|
|
22335
22668
|
|
|
22336
22669
|
Options interface for retrieving a single entity by its ID.
|
|
22337
22670
|
|
|
@@ -22387,7 +22720,7 @@ type GetManyOptions<Entity> =
|
|
|
22387
22720
|
| GetManyOptionsWhere<Entity>;
|
|
22388
22721
|
```
|
|
22389
22722
|
|
|
22390
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22723
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:701](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L701)
|
|
22391
22724
|
|
|
22392
22725
|
Union type for all options interfaces for retrieving multiple entities with pagination.
|
|
22393
22726
|
|
|
@@ -22459,7 +22792,7 @@ type GetOneOptions<Entity> =
|
|
|
22459
22792
|
| GetOneOptionsWhere<Entity>;
|
|
22460
22793
|
```
|
|
22461
22794
|
|
|
22462
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22795
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:642](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L642)
|
|
22463
22796
|
|
|
22464
22797
|
Union type for all options interfaces for retrieving a single entity.
|
|
22465
22798
|
|
|
@@ -22518,7 +22851,7 @@ type GetOptions<Entity> =
|
|
|
22518
22851
|
| (QueryOptionsWhere<Entity> & PaginatedGetOptions<Entity>);
|
|
22519
22852
|
```
|
|
22520
22853
|
|
|
22521
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
22854
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:614](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L614)
|
|
22522
22855
|
|
|
22523
22856
|
Comprehensive options type for retrieving entities with various filtering approaches and pagination.
|
|
22524
22857
|
|
|
@@ -22575,7 +22908,7 @@ const [users, count] = await getUsers({
|
|
|
22575
22908
|
type RepositoryDecorator = <T>(target) => T | void;
|
|
22576
22909
|
```
|
|
22577
22910
|
|
|
22578
|
-
Defined in: [libs/nest-crud/src/types/repository-decorator.type.ts:47](https://github.com/hichchidev/hichchi/blob/
|
|
22911
|
+
Defined in: [libs/nest-crud/src/types/repository-decorator.type.ts:47](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/repository-decorator.type.ts#L47)
|
|
22579
22912
|
|
|
22580
22913
|
Type definition for repository class decorators.
|
|
22581
22914
|
|
|
@@ -22695,7 +23028,7 @@ class UserRepository extends BaseRepository<User> {
|
|
|
22695
23028
|
type SaveAndGetOptions<Entity> = SaveOptionsWithSkip & GetByIdOptions<Entity>;
|
|
22696
23029
|
```
|
|
22697
23030
|
|
|
22698
|
-
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:
|
|
23031
|
+
Defined in: [libs/nest-crud/src/interfaces/crud-options.interfaces.ts:744](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/interfaces/crud-options.interfaces.ts#L744)
|
|
22699
23032
|
|
|
22700
23033
|
Combined options type for save-and-get operations.
|
|
22701
23034
|
|
|
@@ -22766,7 +23099,7 @@ const updatedUser = await userService.saveAndGet(userData, options);
|
|
|
22766
23099
|
type SortOptions<Entity> = FindOptionsOrder<Entity>;
|
|
22767
23100
|
```
|
|
22768
23101
|
|
|
22769
|
-
Defined in: [libs/nest-crud/src/types/sort-options.type.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
23102
|
+
Defined in: [libs/nest-crud/src/types/sort-options.type.ts:56](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/sort-options.type.ts#L56)
|
|
22770
23103
|
|
|
22771
23104
|
Type alias for TypeORM's sorting configuration.
|
|
22772
23105
|
|
|
@@ -22858,7 +23191,7 @@ const users = await userRepository.find({
|
|
|
22858
23191
|
type TypeORMErrorHandler = (error) => Error | void;
|
|
22859
23192
|
```
|
|
22860
23193
|
|
|
22861
|
-
Defined in: [libs/nest-crud/src/types/error-handler.type.ts:54](https://github.com/hichchidev/hichchi/blob/
|
|
23194
|
+
Defined in: [libs/nest-crud/src/types/error-handler.type.ts:54](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/types/error-handler.type.ts#L54)
|
|
22862
23195
|
|
|
22863
23196
|
A function type for custom TypeORM error handling.
|
|
22864
23197
|
|
|
@@ -22961,7 +23294,7 @@ try {
|
|
|
22961
23294
|
const BaseEntityTemplateRelations: string[];
|
|
22962
23295
|
```
|
|
22963
23296
|
|
|
22964
|
-
Defined in: [libs/nest-crud/src/base/base-entity.ts:19](https://github.com/hichchidev/hichchi/blob/
|
|
23297
|
+
Defined in: [libs/nest-crud/src/base/base-entity.ts:19](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/base/base-entity.ts#L19)
|
|
22965
23298
|
|
|
22966
23299
|
List of standard relation properties in the BaseEntity
|
|
22967
23300
|
|
|
@@ -22985,7 +23318,7 @@ standard relations from foreign key constraint validation.
|
|
|
22985
23318
|
const CONNECTION_OPTIONS: "CONNECTION_OPTIONS" = "CONNECTION_OPTIONS";
|
|
22986
23319
|
```
|
|
22987
23320
|
|
|
22988
|
-
Defined in: [libs/nest-crud/src/tokens.ts:29](https://github.com/hichchidev/hichchi/blob/
|
|
23321
|
+
Defined in: [libs/nest-crud/src/tokens.ts:29](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/tokens.ts#L29)
|
|
22989
23322
|
|
|
22990
23323
|
Token for database connection options
|
|
22991
23324
|
|
|
@@ -23025,7 +23358,7 @@ export class AppModule {}
|
|
|
23025
23358
|
const DEFAULT_MAX_RECURSION_DEPTH: 10 = 10;
|
|
23026
23359
|
```
|
|
23027
23360
|
|
|
23028
|
-
Defined in: [libs/nest-crud/src/constants.ts:21](https://github.com/hichchidev/hichchi/blob/
|
|
23361
|
+
Defined in: [libs/nest-crud/src/constants.ts:21](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L21)
|
|
23029
23362
|
|
|
23030
23363
|
Default maximum recursion depth for deep object operations
|
|
23031
23364
|
|
|
@@ -23057,7 +23390,7 @@ toQueryDeepPartialEntity Function that uses this constant to limit recursion dep
|
|
|
23057
23390
|
const EXTRACT_INVALID_COLUMN_REGEX: RegExp;
|
|
23058
23391
|
```
|
|
23059
23392
|
|
|
23060
|
-
Defined in: [libs/nest-crud/src/constants.ts:106](https://github.com/hichchidev/hichchi/blob/
|
|
23393
|
+
Defined in: [libs/nest-crud/src/constants.ts:106](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L106)
|
|
23061
23394
|
|
|
23062
23395
|
Regular expression for extracting column names from database column not found errors
|
|
23063
23396
|
|
|
@@ -23087,7 +23420,7 @@ EntityUtils.handleError Method that uses this pattern to extract column names fr
|
|
|
23087
23420
|
const EXTRACT_INVALID_QUERY_FIELD_REGEX: RegExp;
|
|
23088
23421
|
```
|
|
23089
23422
|
|
|
23090
|
-
Defined in: [libs/nest-crud/src/constants.ts:86](https://github.com/hichchidev/hichchi/blob/
|
|
23423
|
+
Defined in: [libs/nest-crud/src/constants.ts:86](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L86)
|
|
23091
23424
|
|
|
23092
23425
|
Regular expression for extracting field names from TypeORM property not found errors
|
|
23093
23426
|
|
|
@@ -23117,7 +23450,7 @@ EntityUtils.handleError Method that uses this pattern to extract field names fro
|
|
|
23117
23450
|
const FK_CONSTRAINT_REGEX: RegExp;
|
|
23118
23451
|
```
|
|
23119
23452
|
|
|
23120
|
-
Defined in: [libs/nest-crud/src/constants.ts:66](https://github.com/hichchidev/hichchi/blob/
|
|
23453
|
+
Defined in: [libs/nest-crud/src/constants.ts:66](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L66)
|
|
23121
23454
|
|
|
23122
23455
|
Regular expression for validating foreign key constraint naming convention
|
|
23123
23456
|
|
|
@@ -23150,7 +23483,7 @@ The format is: FK_entityName_relatedEntityName
|
|
|
23150
23483
|
const ID_PATH: "id" = "id";
|
|
23151
23484
|
```
|
|
23152
23485
|
|
|
23153
|
-
Defined in: [libs/nest-crud/src/constants.ts:108](https://github.com/hichchidev/hichchi/blob/
|
|
23486
|
+
Defined in: [libs/nest-crud/src/constants.ts:108](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L108)
|
|
23154
23487
|
|
|
23155
23488
|
---
|
|
23156
23489
|
|
|
@@ -23160,7 +23493,7 @@ Defined in: [libs/nest-crud/src/constants.ts:108](https://github.com/hichchidev/
|
|
|
23160
23493
|
const ID_PATH_VAR: ":id";
|
|
23161
23494
|
```
|
|
23162
23495
|
|
|
23163
|
-
Defined in: [libs/nest-crud/src/constants.ts:110](https://github.com/hichchidev/hichchi/blob/
|
|
23496
|
+
Defined in: [libs/nest-crud/src/constants.ts:110](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L110)
|
|
23164
23497
|
|
|
23165
23498
|
---
|
|
23166
23499
|
|
|
@@ -23221,7 +23554,7 @@ Defined in: node_modules/@nestjs/typeorm/dist/common/typeorm.decorators.d.ts:4
|
|
|
23221
23554
|
const UNIQUE_CONSTRAINT_REGEX: RegExp;
|
|
23222
23555
|
```
|
|
23223
23556
|
|
|
23224
|
-
Defined in: [libs/nest-crud/src/constants.ts:43](https://github.com/hichchidev/hichchi/blob/
|
|
23557
|
+
Defined in: [libs/nest-crud/src/constants.ts:43](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/constants.ts#L43)
|
|
23225
23558
|
|
|
23226
23559
|
Regular expression for validating unique constraint naming convention
|
|
23227
23560
|
|
|
@@ -23253,7 +23586,7 @@ The format is: UNIQUE_entityName_fieldName
|
|
|
23253
23586
|
const USER_ENTITY_TABLE_NAME: "users" = "users";
|
|
23254
23587
|
```
|
|
23255
23588
|
|
|
23256
|
-
Defined in: [libs/nest-crud/src/tokens.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
23589
|
+
Defined in: [libs/nest-crud/src/tokens.ts:56](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/nest-crud/src/tokens.ts#L56)
|
|
23257
23590
|
|
|
23258
23591
|
Standard table name for user entities
|
|
23259
23592
|
|
|
@@ -23280,4 +23613,4 @@ export class UserEntity extends HichchiUserEntity implements User {
|
|
|
23280
23613
|
#### See
|
|
23281
23614
|
|
|
23282
23615
|
- [HichchiEntity](#hichchientity) The decorator that enforces this table name for user entities
|
|
23283
|
-
- [HichchiUserEntity](#hichchiuserentity) The base entity class for user entities
|
|
23616
|
+
- [HichchiUserEntity](#abstract-hichchiuserentity) The base entity class for user entities
|