core-api: make ApiRef description optional

Co-authored-by: Juan Lulkin <jmaiz@spotify.com> Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-03-10 11:09:27 +01:00
parent 4d68d4d87d
commit 0977b7b41b
2 changed files with 3 additions and 3 deletions
@@ -18,7 +18,7 @@ import type { ApiRef } from './types';

 export type ApiRefConfig = {
  id: string;
-  description: string;
+  description?: string;
 };

 class ApiRefImpl<T> implements ApiRef<T> {
@@ -38,7 +38,7 @@ class ApiRefImpl<T> implements ApiRef<T> {
    return this.config.id;
  }

-  get description(): string {
+  get description() {
    return this.config.description;
  }

@@ -16,7 +16,7 @@

 export type ApiRef<T> = {
  id: string;
-  description: string;
+  description?: string;
  T: T;
 };