chore(types): work around microsoft/TypeScript#50286

Agoric · Nov 16, 2022 · a275899 · a275899
1 parent 07b0d08
commit a275899
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 18 deletions.
diff --git a/packages/ERTP/src/issuerKit.js b/packages/ERTP/src/issuerKit.js
@@ -91,7 +91,7 @@ harden(vivifyIssuerKit);
  * larger unit of computation, like the enclosing vat, can be shutdown
  * before anything else is corrupted by that corrupted state.
  * See https://github.com/Agoric/agoric-sdk/issues/3434
- * @param {Partial<{elementShape: Pattern}>} [options]
+ * @param {Partial<{elementShape: Pattern}>} options
  * @returns {IssuerKit<K>}
  */
 export const makeDurableIssuerKit = (
@@ -136,7 +136,7 @@ harden(makeDurableIssuerKit);
  * larger unit of computation, like the enclosing vat, can be shutdown
  * before anything else is corrupted by that corrupted state.
  * See https://github.com/Agoric/agoric-sdk/issues/3434
- * @param {Partial<{elementShape: Pattern}>} [options]
+ * @param {Partial<{elementShape: Pattern}>} options
  * @returns {IssuerKit<K>}
  */
 export const makeIssuerKit = (

diff --git a/packages/SwingSet/src/liveslots/collectionManager.js b/packages/SwingSet/src/liveslots/collectionManager.js
@@ -832,7 +832,7 @@ export function makeCollectionManager(
    *
    * @template K,V
    * @param {string} [label='map'] - diagnostic label for the store
-   * @param {StoreOptions=} options
+   * @param {StoreOptions} options
    * @returns {MapStore<K,V>}
    */
   function makeScalarBigMapStore(
@@ -874,7 +874,7 @@ export function makeCollectionManager(
    *
    * @template K,V
    * @param {string} [label='weakMap'] - diagnostic label for the store
-   * @param {StoreOptions=} options
+   * @param {StoreOptions} options
    * @returns {WeakMapStore<K,V>}
    */
   function makeScalarBigWeakMapStore(
@@ -901,7 +901,7 @@ export function makeCollectionManager(
    *
    * @template K
    * @param {string} [label='set'] - diagnostic label for the store
-   * @param {StoreOptions=} options
+   * @param {StoreOptions} options
    * @returns {SetStore<K>}
    */
   function makeScalarBigSetStore(
@@ -926,7 +926,7 @@ export function makeCollectionManager(
    *
    * @template K
    * @param {string} [label='weakSet'] - diagnostic label for the store
-   * @param {StoreOptions=} options
+   * @param {StoreOptions} options
    * @returns {WeakSetStore<K>}
    */
   function makeScalarBigWeakSetStore(

diff --git a/packages/store/src/patterns/encodePassable.js b/packages/store/src/patterns/encodePassable.js
@@ -296,7 +296,7 @@ const decodeTagged = (encoded, decodePassable) => {
  */
 
 /**
- * @param {EncodeOptions} [encodeOptions]
+ * @param {EncodeOptions} encodeOptions
  * @returns {(passable: Passable) => string}
  */
 // `yarn lint` complains here but not for equivalent code in agoric-sdk.
@@ -399,7 +399,7 @@ harden(makeEncodePassable);
  */
 
 /**
- * @param {DecodeOptions} [decodeOptions]
+ * @param {DecodeOptions} decodeOptions
  * @returns {(encoded: string) => Passable}
  */
 // `yarn lint` complains here but not for equivalent code in agoric-sdk.

diff --git a/packages/store/src/stores/scalarMapStore.js b/packages/store/src/stores/scalarMapStore.js
@@ -123,7 +123,7 @@ export const makeMapStoreMethods = (
  *
  * @template K,V
  * @param {string} [tag='key'] - the column name for the key
- * @param {StoreOptions=} options
+ * @param {StoreOptions} options
  * @returns {MapStore<K,V>}
  */
 export const makeScalarMapStore = (

diff --git a/packages/store/src/stores/scalarSetStore.js b/packages/store/src/stores/scalarSetStore.js
@@ -81,7 +81,7 @@ export const makeSetStoreMethods = (
  *
  * @template K
  * @param {string} [tag='key'] - tag for debugging
- * @param {StoreOptions=} options
+ * @param {StoreOptions} options
  * @returns {SetStore<K>}
  */
 export const makeScalarSetStore = (

diff --git a/packages/store/src/stores/scalarWeakMapStore.js b/packages/store/src/stores/scalarWeakMapStore.js
@@ -81,7 +81,7 @@ export const makeWeakMapStoreMethods = (
  *
  * @template K,V
  * @param {string} [tag='key'] - tag for debugging
- * @param {StoreOptions=} options
+ * @param {StoreOptions} options
  * @returns {WeakMapStore<K,V>}
  */
 export const makeScalarWeakMapStore = (

diff --git a/packages/store/src/stores/scalarWeakSetStore.js b/packages/store/src/stores/scalarWeakSetStore.js
@@ -63,7 +63,7 @@ export const makeWeakSetStoreMethods = (
  *
  * @template K
  * @param {string} [tag='key'] - tag for debugging
- * @param {StoreOptions=} options
+ * @param {StoreOptions} options
  * @returns {WeakSetStore<K>}
  */
 export const makeScalarWeakSetStore = (

diff --git a/packages/swing-store/src/snapStore.js b/packages/swing-store/src/snapStore.js
@@ -56,7 +56,7 @@ const sink = () => {};
  *   tmpName: typeof import('tmp').tmpName,
  *   unlink: typeof import('fs').promises.unlink,
  * }} io
- * @param {object} [options]
+ * @param {object} options
  * @param {boolean | undefined} [options.keepSnapshots]
  * @returns {SnapStore}
  */

diff --git a/packages/telemetry/src/slog-to-otel.js b/packages/telemetry/src/slog-to-otel.js
@@ -306,7 +306,7 @@ export const makeSlogToOtelKit = (tracer, overrideAttrs = {}) => {
 
       /**
        * @param {string | [string, ...any]} key
-       * @param {object} [options]
+       * @param {object} options
        * @param {string} [options.kind]
        * @param {string} [options.name]
        * @param {Record<string, any>} [options.attributes]
@@ -334,7 +334,7 @@ export const makeSlogToOtelKit = (tracer, overrideAttrs = {}) => {
 
       /**
        * @param {string | [string, ...any]} [assertKindOrKey]
-       * @param {object} [options]
+       * @param {object} options
        * @param {Record<string, any>} [options.attributes]
        * @param {string} [options.errorMessage]
        */

diff --git a/packages/vats/src/core/startWalletFactory.js b/packages/vats/src/core/startWalletFactory.js
@@ -113,7 +113,7 @@ const startGovernedInstance = async (
  *   options?: {
  *     perAccountInitialValue?: bigint
  *   },
- * }} [config]
+ * }} config
  */
 export const startWalletFactory = async (
   {

diff --git a/packages/vats/src/lib-board.js b/packages/vats/src/lib-board.js
@@ -31,7 +31,7 @@ const calcCrc = (data, crcDigits) => {
  * Create a board to post things on.
  *
  * @param {bigint | number} [initSequence]
- * @param {object} [options]
+ * @param {object} options
  * @param {string} [options.prefix]
  * @param {number} [options.crcDigits]
  */

diff --git a/packages/zoe/src/contractFacet/internal-types.js b/packages/zoe/src/contractFacet/internal-types.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {( {zcf: ZCF} ) => void} TestJigSetter
+ * @typedef {( jigs: {zcf: ZCF} ) => void} TestJigSetter
  */
 
 /**