Skip to main content

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

service-api/src.AbstractBaseService

Extended By​

Type parameters​

▪ ENTITY extends BaseEntity

▪ ID extends keyof ENTITY

▪ FIELDS_REQUIRED_FOR_UPDATE extends keyof ENTITY = ID

▪ AUTO_GENERATED_FIELDS extends keyof ENTITY = ID | keyof BaseEntity

Constructors​

new AbstractBaseService()​

new AbstractBaseService<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>(): AbstractBaseService<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Returns​

AbstractBaseService<ENTITY, ID, FIELDS_REQUIRED_FOR_UPDATE, AUTO_GENERATED_FIELDS>

Methods​

abstract create​

create(entity)​

abstract create(entity): Promise<ENTITY>

Parameters​

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

Returns​

Promise<ENTITY>

Source​

libs/service-api/src/lib/abstract-base.service.ts:25

create(entities)​

abstract create(entities): Promise<ENTITY[]>

Parameters​

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

Returns​

Promise<ENTITY[]>

Source​

libs/service-api/src/lib/abstract-base.service.ts:29

abstract delete​

abstract delete(id): Promise<boolean>

Parameters​

▪ id: ENTITY[ID]

Returns​

Promise<boolean>

Source​

libs/service-api/src/lib/abstract-base.service.ts:89

abstract findAll​

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

Parameters​

▪ page: number

▪ limit: number

Returns​

Promise<ENTITY[]>

Source​

libs/service-api/src/lib/abstract-base.service.ts:67

abstract findAllPaginated​

abstract 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>>

Source​

libs/service-api/src/lib/abstract-base.service.ts:82

abstract findById​

findById(id, throwExceptionIfNotFound)​

abstract findById(id, throwExceptionIfNotFound): Promise<ENTITY>

Parameters​

▪ id: ENTITY[ID]

▪ throwExceptionIfNotFound: true

Returns​

Promise<ENTITY>

Source​

libs/service-api/src/lib/abstract-base.service.ts:69

findById(ids)​

abstract findById(ids): Promise<ENTITY[]>

Parameters​

▪ ids: ENTITY[ID][]

Returns​

Promise<ENTITY[]>

Source​

libs/service-api/src/lib/abstract-base.service.ts:73

findById(id, throwExceptionIfNotFound)​

abstract findById(id, throwExceptionIfNotFound): Promise<ENTITY>

Parameters​

▪ id: ENTITY[ID]

▪ throwExceptionIfNotFound: false

Returns​

Promise<ENTITY>

Source​

libs/service-api/src/lib/abstract-base.service.ts:75

findById(ids)​

abstract findById(ids): Promise<ENTITY[]>

Parameters​

▪ ids: ENTITY[ID][]

Returns​

Promise<ENTITY[]>

Source​

libs/service-api/src/lib/abstract-base.service.ts:80

abstract partialUpdate​

partialUpdate(entity)​

abstract 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>>

Source​

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

partialUpdate(entities)​

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

Parameters​

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

Returns​

Promise<Partial<ENTITY>[]>

Source​

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

abstract update​

update(entity)​

abstract update(entity): Promise<ENTITY>

Parameters​

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

Returns​

Promise<ENTITY>

Source​

libs/service-api/src/lib/abstract-base.service.ts:13

update(entities)​

abstract update(entities): Promise<ENTITY[]>

Parameters​

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

Returns​

Promise<ENTITY[]>

Source​

libs/service-api/src/lib/abstract-base.service.ts:18

abstract upsert​

upsert(entity)​

abstract 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>

Source​

libs/service-api/src/lib/abstract-base.service.ts:35

upsert(entities)​

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

Source​

libs/service-api/src/lib/abstract-base.service.ts:43

Generated using typedoc-plugin-markdown and TypeDoc