paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

search-common: restrict allowed type parameters for Result and ResultSet

Browse Source 
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
This commit is contained in:
MT Lewis
2022-03-15 10:01:28 +00:00
parent aab3bac7fc
commit a6d402200d
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/search-common/api-report.md
+2 -2
View File
@@ -51,7 +51,7 @@ export type QueryRequestOptions = {
export type QueryTranslator = (query: SearchQuery) => unknown;
// @beta (undocumented)
export interface Result<TDocument> {
export interface Result<TDocument extends SearchDocument> {
// (undocumented)
document: TDocument;
// (undocumented)
@@ -59,7 +59,7 @@ export interface Result<TDocument> {
}
// @beta (undocumented)
export interface ResultSet<TDocument> {
export interface ResultSet<TDocument extends SearchDocument> {
// (undocumented)
nextPageCursor?: string;
// (undocumented)
plugins/search-common/src/types.ts
+2 -2
View File
@@ -31,7 +31,7 @@ export interface SearchQuery {
/**
* @beta
*/
export interface Result<TDocument> {
export interface Result<TDocument extends SearchDocument> {
type: string;
document: TDocument;
}
@@ -39,7 +39,7 @@ export interface Result<TDocument> {
/**
* @beta
*/
export interface ResultSet<TDocument> {
export interface ResultSet<TDocument extends SearchDocument> {
results: Result<TDocument>[];
nextPageCursor?: string;
previousPageCursor?: string;