departmentrepo - juanitopons/fullstack-test GitHub Wiki
fullstack-test-server - v1.0.0 › Globals › DepartmentRepo
-
Repository‹Department›
↳ DepartmentRepo
- clear
- count
- create
- createQueryBuilder
- decrement
- delete
- editMany
- editOne
- find
- findAndCount
- findByIds
- findOne
- findOneOrFail
- getAll
- getById
- getId
- hasId
- increment
- insert
- insertMany
- insertOne
- merge
- preload
- query
- recover
- remove
- removeById
- restore
- save
- softDelete
- softRemove
- update
• manager: EntityManager
Inherited from DepartmentRepo.manager
Defined in node_modules/typeorm/repository/Repository.d.ts:24
Entity Manager used by this repository.
• metadata: EntityMetadata
Inherited from DepartmentRepo.metadata
Defined in node_modules/typeorm/repository/Repository.d.ts:28
Entity metadata of the entity current repository manages.
• queryRunner? : QueryRunner
Inherited from DepartmentRepo.queryRunner
Defined in node_modules/typeorm/repository/Repository.d.ts:32
Query runner provider used for this repository.
• target: Function | string
Inherited from DepartmentRepo.target
Defined in node_modules/typeorm/repository/Repository.d.ts:42
Returns object that is managed by this repository. If this repository manages entity from schema, then it returns a name of that schema instead.
▸ clear(): Promise‹void›
Inherited from DepartmentRepo.clear
Defined in node_modules/typeorm/repository/Repository.d.ts:260
Clears all the data from the given table/collection (truncates/drops it).
Note: this method uses TRUNCATE and may not work as you expect in transactions on some platforms.
see https://stackoverflow.com/a/5972738/925151
Returns: Promise‹void›
▸ count(options?: FindManyOptions‹Department›): Promise‹number›
Inherited from DepartmentRepo.count
Defined in node_modules/typeorm/repository/Repository.d.ts:190
Counts entities that match given options.
Parameters:
| Name | Type |
|---|---|
options? |
FindManyOptions‹Department› |
Returns: Promise‹number›
▸ count(conditions?: FindConditions‹Department›): Promise‹number›
Inherited from DepartmentRepo.count
Defined in node_modules/typeorm/repository/Repository.d.ts:194
Counts entities that match given conditions.
Parameters:
| Name | Type |
|---|---|
conditions? |
FindConditions‹Department› |
Returns: Promise‹number›
▸ create(): Department
Inherited from DepartmentRepo.create
Defined in node_modules/typeorm/repository/Repository.d.ts:55
Creates a new entity instance.
Returns: Department
▸ create(entityLikeArray: DeepPartial‹Department›[]): Department[]
Inherited from DepartmentRepo.create
Defined in node_modules/typeorm/repository/Repository.d.ts:60
Creates a new entities and copies all entity properties from given objects into their new entities. Note that it copies only properties that present in entity schema.
Parameters:
| Name | Type |
|---|---|
entityLikeArray |
DeepPartial‹Department›[] |
Returns: Department[]
▸ create(entityLike: DeepPartial‹Department›): Department
Inherited from DepartmentRepo.create
Defined in node_modules/typeorm/repository/Repository.d.ts:65
Creates a new entity instance and copies all entity properties from this object into a new entity. Note that it copies only properties that present in entity schema.
Parameters:
| Name | Type |
|---|---|
entityLike |
DeepPartial‹Department› |
Returns: Department
▸ createQueryBuilder(alias?: string, queryRunner?: QueryRunner): SelectQueryBuilder‹Department›
Inherited from DepartmentRepo.createQueryBuilder
Defined in node_modules/typeorm/repository/Repository.d.ts:36
Creates a new query builder that can be used to build a sql query.
Parameters:
| Name | Type |
|---|---|
alias? |
string |
queryRunner? |
QueryRunner |
Returns: SelectQueryBuilder‹Department›
▸ decrement(conditions: FindConditions‹Department›, propertyPath: string, value: number | string): Promise‹UpdateResult›
Inherited from DepartmentRepo.decrement
Defined in node_modules/typeorm/repository/Repository.d.ts:268
Decrements some column by provided value of the entities matched given conditions.
Parameters:
| Name | Type |
|---|---|
conditions |
FindConditions‹Department› |
propertyPath |
string |
value |
number | string |
Returns: Promise‹UpdateResult›
▸ delete(criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department›): Promise‹DeleteResult›
Inherited from DepartmentRepo.delete
Defined in node_modules/typeorm/repository/Repository.d.ts:172
Deletes entities by a given criteria. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient DELETE query. Does not check if entity exist in the database.
Parameters:
| Name | Type |
|---|---|
criteria |
string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department› |
Returns: Promise‹DeleteResult›
▸ editMany(departments: Department[]): Promise‹Department[]›
Defined in src/database/repository/department.repository.ts:32
Parameters:
| Name | Type |
|---|---|
departments |
Department[] |
Returns: Promise‹Department[]›
▸ editOne(department: Department): Promise‹Department›
Defined in src/database/repository/department.repository.ts:28
Parameters:
| Name | Type |
|---|---|
department |
Department |
Returns: Promise‹Department›
▸ find(options?: FindManyOptions‹Department›): Promise‹Department[]›
Inherited from DepartmentRepo.find
Defined in node_modules/typeorm/repository/Repository.d.ts:198
Finds entities that match given options.
Parameters:
| Name | Type |
|---|---|
options? |
FindManyOptions‹Department› |
Returns: Promise‹Department[]›
▸ find(conditions?: FindConditions‹Department›): Promise‹Department[]›
Inherited from DepartmentRepo.find
Defined in node_modules/typeorm/repository/Repository.d.ts:202
Finds entities that match given conditions.
Parameters:
| Name | Type |
|---|---|
conditions? |
FindConditions‹Department› |
Returns: Promise‹Department[]›
▸ findAndCount(options?: FindManyOptions‹Department›): Promise‹[Department[], number]›
Inherited from DepartmentRepo.findAndCount
Defined in node_modules/typeorm/repository/Repository.d.ts:208
Finds entities that match given find options. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).
Parameters:
| Name | Type |
|---|---|
options? |
FindManyOptions‹Department› |
Returns: Promise‹[Department[], number]›
▸ findAndCount(conditions?: FindConditions‹Department›): Promise‹[Department[], number]›
Inherited from DepartmentRepo.findAndCount
Defined in node_modules/typeorm/repository/Repository.d.ts:214
Finds entities that match given conditions. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).
Parameters:
| Name | Type |
|---|---|
conditions? |
FindConditions‹Department› |
Returns: Promise‹[Department[], number]›
▸ findByIds(ids: any[], options?: FindManyOptions‹Department›): Promise‹Department[]›
Inherited from DepartmentRepo.findByIds
Defined in node_modules/typeorm/repository/Repository.d.ts:219
Finds entities by ids. Optionally find options can be applied.
Parameters:
| Name | Type |
|---|---|
ids |
any[] |
options? |
FindManyOptions‹Department› |
Returns: Promise‹Department[]›
▸ findByIds(ids: any[], conditions?: FindConditions‹Department›): Promise‹Department[]›
Inherited from DepartmentRepo.findByIds
Defined in node_modules/typeorm/repository/Repository.d.ts:224
Finds entities by ids. Optionally conditions can be applied.
Parameters:
| Name | Type |
|---|---|
ids |
any[] |
conditions? |
FindConditions‹Department› |
Returns: Promise‹Department[]›
▸ findOne(id?: string | number | Date | ObjectID, options?: FindOneOptions‹Department›): Promise‹Department | undefined›
Inherited from DepartmentRepo.findOne
Defined in node_modules/typeorm/repository/Repository.d.ts:228
Finds first entity that matches given options.
Parameters:
| Name | Type |
|---|---|
id? |
string | number | Date | ObjectID |
options? |
FindOneOptions‹Department› |
Returns: Promise‹Department | undefined›
▸ findOne(options?: FindOneOptions‹Department›): Promise‹Department | undefined›
Inherited from DepartmentRepo.findOne
Defined in node_modules/typeorm/repository/Repository.d.ts:232
Finds first entity that matches given options.
Parameters:
| Name | Type |
|---|---|
options? |
FindOneOptions‹Department› |
Returns: Promise‹Department | undefined›
▸ findOne(conditions?: FindConditions‹Department›, options?: FindOneOptions‹Department›): Promise‹Department | undefined›
Inherited from DepartmentRepo.findOne
Defined in node_modules/typeorm/repository/Repository.d.ts:236
Finds first entity that matches given conditions.
Parameters:
| Name | Type |
|---|---|
conditions? |
FindConditions‹Department› |
options? |
FindOneOptions‹Department› |
Returns: Promise‹Department | undefined›
▸ findOneOrFail(id?: string | number | Date | ObjectID, options?: FindOneOptions‹Department›): Promise‹Department›
Inherited from DepartmentRepo.findOneOrFail
Defined in node_modules/typeorm/repository/Repository.d.ts:240
Finds first entity that matches given options.
Parameters:
| Name | Type |
|---|---|
id? |
string | number | Date | ObjectID |
options? |
FindOneOptions‹Department› |
Returns: Promise‹Department›
▸ findOneOrFail(options?: FindOneOptions‹Department›): Promise‹Department›
Inherited from DepartmentRepo.findOneOrFail
Defined in node_modules/typeorm/repository/Repository.d.ts:244
Finds first entity that matches given options.
Parameters:
| Name | Type |
|---|---|
options? |
FindOneOptions‹Department› |
Returns: Promise‹Department›
▸ findOneOrFail(conditions?: FindConditions‹Department›, options?: FindOneOptions‹Department›): Promise‹Department›
Inherited from DepartmentRepo.findOneOrFail
Defined in node_modules/typeorm/repository/Repository.d.ts:248
Finds first entity that matches given conditions.
Parameters:
| Name | Type |
|---|---|
conditions? |
FindConditions‹Department› |
options? |
FindOneOptions‹Department› |
Returns: Promise‹Department›
▸ getAll(options: IQueryOptions): Promise‹[Department[], number]›
Defined in src/database/repository/department.repository.ts:11
Parameters:
| Name | Type |
|---|---|
options |
IQueryOptions |
Returns: Promise‹[Department[], number]›
▸ getById(id: number): Promise‹Department›
Defined in src/database/repository/department.repository.ts:16
Parameters:
| Name | Type |
|---|---|
id |
number |
Returns: Promise‹Department›
▸ getId(entity: Department): any
Inherited from DepartmentRepo.getId
Defined in node_modules/typeorm/repository/Repository.d.ts:51
Gets entity mixed id.
Parameters:
| Name | Type |
|---|---|
entity |
Department |
Returns: any
▸ hasId(entity: Department): boolean
Inherited from DepartmentRepo.hasId
Defined in node_modules/typeorm/repository/Repository.d.ts:47
Checks if entity has an id. If entity composite compose ids, it will check them all.
Parameters:
| Name | Type |
|---|---|
entity |
Department |
Returns: boolean
▸ increment(conditions: FindConditions‹Department›, propertyPath: string, value: number | string): Promise‹UpdateResult›
Inherited from DepartmentRepo.increment
Defined in node_modules/typeorm/repository/Repository.d.ts:264
Increments some column by provided value of the entities matched given conditions.
Parameters:
| Name | Type |
|---|---|
conditions |
FindConditions‹Department› |
propertyPath |
string |
value |
number | string |
Returns: Promise‹UpdateResult›
▸ insert(entity: QueryDeepPartialEntity‹Department› | Array): Promise‹InsertResult›
Inherited from DepartmentRepo.insert
Defined in node_modules/typeorm/repository/Repository.d.ts:158
Inserts a given entity into the database. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient INSERT query. Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted.
Parameters:
| Name | Type |
|---|---|
entity |
QueryDeepPartialEntity‹Department› | Array |
Returns: Promise‹InsertResult›
▸ insertMany(departments: Department[]): Promise‹Department[]›
Defined in src/database/repository/department.repository.ts:24
Parameters:
| Name | Type |
|---|---|
departments |
Department[] |
Returns: Promise‹Department[]›
▸ insertOne(department: Department): Promise‹Department›
Defined in src/database/repository/department.repository.ts:20
Parameters:
| Name | Type |
|---|---|
department |
Department |
Returns: Promise‹Department›
▸ merge(mergeIntoEntity: Department, ...entityLikes: DeepPartial‹Department›[]): Department
Inherited from DepartmentRepo.merge
Defined in node_modules/typeorm/repository/Repository.d.ts:69
Merges multiple entities (or entity-like objects) into a given entity.
Parameters:
| Name | Type |
|---|---|
mergeIntoEntity |
Department |
...entityLikes |
DeepPartial‹Department›[] |
Returns: Department
▸ preload(entityLike: DeepPartial‹Department›): Promise‹Department | undefined›
Inherited from DepartmentRepo.preload
Defined in node_modules/typeorm/repository/Repository.d.ts:79
Creates a new entity from the given plan javascript object. If entity already exist in the database, then it loads it (and everything related to it), replaces all values with the new ones from the given object and returns this new entity. This new entity is actually a loaded from the db entity with all properties replaced from the new object.
Note that given entity-like object must have an entity id / primary key to find entity by. Returns undefined if entity with given id was not found.
Parameters:
| Name | Type |
|---|---|
entityLike |
DeepPartial‹Department› |
Returns: Promise‹Department | undefined›
▸ query(query: string, parameters?: any[]): Promise‹any›
Inherited from DepartmentRepo.query
Defined in node_modules/typeorm/repository/Repository.d.ts:253
Executes a raw SQL query and returns a raw database results. Raw query execution is supported only by relational databases (MongoDB is not supported).
Parameters:
| Name | Type |
|---|---|
query |
string |
parameters? |
any[] |
Returns: Promise‹any›
▸ recover<T>(entities: T[], options: SaveOptions & object): Promise‹T[]›
Inherited from DepartmentRepo.recover
Defined in node_modules/typeorm/repository/Repository.d.ts:135
Recovers all given entities in the database.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entities |
T[] |
options |
SaveOptions & object |
Returns: Promise‹T[]›
▸ recover<T>(entities: T[], options?: SaveOptions): Promise‹T & Entity[]›
Inherited from DepartmentRepo.recover
Defined in node_modules/typeorm/repository/Repository.d.ts:141
Recovers all given entities in the database.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entities |
T[] |
options? |
SaveOptions |
Returns: Promise‹T & Entity[]›
▸ recover<T>(entity: T, options: SaveOptions & object): Promise‹T›
Inherited from DepartmentRepo.recover
Defined in node_modules/typeorm/repository/Repository.d.ts:145
Recovers a given entity in the database.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entity |
T |
options |
SaveOptions & object |
Returns: Promise‹T›
▸ recover<T>(entity: T, options?: SaveOptions): Promise‹T & Department›
Inherited from DepartmentRepo.recover
Defined in node_modules/typeorm/repository/Repository.d.ts:151
Recovers a given entity in the database.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entity |
T |
options? |
SaveOptions |
Returns: Promise‹T & Department›
▸ remove(entities: Department[], options?: RemoveOptions): Promise‹Department[]›
Inherited from DepartmentRepo.remove
Defined in node_modules/typeorm/repository/Repository.d.ts:107
Removes a given entities from the database.
Parameters:
| Name | Type |
|---|---|
entities |
Department[] |
options? |
RemoveOptions |
Returns: Promise‹Department[]›
▸ remove(entity: Department, options?: RemoveOptions): Promise‹Department›
Inherited from DepartmentRepo.remove
Defined in node_modules/typeorm/repository/Repository.d.ts:111
Removes a given entity from the database.
Parameters:
| Name | Type |
|---|---|
entity |
Department |
options? |
RemoveOptions |
Returns: Promise‹Department›
▸ removeById(department: Department): Promise‹Department›
Defined in src/database/repository/department.repository.ts:36
Parameters:
| Name | Type |
|---|---|
department |
Department |
Returns: Promise‹Department›
▸ restore(criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department›): Promise‹UpdateResult›
Inherited from DepartmentRepo.restore
Defined in node_modules/typeorm/repository/Repository.d.ts:186
Restores entities by a given criteria. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient SOFT-DELETE query. Does not check if entity exist in the database.
Parameters:
| Name | Type |
|---|---|
criteria |
string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department› |
Returns: Promise‹UpdateResult›
▸ save<T>(entities: T[], options: SaveOptions & object): Promise‹T[]›
Inherited from DepartmentRepo.save
Defined in node_modules/typeorm/repository/Repository.d.ts:84
Saves all given entities in the database. If entities do not exist in the database then inserts, otherwise updates.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entities |
T[] |
options |
SaveOptions & object |
Returns: Promise‹T[]›
▸ save<T>(entities: T[], options?: SaveOptions): Promise‹T & Entity[]›
Inherited from DepartmentRepo.save
Defined in node_modules/typeorm/repository/Repository.d.ts:91
Saves all given entities in the database. If entities do not exist in the database then inserts, otherwise updates.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entities |
T[] |
options? |
SaveOptions |
Returns: Promise‹T & Entity[]›
▸ save<T>(entity: T, options: SaveOptions & object): Promise‹T›
Inherited from DepartmentRepo.save
Defined in node_modules/typeorm/repository/Repository.d.ts:96
Saves a given entity in the database. If entity does not exist in the database then inserts, otherwise updates.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entity |
T |
options |
SaveOptions & object |
Returns: Promise‹T›
▸ save<T>(entity: T, options?: SaveOptions): Promise‹T & Department›
Inherited from DepartmentRepo.save
Defined in node_modules/typeorm/repository/Repository.d.ts:103
Saves a given entity in the database. If entity does not exist in the database then inserts, otherwise updates.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entity |
T |
options? |
SaveOptions |
Returns: Promise‹T & Department›
▸ softDelete(criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department›): Promise‹UpdateResult›
Inherited from DepartmentRepo.softDelete
Defined in node_modules/typeorm/repository/Repository.d.ts:179
Records the delete date of entities by a given criteria. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient SOFT-DELETE query. Does not check if entity exist in the database.
Parameters:
| Name | Type |
|---|---|
criteria |
string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department› |
Returns: Promise‹UpdateResult›
▸ softRemove<T>(entities: T[], options: SaveOptions & object): Promise‹T[]›
Inherited from DepartmentRepo.softRemove
Defined in node_modules/typeorm/repository/Repository.d.ts:115
Records the delete date of all given entities.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entities |
T[] |
options |
SaveOptions & object |
Returns: Promise‹T[]›
▸ softRemove<T>(entities: T[], options?: SaveOptions): Promise‹T & Entity[]›
Inherited from DepartmentRepo.softRemove
Defined in node_modules/typeorm/repository/Repository.d.ts:121
Records the delete date of all given entities.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entities |
T[] |
options? |
SaveOptions |
Returns: Promise‹T & Entity[]›
▸ softRemove<T>(entity: T, options: SaveOptions & object): Promise‹T›
Inherited from DepartmentRepo.softRemove
Defined in node_modules/typeorm/repository/Repository.d.ts:125
Records the delete date of a given entity.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entity |
T |
options |
SaveOptions & object |
Returns: Promise‹T›
▸ softRemove<T>(entity: T, options?: SaveOptions): Promise‹T & Department›
Inherited from DepartmentRepo.softRemove
Defined in node_modules/typeorm/repository/Repository.d.ts:131
Records the delete date of a given entity.
Type parameters:
▪ T: DeepPartial‹Department›
Parameters:
| Name | Type |
|---|---|
entity |
T |
options? |
SaveOptions |
Returns: Promise‹T & Department›
▸ update(criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department›, partialEntity: QueryDeepPartialEntity‹Department›): Promise‹UpdateResult›
Inherited from DepartmentRepo.update
Defined in node_modules/typeorm/repository/Repository.d.ts:165
Updates entity partially. Entity can be found by a given conditions. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient UPDATE query. Does not check if entity exist in the database.
Parameters:
| Name | Type |
|---|---|
criteria |
string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions‹Department› |
partialEntity |
QueryDeepPartialEntity‹Department› |
Returns: Promise‹UpdateResult›