Add @template description

codex-team · Feb 20, 2021 · 85d1dac · 85d1dac
1 parent 02f943a
commit 85d1dac
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/types/data-formats/output-data.d.ts b/types/data-formats/output-data.d.ts
@@ -2,16 +2,19 @@ import {BlockToolData} from '../tools';
 
 /**
  * Output of one Tool
+ *
+ * @template Type - the string literal describing a tool type
+ * @template Data - the structure describing a data object supported by the tool
  */
-export interface OutputBlockData<S extends string = string, T extends object = any> {
+export interface OutputBlockData<Type extends string = string, Data extends object = any> {
   /**
    * Tool type
    */
-  type: S;
+  type: Type;
   /**
    * Saved Block data
    */
-  data: BlockToolData<T>;
+  data: BlockToolData<Data>;
 }
 
 export interface OutputData {