Class RolesRepository

The Role repository

Hierarchy

BaseRepository<IRole, Role>
- RolesRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RolesRepository(roleModel: Model<IRole>): RolesRepository

Overrides BaseRepository.constructor
- Defined in repositories/roles.repository.ts:13
Initialize RolesRepository

Parameters
- roleModel: Model<IRole>
  
  The injected RoleSchema model
Returns RolesRepository

Properties

collectionName

collectionName: string

The collection name, used also as controller route name

Protected model

model: Model<IRole>

The mongoose model for this repository

Protected roleModel

roleModel: Model<IRole>

The injected RoleSchema model

Methods

create

create(item: Role): Promise<IRole>

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

Parameters
- item: Role
  
  The item to create
Returns Promise<IRole>

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<Role>): DocumentQuery<IRole[], IRole>

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

Parameters
- Optional query: RepositoryQuery<Role>
Returns DocumentQuery<IRole[], IRole>

findOne

findOne(query?: RepositoryQuery<Role>): Promise<IRole>

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<Role>
  
  The query. If not specified return the first collection element
Returns Promise<IRole>

get

get(id: string): Promise<IRole>

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

getOrCreateOne

getOrCreateOne(type: number | RoleType, name: string): Promise<IRole>

- Defined in repositories/roles.repository.ts:31
Gets or create a role. Reject with an error if the operation fails

Parameters
- type: number | RoleType
  
  The role type
- name: string
  
  The role name
Returns Promise<IRole>

partialUpdate

partialUpdate(id: string, item: Partial<Role>): Promise<IRole>

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<Role>
  
  The item to update
Returns Promise<IRole>

update

update(item: Role): Promise<IRole>

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

Parameters
- item: Role
Returns Promise<IRole>

Generated using TypeDoc