Interface Repository<T>

Type Parameters

T extends StoredRepositoryItem

Hierarchy

Repository

Implemented by

Index

Methods

createItem deleteAll deleteById deleteByIdList deleteByList findById findByIdAndUpdate findByProperty getAll getAllByProperty getSome inviteToItem isRepositoryEntryList subscribeToItem update updateOrCreateItem waitById

Methods

createItem

createItem(data: T, members?: readonly string[]): Promise<RepositoryEntry<T>>
Parameters
- data: T
- Optional members: readonly string[]
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:41

deleteAll

deleteAll(): Promise<readonly RepositoryEntry<T>[]>
Returns Promise<readonly RepositoryEntry<T>[]>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:52

deleteById

deleteById(id: string): Promise<RepositoryEntry<T>>
Parameters
- id: string
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:49

deleteByIdList

deleteByIdList(list: readonly string[]): Promise<readonly RepositoryEntry<T>[]>
Parameters
- list: readonly string[]
Returns Promise<readonly RepositoryEntry<T>[]>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:50

deleteByList

deleteByList(list: readonly RepositoryEntry<T>[]): Promise<readonly RepositoryEntry<T>[]>
Parameters
- list: readonly RepositoryEntry<T>[]
Returns Promise<readonly RepositoryEntry<T>[]>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:51

findById

findById(id: string, includeMembers?: boolean): Promise<RepositoryEntry<T>>
Parameters
- id: string
- Optional includeMembers: boolean
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:11

findByIdAndUpdate

findByIdAndUpdate(id: string, item: T): Promise<RepositoryEntry<T>>
Parameters
- id: string
- item: T
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:21

findByProperty

findByProperty(propertyName: string, propertyValue: any): Promise<RepositoryEntry<T>>
Parameters
- propertyName: string
- propertyValue: any
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:16

getAll

getAll(): Promise<readonly RepositoryEntry<T>[]>
Returns Promise<readonly RepositoryEntry<T>[]>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:32

getAllByProperty

getAllByProperty(propertyName: string, propertyValue: any): Promise<readonly RepositoryEntry<T>[]>
Parameters
- propertyName: string
- propertyValue: any
Returns Promise<readonly RepositoryEntry<T>[]>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:36

getSome

getSome(idList: readonly string[]): Promise<readonly RepositoryEntry<T>[]>
Parameters
- idList: readonly string[]
Returns Promise<readonly RepositoryEntry<T>[]>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:34

inviteToItem

inviteToItem(id: string, members: readonly string[]): Promise<void>
Parameters
- id: string
- members: readonly string[]
Returns Promise<void>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:54

isRepositoryEntryList

isRepositoryEntryList(list: any): list is RepositoryEntry<T>[]
Parameters
- list: any
Returns list is RepositoryEntry<T>[]
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:58

subscribeToItem

subscribeToItem(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:56

update

update(id: string, data: T): Promise<RepositoryEntry<T>>
Parameters
- id: string
- data: T
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:46

updateOrCreateItem

updateOrCreateItem(item: T): Promise<RepositoryEntry<T>>
Parameters
- item: T
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:47

waitById

waitById(id: string, includeMembers?: boolean, timeout?: number): Promise<RepositoryEntry<T>>
Parameters
- id: string
- Optional includeMembers: boolean
- Optional timeout: number
Returns Promise<RepositoryEntry<T>>
- Defined in fi/hg/core/simpleRepository/types/Repository.ts:26

Generated using TypeDoc