chore: add jsdocs

salesforcecli · Jun 30, 2021 · 17899de · 17899de
1 parent 227114b
commit 17899de
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/util.ts b/src/util.ts
@@ -8,6 +8,15 @@
 import { Separator, ChoiceOptions, ChoiceBase } from 'inquirer';
 import { Dictionary, Nullable, ensureString } from '@salesforce/ts-types';
 
+/**
+ * Generate a formatted table for list and checkbox prompts
+ *
+ * Each option should contain the same keys as specified in columns.
+ * For example,
+ * const columns = { name: 'Name', type: 'Type', path: 'Path' };
+ * const options = [{ name: 'foo', type: 'org', path: '/path/to/foo/' }];
+ * generateTableChoices(columns, options);
+ */
 export function generateTableChoices<T>(
   columns: Dictionary<string>,
   choices: Array<Dictionary<Nullable<string> | T>>,