chore: typescript corrections

Thanks to Michael Fig.
Agoric · Jun 17, 2021 · 842a5f1 · 842a5f1
1 parent bf2dc9e
commit 842a5f1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/packages/governance/src/paramManager.js b/packages/governance/src/paramManager.js
@@ -106,8 +106,8 @@ const parse = paramDesc => {
     describers.push(describer);
   });
 
-  /** @type {() => Record<Keyword,ParamDescription>} */
   const getParams = () => {
+    /** @type {Record<Keyword,ParamDescription>} */
     const descriptions = {};
     describers.forEach(d => {
       const description = d();

diff --git a/packages/governance/src/types.js b/packages/governance/src/types.js
@@ -23,9 +23,11 @@
  */
 
 /**
- * @typedef  {Object} ParamManagerPublic
- * ParamManagerPublic also has updateFoo methods for each defined parameter.
+ * @typedef {Object} ParamManagerBase
  * @property {() => Record<Keyword,ParamDescription>} getParams
+ *
+ * @typedef {{ [updater: string]: (arg: any) => void }} ParamManagerUpdaters
+ * @typedef {ParamManagerBase & ParamManagerUpdaters} ParamManagerPublic
  */
 
 /**

diff --git a/packages/governance/test/test-param-manager.js b/packages/governance/test/test-param-manager.js
@@ -189,9 +189,9 @@ test('params unknown type', async t => {
   const stuffDescription = {
     name: stuffKey,
     value: 'It was the best of times, it was the worst of times',
-    // @ts-ignore  illegal value for testing
     type: 'quote',
   };
+  // @ts-ignore  illegal value for testing
   t.throws(() => buildParamManager([stuffDescription]), {
     message: 'unknown type guard "quote"',
   });