How do I import when using Typescript?

[smeriwether]

Hi 👋,

I'm trying to import Scout into a Typescript project, but I'm running into an issue. I'm quite new to Typescript so I imagine it's a small mistake that I can't see.

Here's my code:

import * as Scout from "@scout_apm/scout-apm"

And here's the error:

./server/middlewares/scout.ts:3:24
Type error: Could not find a declaration file for module '@scout_apm/scout-apm'. '{hidden}/node_modules/@scout_apm/scout-apm/dist/lib/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/scout_apm__scout-apm` if it exists or add a new declaration (.d.ts) file containing `declare module '@scout_apm/scout-apm';`

Any help would be much appreciated. Thanks!

[smeriwether]

Here's a bit more information about my Typescript setup:

Version

4.1.2

Config

{
  "compilerOptions": {
    "allowJs": true,
    "allowSyntheticDefaultImports": true,
    "baseUrl": ".",
    "esModuleInterop": true,
    "jsx": "preserve",
    "lib": ["es2015", "es2016", "es2017", "dom"],
    "module": "esnext",
    "moduleResolution": "node",
    "noEmit": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "paths": {
      "callisto/*": ["./*"],
      "*": ["*"]
    },
    "preserveConstEnums": true,
    "removeComments": false,
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "sourceMap": true,
    "strict": true,
    "target": "esnext",
    "typeRoots": ["./node_modules/@types", "./typings"],
    "isolatedModules": true,
    "forceConsistentCasingInFileNames": false
  },
  "exclude": ["node_modules", "**/__mocks__/**/*.ts", "**/*.test.*"],
  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"]
}

Hey @smeriwether this project is a typescript project, so I think what might be happening is that you're limiting the typeRoots and inadvertently excluding the declarations in node_modules/@scout_apm/scout-apm.

Generally if you create a new typescript project and yarn add or npm install @scout_apm/scout-apm`, it should "just work"

[tallpants]

This doesn't work even with a new typescript project -- not sure why.

[kaorun343]

I found that 0.2.2 does not contain index.d.ts in root directory.

[forbesgillikin]

The declaration file lives in /dist/lib. Importing as follows works correctly

import scout from '@scout_apm/scout-apm/dist/lib'