Class Repository<T, CreateData, UpdateData>

A repository that handles database related things for its entity.

Type Parameters

T extends BaseEntity
CreateData extends DeepPartial<T> = DeepPartial<T>
UpdateData extends DeepPartial<T> = DeepPartial<T>

Index

Constructors

constructor

Methods

create createAll deleteAll deleteById findAll findAllPaginated findById findOne updateAll updateById

Constructors

constructor

new Repository<
    T extends BaseEntity,
    CreateData extends BaseEntity | { id?: string } = DeepPartial<T>,
    UpdateData extends BaseEntity | { id?: string } = DeepPartial<T>,
>(
    entityClass: Newable<T>,
    repo: Repository<T> | Repository<T, DeepPartial<T>, DeepPartial<T>>,
): Repository<T, CreateData, UpdateData>
Type Parameters
- T extends BaseEntity
- CreateData extends BaseEntity | { id?: string } = DeepPartial<T>
- UpdateData extends BaseEntity | { id?: string } = DeepPartial<T>
Parameters
- entityClass: Newable<T>
- repo: Repository<T> | Repository<T, DeepPartial<T>, DeepPartial<T>>
Returns Repository<T, CreateData, UpdateData>
- Defined in src/data-source/repository.model.ts:26

Methods

create

create(data: CreateData, options?: CreateOptions): Promise<T>
Creates a new entity from the given data. Internally this uses insert.
Parameters
- data: CreateData
  The create data.
- Optionaloptions: CreateOptions
  Additional options, like a transaction etc.
Returns Promise<T>
The newly created entity.
- Defined in src/data-source/repository.model.ts:70

createAll

createAll(data: CreateData[], options?: CreateAllOptions): Promise<T[]>
Creates all entities from the provided data array.
Parameters
- data: CreateData[]
  An array of create data, which each creates a new entity.
- Optionaloptions: CreateAllOptions
  Additional options, eg. A transaction.
Returns Promise<T[]>
All newly created entities.
- Defined in src/data-source/repository.model.ts:86

deleteAll

deleteAll(
where: Where<T>,
options?: OmitStrict<DeleteAllOptions<T>, "where">,
): Promise<T[]>
Deletes all entities that match the provided where filter.
Parameters
- where: Where<T>
  The where filter to find the entities that should be deleted.
- Optionaloptions: OmitStrict<DeleteAllOptions<T>, "where">
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
- Defined in src/data-source/repository.model.ts:227

deleteById

deleteById(id: T["id"], options?: BaseRepositoryOptions): Promise<void>
Deletes an entity with the provided id.
Parameters
- id: T["id"]
  The id of the entity to deleted.
- Optionaloptions: BaseRepositoryOptions
  Additional options, like a transaction.
Returns Promise<void>
- Defined in src/data-source/repository.model.ts:215

findAll

findAll(options?: FindAllOptions<T>): Promise<T[]>
Finds all entities with the given options.
Parameters
- Optionaloptions: FindAllOptions<T>
  The options, including the where filter etc.
Returns Promise<T[]>
An array of found entities.
- Defined in src/data-source/repository.model.ts:143

findAllPaginated

findAllPaginated(
    page: number,
    limit: number,
    options?: FindAllPaginatedOptions<T>,
): Promise<PaginationResult<T>>
Finds all entities with the given options, in paginated form.
Parameters
- page: number
  The page for which the entities should be found.
- limit: number
  The limit of entities to receive for that page.
- Optionaloptions: FindAllPaginatedOptions<T>
  Additional options including where filter etc.
Returns Promise<PaginationResult<T>>
A paginated result of the found entities.
- Defined in src/data-source/repository.model.ts:156

findById

findById(id: T["id"], options?: FindByIdOptions<T>): Promise<T>
Finds an entity by the given id.
Parameters
- id: T["id"]
  The id of the entity to find.
- Optionaloptions: FindByIdOptions<T>
  Additional options, eg. Transaction.
Returns Promise<T>
The found entity.
- Defined in src/data-source/repository.model.ts:111

findOne

findOne<B extends boolean = true>(
options: FindOneOptions<T>,
required?: B,
): Promise<B extends false ? undefined | T : T>
Finds a single entity with the given options.
Type Parameters
- B extends boolean = true
Parameters
- options: FindOneOptions<T>
  The options, including the where filter etc.
- required: B = ...
  Whether or not a result is required. Defaults to true.
Returns Promise<B extends false ? undefined | T : T>
The found result. If required is set to false, also undefined.
- Defined in src/data-source/repository.model.ts:125

updateAll

updateAll(
    where: Where<T>,
    data: UpdateData,
    options?: UpdateAllOptions,
): Promise<T[]>
Updates all entities that match the provided where filter.
Parameters
- where: Where<T>
  The where filter to find the entities that should be updated.
- data: UpdateData
  The data to update the entities with.
- Optionaloptions: UpdateAllOptions
  Additional options, like a transaction.
Returns Promise<T[]>
An array of all the updated entities.
- Defined in src/data-source/repository.model.ts:195

updateById

updateById(
    id: T["id"],
    data: UpdateData,
    options?: UpdateByIdOptions,
): Promise<T>
Updates an entity with the provided id.
Parameters
- id: T["id"]
  The id of the entity to update.
- data: UpdateData
  The data to update the entity with.
- Optionaloptions: UpdateByIdOptions
  Additional options, like a transaction.
Returns Promise<T>
The updated entity.
- Defined in src/data-source/repository.model.ts:178

Class Repository<T, CreateData, UpdateData>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Repository<T, CreateData, UpdateData>

Methods

create

Parameters

Returns Promise<T>

createAll

Parameters

Returns Promise<T[]>

deleteAll

Parameters

Returns Promise<T[]>

deleteById

Parameters

Returns Promise<void>

findAll

Parameters

Returns Promise<T[]>

findAllPaginated

Parameters

Returns Promise<PaginationResult<T>>

findById

Parameters

Returns Promise<T>

findOne

Type Parameters

Parameters

Returns Promise<B extends false ? undefined | T : T>

updateAll

Parameters

Returns Promise<T[]>

updateById

Parameters

Returns Promise<T>

Settings

On This Page