What's the best practice to develop the /api in typescript?

Questions and Answers
2

That article looks quite involved with a lot of moving parts, which puts me off a bit. To my knowledge it is the most complete example TS integration with Strapi.

For me, using the checkJs option of TypeScript has been good enough. I have this tsconfig.json at my project root:

{
  "compilerOptions": {
    "noEmit": true,
    "checkJs": true,
    "allowJs": true
  },
  "exclude": [
    "node_modules"
  ],
  "include": [
    "**/*"
  ]
}

VSCode shows type warnings, and I can run tsc in my CI pipeline.

I can use types like this in regular JS files:

/**
 * @param {number} tagId
 * @param {number[]} fileIds
 */
async setTagFiles(tagId, fileIds) {

  /** @type {Partial<TagModel>} */
  const tagUpdate = {
    files: fileIds,
    fileCount: fileIds.length,
  };

  await strapi.api.tag.services.tag.update({ id: tagId }, tagUpdate);
},

I maintain a file of types I care about in a .d.ts file. This package would be useful but I haven’t needed it so far.

The strapi api itself is not typed at all, which would be handy. It’s possible to create a package on DefinitelyTyped but it hasn’t been done yet.

1 Like