Class BaseRepository<MongooseDocumentOfDto, Dto>

Type parameters

MongooseDocumentOfDto: IBaseEntity & Dto
Dto: BaseEntity<Dto>

Hierarchy

BaseRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseRepository(model: Model<MongooseDocumentOfDto>, collectionName: string): BaseRepository

- Defined in repositories/base/base.repository.ts:14
Initialize the base repository

Parameters
- model: Model<MongooseDocumentOfDto>
  
  The mongoose model for this repository
- collectionName: string
  
  The collection name, used also as controller route name
Returns BaseRepository

Properties

collectionName

collectionName: string

The collection name, used also as controller route name

Protected model

model: Model<MongooseDocumentOfDto>

The mongoose model for this repository

Methods

create

create(item: Dto): Promise<MongooseDocumentOfDto>

- Defined in repositories/base/base.repository.ts:45
Creates a new item

Parameters
- item: Dto
  
  The item to create
Returns Promise<MongooseDocumentOfDto>

delete

delete(id: string): Promise<boolean>

- Defined in repositories/base/base.repository.ts:83
Delete an existing element

Parameters
- id: string
  
  The element identifier
Returns Promise<boolean>

find

find(query?: RepositoryQuery<Dto>): DocumentQuery<MongooseDocumentOfDto[], MongooseDocumentOfDto>

- Defined in repositories/base/base.repository.ts:102
Return all elements matching the specified query

Parameters
- Optional query: RepositoryQuery<Dto>
Returns DocumentQuery<MongooseDocumentOfDto[], MongooseDocumentOfDto>

findOne

findOne(query?: RepositoryQuery<Dto>): Promise<MongooseDocumentOfDto>

- Defined in repositories/base/base.repository.ts:110
Return a the first element matching the specified query

Parameters
- Optional query: RepositoryQuery<Dto>
  
  The query. If not specified return the first collection element
Returns Promise<MongooseDocumentOfDto>

get

get(id: string): Promise<MongooseDocumentOfDto>

- Defined in repositories/base/base.repository.ts:93
Return the item with specified id if exists, null otherwise.

Parameters
- id: string
  
  The item identifier (id property of [[BaseEntity]])
Returns Promise<MongooseDocumentOfDto>

Private getObjectId

getObjectId(objectId: string): ObjectID

- Defined in repositories/base/base.repository.ts:33
Return the ObjectID or throw an exception if invalid

Parameters
- objectId: string
  
  The string ObjectID
Returns ObjectID

partialUpdate

partialUpdate(id: string, item: Partial<Dto>): Promise<MongooseDocumentOfDto>

- Defined in repositories/base/base.repository.ts:72
Update only the specified property of the item

Parameters
- id: string
- item: Partial<Dto>
  
  The item to update
Returns Promise<MongooseDocumentOfDto>

update

update(item: Dto): Promise<MongooseDocumentOfDto>

- Defined in repositories/base/base.repository.ts:58
Create or update an element

Parameters
- item: Dto
Returns Promise<MongooseDocumentOfDto>

Generated using TypeDoc