Class: BaseEntityService<ENTITY, ID, REPOSITORY, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

service-api/src.BaseEntityService

Extends

• AbstractBaseService<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Type parameters

▪ ENTITY extends BaseEntity

▪ ID extends keyof ENTITY

▪ REPOSITORY extends AbstractRepository<ENTITY, ID, unknown, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

▪ FIELDS_REQUIRED_FOR_UPDATE extends keyof ENTITY = ID

▪ AUTO_GENERATED_FIELDS extends keyof ENTITY = ID

Constructors

new BaseEntityService(repository)

new BaseEntityService<ENTITY, ID, REPOSITORY, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>(repository): BaseEntityService<ENTITY, ID, REPOSITORY, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Parameters

▪ repository: REPOSITORY

Returns

BaseEntityService<ENTITY, ID, REPOSITORY, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Overrides

AbstractBaseService.constructor

Source

libs/service-api/src/lib/base-entity.service.ts:30

Properties

repository

protected readonly repository: REPOSITORY

Source

libs/service-api/src/lib/base-entity.service.ts:30

Methods

create

create(entity)

create(entity): Promise<ENTITY>

Parameters

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

Returns

Promise<ENTITY>

Overrides

AbstractBaseService.create

Source

libs/service-api/src/lib/base-entity.service.ts:34

create(entities)

create(entities): Promise<ENTITY[]>

Parameters

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

Returns

Promise<ENTITY[]>

Overrides

AbstractBaseService.create

Source

libs/service-api/src/lib/base-entity.service.ts:38

---

delete

delete(id): Promise<boolean>

Parameters

▪ id: ENTITY[ID] | ENTITY[ID][]

Returns

Promise<boolean>

Overrides

AbstractBaseService.delete

Source

libs/service-api/src/lib/base-entity.service.ts:208

---

findAll

findAll(page, limit): Promise<ENTITY[]>

Parameters

▪ page: number= 0

▪ limit: number= 100

Returns

Promise<ENTITY[]>

Overrides

AbstractBaseService.findAll

Source

libs/service-api/src/lib/base-entity.service.ts:200

---

findAllPaginated

findAllPaginated<T>(query, config, clazz?, options?): Promise<Paginated<T>>

Type parameters

▪ T = ENTITY

Parameters

▪ query: PaginateQuery

▪ config: PaginateConfig<ENTITY>

▪ clazz?: ClassConstructor<T>

▪ options?: ClassTransformOptions

Returns

Promise<Paginated<T>>

Overrides

AbstractBaseService.findAllPaginated

Source

libs/service-api/src/lib/base-entity.service.ts:180

---

findById

findById(id)

findById(id): Promise<ENTITY>

Parameters

▪ id: ENTITY[ID]

Returns

Promise<ENTITY>

Overrides

AbstractBaseService.findById

Source

libs/service-api/src/lib/base-entity.service.ts:150

findById(id, throwExceptionIfNotFound)

findById(id, throwExceptionIfNotFound): Promise<ENTITY>

Parameters

▪ id: ENTITY[ID]

▪ throwExceptionIfNotFound: true

Returns

Promise<ENTITY>

Overrides

AbstractBaseService.findById

Source

libs/service-api/src/lib/base-entity.service.ts:151

findById(id, throwExceptionIfNotFound)

findById(id, throwExceptionIfNotFound): Promise<ENTITY>

Parameters

▪ id: ENTITY[ID]

▪ throwExceptionIfNotFound: false

Returns

Promise<ENTITY>

Overrides

AbstractBaseService.findById

Source

libs/service-api/src/lib/base-entity.service.ts:152

findById(ids)

findById(ids): Promise<ENTITY[]>

Parameters

▪ ids: ENTITY[ID][]

Returns

Promise<ENTITY[]>

Overrides

AbstractBaseService.findById

Source

libs/service-api/src/lib/base-entity.service.ts:156

---

partialUpdate

partialUpdate(entity)

partialUpdate(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>>

Overrides

AbstractBaseService.partialUpdate

Source

libs/service-api/src/lib/base-entity.service.ts:121

partialUpdate(entities)

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

Parameters

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

Returns

Promise<Partial<ENTITY>[]>

Overrides

AbstractBaseService.partialUpdate

Source

libs/service-api/src/lib/base-entity.service.ts:126

---

update

update(entity)

update(entity): Promise<ENTITY>

Parameters

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

Returns

Promise<ENTITY>

Overrides

AbstractBaseService.update

Source

libs/service-api/src/lib/base-entity.service.ts:55

update(entities)

update(entities): Promise<ENTITY[]>

Parameters

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

Returns

Promise<ENTITY[]>

Overrides

AbstractBaseService.update

Source

libs/service-api/src/lib/base-entity.service.ts:60

---

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>

Overrides

AbstractBaseService.upsert

Source

libs/service-api/src/lib/base-entity.service.ts:83

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[]>

Overrides

AbstractBaseService.upsert

Source

libs/service-api/src/lib/base-entity.service.ts:91

---

Generated using typedoc-plugin-markdown and TypeDoc