fix: allow null for EnvDisplay

salesforcecli · Sep 16, 2021 · 0868d3f · 0868d3f
1 parent 60341dc
commit 0868d3f
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -33,13 +33,18 @@ export type JsonObject = {
  * Key Value
  * --- -------------------
  * Url https://example.com
+ *
+ * If no environment matches the provided targetEnv, then return null in the data field.
+ *
+ * @example
+ * { data: null }
  */
 export namespace EnvDisplay {
   type Keys<T> = Record<keyof T, string>;
 
   export type HookMeta<T extends JsonObject> = {
     options: { targetEnv: string };
-    return: { data: T; keys?: Keys<T> };
+    return: { data: T | null; keys?: Keys<T> };
   };
 }