Class: abstract BaseTypeormTrackedEntityRepository<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

typeorm/src.BaseTypeormTrackedEntityRepository

Extends

• BaseTypeormEntityRepository<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Type parameters

▪ ENTITY extends BaseTrackedEntityHelper

▪ ID extends keyof ENTITY

▪ FIELDS_REQUIRED_FOR_UPDATE extends keyof ENTITY = ID

▪ AUTO_GENERATED_FIELDS extends keyof ENTITY = keyof BaseTrackedEntityHelper | ID

Implements

• ITrackedRepository<ENTITY, ID, FindOptionsWhere<ENTITY>>

Constructors

new BaseTypeormTrackedEntityRepository(entityTarget, dataSource, idFieldName)

protected new BaseTypeormTrackedEntityRepository<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>(entityTarget, dataSource, idFieldName): BaseTypeormTrackedEntityRepository<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Parameters

▪ entityTarget: ObjectType<ENTITY>

▪ dataSource: DataSource

▪ idFieldName: ID

Returns

BaseTypeormTrackedEntityRepository<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Overrides

BaseTypeormEntityRepository.constructor

Source

libs/typeorm/src/lib/repositories/base-typeorm-tracked-entity.repository.ts:23

Properties

dataSource

protected dataSource: DataSource

Inherited from

BaseTypeormEntityRepository.dataSource

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:38

---

entityTarget

protected entityTarget: ObjectType<ENTITY>

Inherited from

BaseTypeormEntityRepository.entityTarget

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:37

---

idFieldName

protected idFieldName: ID

Inherited from

BaseTypeormEntityRepository.idFieldName

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:39

---

logger

protected readonly logger: Logger

Inherited from

BaseTypeormEntityRepository.logger

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:33

---

typeormRepository

protected typeormRepository: Repository<ENTITY>

Inherited from

BaseTypeormEntityRepository.typeormRepository

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:34

Methods

archive

archive(criteria)

archive(criteria): Promise<boolean>

Parameters

▪ criteria: ENTITY[ID]

Returns

Promise<boolean>

Implementation of

ITrackedRepository.archive

Source

libs/typeorm/src/lib/repositories/base-typeorm-tracked-entity.repository.ts:31

archive(criteria)

archive(criteria): Promise<boolean>

Parameters

▪ criteria: ENTITY[ID][]

Returns

Promise<boolean>

Implementation of

ITrackedRepository.archive

Source

libs/typeorm/src/lib/repositories/base-typeorm-tracked-entity.repository.ts:32

---

count

count(query): Promise<number>

Parameters

▪ query: FindOptionsWhere<ENTITY> | FindOptionsWhere<ENTITY>[]= {}

Returns

Promise<number>

Inherited from

BaseTypeormEntityRepository.count

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:45

---

create

create(entity)

create(entity): Promise<ENTITY>

create entity if it already exists -> throw error

Parameters

▪ entity: Omit<ENTITY, AUTO_GENERATED_FIELDS> & Partial<Pick<ENTITY, ID>>

Returns

Promise<ENTITY>

Inherited from

BaseTypeormEntityRepository.create

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:206

create(entities)

create(entities): Promise<ENTITY[]>

Parameters

▪ entities: Omit<ENTITY, AUTO_GENERATED_FIELDS> & Partial<Pick<ENTITY, ID>>[]

Returns

Promise<ENTITY[]>

Inherited from

BaseTypeormEntityRepository.create

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:210

---

delete

delete(id)

delete(id): Promise<boolean>

Parameters

▪ id: ENTITY[ID]

Returns

Promise<boolean>

Inherited from

BaseTypeormEntityRepository.delete

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:101

delete(id)

delete(id): Promise<boolean>

Parameters

▪ id: ENTITY[ID][]

Returns

Promise<boolean>

Inherited from

BaseTypeormEntityRepository.delete

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:102

---

entityName

entityName(): string

usually it's just a class name, but it can be a table name or any other entity identifier, useful for i18n keys

Returns

string

Inherited from

BaseTypeormEntityRepository.entityName

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:251

---

findAll

findAll(query?, limitOptions?): Promise<ENTITY[]>

Parameters

▪ query?: FindOptionsWhere<ENTITY> | FindOptionsWhere<ENTITY>[]

▪ limitOptions?: LimitOptions= undefined

Returns

Promise<ENTITY[]>

Inherited from

BaseTypeormEntityRepository.findAll

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:120

---

findAllPaginated

findAllPaginated(query, config): Promise<Paginated<ENTITY>>

Parameters

▪ query: PaginateQuery

▪ config: PaginateConfig<ENTITY>

Returns

Promise<Paginated<ENTITY>>

Inherited from

BaseTypeormEntityRepository.findAllPaginated

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:51

---

findAllWithArchived

findAllWithArchived(where, limitOptions?): Promise<ENTITY[]>

Parameters

▪ where: FindOptionsWhere<ENTITY>

▪ limitOptions?: LimitOptions

Returns

Promise<ENTITY[]>

Implementation of

ITrackedRepository.findAllWithArchived

Source

libs/typeorm/src/lib/repositories/base-typeorm-tracked-entity.repository.ts:66

---

findById

findById(id)

findById(id): Promise<ENTITY>

Parameters

▪ id: ENTITY[ID]

Returns

Promise<ENTITY>

Inherited from

BaseTypeormEntityRepository.findById

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:65

findById(ids)

findById(ids): Promise<ENTITY[]>

Parameters

▪ ids: ENTITY[ID][]

Returns

Promise<ENTITY[]>

Inherited from

BaseTypeormEntityRepository.findById

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:66

---

findOne

findOne(where): Promise<ENTITY>

Parameters

▪ where: FindOptionsWhere<ENTITY> | FindOptionsWhere<ENTITY>[]

Returns

Promise<ENTITY>

Inherited from

BaseTypeormEntityRepository.findOne

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:88

---

presetWhereOptions

protected presetWhereOptions(criteria): FindOptionsWhere<ENTITY> | FindOptionsWhere<ENTITY>[]

Used for auto filter population, useful for permission systems, global filters for security like by tenant id, or any other creative filters

Parameters

▪ criteria: FindOptionsWhere<ENTITY> | FindOptionsWhere<ENTITY>[]

Returns

FindOptionsWhere<ENTITY> | FindOptionsWhere<ENTITY>[]

Inherited from

BaseTypeormEntityRepository.presetWhereOptions

Source

libs/persistence-api/src/lib/repository/abstract.repository.ts:109

---

restore

restore(id)

restore(id): Promise<boolean>

Parameters

▪ id: ENTITY[ID]

Returns

Promise<boolean>

Implementation of

ITrackedRepository.restore

Source

libs/typeorm/src/lib/repositories/base-typeorm-tracked-entity.repository.ts:48

restore(ids)

restore(ids): Promise<boolean>

Parameters

▪ ids: ENTITY[ID][]

Returns

Promise<boolean>

Implementation of

ITrackedRepository.restore

Source

libs/typeorm/src/lib/repositories/base-typeorm-tracked-entity.repository.ts:49

---

save

protected save(entities): Promise<ENTITY | ENTITY[]>

Parameters

▪ entities: unknown

Returns

Promise<ENTITY | ENTITY[]>

Inherited from

BaseTypeormEntityRepository.save

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:255

---

update

update(entity)

update(entity): Promise<ENTITY>

update entity if it doesn't exists -> throw error

Parameters

▪ entity: Omit<ENTITY, AUTO_GENERATED_FIELDS> & Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>

Returns

Promise<ENTITY>

Inherited from

BaseTypeormEntityRepository.update

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:227

update(entities)

update(entities): Promise<ENTITY[]>

Parameters

▪ entities: Omit<ENTITY, AUTO_GENERATED_FIELDS> & Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>[]

Returns

Promise<ENTITY[]>

Inherited from

BaseTypeormEntityRepository.update

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:232

---

updateByQuery

updateByQuery(fields, query): Promise<number>

Parameters

▪ fields: Partial<Omit<ENTITY, AUTO_GENERATED_FIELDS>>

▪ query: FindOptionsWhere<ENTITY>

Returns

Promise<number>

Inherited from

BaseTypeormEntityRepository.updateByQuery

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:135

---

updatePartial

updatePartial(entity)

updatePartial(entity): Promise<Partial<ENTITY>>

update entity partial if it doesn't exist -> throw error

Parameters

▪ entity: Partial<Omit<ENTITY, AUTO_GENERATED_FIELDS>> & Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>

Returns

Promise<Partial<ENTITY>>

Inherited from

BaseTypeormEntityRepository.updatePartial

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:149

updatePartial(entities)

updatePartial(entities): Promise<Partial<ENTITY>[]>

Parameters

▪ entities: Partial<Omit<ENTITY, AUTO_GENERATED_FIELDS>> & Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>[]

Returns

Promise<Partial<ENTITY>[]>

Inherited from

BaseTypeormEntityRepository.updatePartial

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:154

---

upsert

upsert(entity)

upsert(entity): Promise<ENTITY>

Parameters

▪ entity: Omit<ENTITY, FIELDS_REQUIRED_FOR_UPDATE | AUTO_GENERATED_FIELDS> & Partial<Never<Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>>> | Omit<ENTITY, FIELDS_REQUIRED_FOR_UPDATE | AUTO_GENERATED_FIELDS> & Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>

Returns

Promise<ENTITY>

Inherited from

BaseTypeormEntityRepository.upsert

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:173

upsert(entities)

upsert(entities): Promise<ENTITY[]>

Parameters

▪ entities: (Omit<ENTITY, FIELDS_REQUIRED_FOR_UPDATE | AUTO_GENERATED_FIELDS> & Partial<Never<Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>>> | Omit<ENTITY, FIELDS_REQUIRED_FOR_UPDATE | AUTO_GENERATED_FIELDS> & Pick<ENTITY, FIELDS_REQUIRED_FOR_UPDATE>)[]

Returns

Promise<ENTITY[]>

Inherited from

BaseTypeormEntityRepository.upsert

Source

libs/typeorm/src/lib/repositories/base-typeorm-entity.repository.ts:181

---

Generated using typedoc-plugin-markdown and TypeDoc