improved coverage, type docs, removed startsWith option and general refactoring

This commit is contained in:
Kristof De Langhe
2018-08-09 12:37:09 +02:00
parent 883a1d8881
commit 072507b293
13 changed files with 74 additions and 90 deletions

View File

@@ -133,6 +133,15 @@ export class BrowseService {
return this.rdb.toRemoteDataObservable(requestEntry$, responseCache$, payload$);
}
/**
* Get all items linked to a certain metadata value
* @param {string} definitionID definition ID to define the metadata-field (e.g. author)
* @param {string} filterValue metadata value to filter by (e.g. author's name)
* @param options Options to narrow down your search:
* { pagination: PaginationComponentOptions,
* sort: SortOptions }
* @returns {Observable<RemoteData<PaginatedList<Item>>>}
*/
getBrowseItemsFor(definitionID: string, filterValue: string, options: {
pagination?: PaginationComponentOptions;
sort?: SortOptions;