Add comments to exported types

GoogleContainerTools · Aug 19, 2020 · ff17d67 · ff17d67
1 parent 91aafe7
commit ff17d67
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/ts/kpt-functions/src/types.ts b/ts/kpt-functions/src/types.ts
@@ -403,12 +403,15 @@ export interface Result {
  */
 export type Severity = 'error' | 'warn' | 'info';
 
+/** A plain old JSON array according to ECMA-404. */
 export interface JsonArray extends Array<Json> {}
 
+/** A plain old JSON object/map according to ECMA-404. */
 export interface JsonMap {
   [field: string]: Json;
 }
 
+/** Any plain old JSON value according to ECMA-404. */
 export type Json = null | boolean | number | string | JsonArray | JsonMap;
 
 /**