hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-12 12:33:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

DS-4107 Improve TypeDocs

Browse Source
This commit is contained in:
Chris Wilper
2019-02-14 14:46:27 -05:00
parent 6474cbfafb
commit 4c8747a345
5 changed files with 124 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/app/shared/object-grid/search-result-grid-element/search-result-grid-element.component.ts
View File

@@ -21,12 +21,22 @@ export class SearchResultGridElementComponent<T extends SearchResult<K>, K exten
this.dso = this.object.dspaceObject;
}
/** Gets all matching metadata string values from hitHighlights or dso metadata, preferring hitHighlights. */
/**
* Gets all matching metadata string values from hitHighlights or dso metadata, preferring hitHighlights.
*
* @param {string|string[]} keyOrKeys The metadata key(s) in scope. Wildcards are supported; see [[Metadata]].
* @returns {string[]} the matching string values or an empty array.
*/
allMetadataValues(keyOrKeys: string | string[]): string[] {
return Metadata.allValues([this.object.hitHighlights, this.dso.metadata], keyOrKeys);
}
/** Gets the first matching metadata string value from hitHighlights or dso metadata, preferring hitHighlights. */
/**
* Gets the first matching metadata string value from hitHighlights or dso metadata, preferring hitHighlights.
*
* @param {string|string[]} keyOrKeys The metadata key(s) in scope. Wildcards are supported; see [[Metadata]].
* @returns {string} the first matching string value, or `undefined`.
*/
firstMetadataValue(keyOrKeys: string | string[]): string {
return Metadata.firstValue([this.object.hitHighlights, this.dso.metadata], keyOrKeys);
}