js ファイルから JSDoc で d.ts の型を参照して型チェックする ( jest.config.js を例に)


概要

jsにd.tsの型をつけ、補完したり、間違った値を入れたら分かるようにする

方法

// @ts-check
/**
 * @type {import('@jest/types').Config.InitialOptions}
 */
const config = {
  ...
};

module.exports = config;

備考

  • VSCodeでしか確認していない
  • @typedef でもimportが使える
  • allowJsとcheckJsを有効にしたら // @ts-check 不要かもしれない

参考

https://www.reddit.com/r/javascript/comments/aezwdh/using_typescript_declaration_files_with_jsdoc/
https://gist.github.com/hrdtbs/f7e567c0738725a16a9de7326dc11127