Class CompaniesRepository

The Company repository

Hierarchy

BaseRepository<ICompany, Company>
- CompaniesRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompaniesRepository(companyModel: Model<ICompany>): CompaniesRepository

Overrides BaseRepository.constructor
- Defined in repositories/companies.repository.ts:14
Initialize UsersRepository

Parameters
- companyModel: Model<ICompany>
  
  The injected CompanyModel model
Returns CompaniesRepository

Properties

collectionName

collectionName: string

The collection name, used also as controller route name

Protected companyModel

companyModel: Model<ICompany>

The injected CompanyModel model

Protected model

model: Model<ICompany>

The mongoose model for this repository

Methods

create

create(item: Company): Promise<ICompany>

Inherited from BaseRepository.create
- Defined in repositories/base/base.repository.ts:45
Creates a new item

Parameters
- item: Company
  
  The item to create
Returns Promise<ICompany>

delete

delete(id: string): Promise<boolean>

Inherited from BaseRepository.delete
- 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<Company>): DocumentQuery<ICompany[], ICompany>

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

Parameters
- Optional query: RepositoryQuery<Company>
Returns DocumentQuery<ICompany[], ICompany>

findOne

findOne(query?: RepositoryQuery<Company>): Promise<ICompany>

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

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

get

get(id: string): Promise<ICompany>

Inherited from BaseRepository.get
- 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<ICompany>

getByOwnerId

getByOwnerId(id: string): DocumentQuery<ICompany[], ICompany>

- Defined in repositories/companies.repository.ts:31
Return all the companies of which the given user id is a owner

Parameters
- id: string
  
  The owner id
Returns DocumentQuery<ICompany[], ICompany>

partialUpdate

partialUpdate(id: string, item: Partial<Company>): Promise<ICompany>

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

Parameters
- id: string
- item: Partial<Company>
  
  The item to update
Returns Promise<ICompany>

update

update(item: Company): Promise<ICompany>

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

Parameters
- item: Company
Returns Promise<ICompany>

Generated using TypeDoc