[Request/Question] TypeScript definitions

[Gounlaf]

Hi,

Could you provide typescript definitions for your package?
Unfortunately I didn't found community definitions (on DefinitelyTyped/DefinitelyTyped), and I'm not enough skilled to create one (I can try but it would take time :x).

Thanks,

Regards.

[Raynos]

I might add tsdocstandard to this repo.

Please remind me in a few days :D

[Raynos]

I've started this in a PR #24

[Raynos]

I merged the PR that adds type definitions and released [email protected]

[Gounlaf]

Thanks !

[Gounlaf]

Hi @Raynos,

I've installed version 10.3.0 but my IDE (WebStorm) is still complaining about not finding definitions (TS7016).
As a "provider" I understand you provide Types via tsdocstandard
As a "consumer" does I need to add something? (it might be not supported by WebStorm =/)

Thanks,

Regards.

[Raynos]

@Gounlaf

Can you share the tsconfig.json for your project ?

[Raynos]

Types are provided by typescript btw.

Tsdocstandard is just a linter that makes it easier to add jsdoc to a js library and write type definitions.

[Gounlaf]

@Raynos sure, see below.

I use typescript 3.8.3 and also a minimal configuration of typescript-eslint

{
  "compilerOptions": {
    "target": "ES2019",
    "module": "commonjs",
    "sourceMap": true,
    "outDir": "./build",
    "strict": true,
    "noImplicitAny": true,
    "alwaysStrict": true,
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "baseUrl": "./src",
    "paths": {
      "@i/*": ["i/*"],
      "@have/*": ["have/*"],
      "@some/*": ["some/*"],
      "@modules/*": ["modules/*"],
      "@alias/*": ["alias/*"]
    },
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ]
}

[Raynos]

It's quite frustrating that typescript does not type check the implementation of error.

I tried your tsconfig and added

  "include": [
    "src/**/*",
    "node_modules/error"
  ],

Basically telling typescript that node_modules/error exists and it started type checking properly.

However now i have build/node_modules/error ...

[Raynos]

microsoft/TypeScript#33136

[Raynos]

There's another important property in tsconfig.json

  "allowJs": true,

[Raynos]

Looks like another user found a similar workaround ( microsoft/TypeScript#33136 (comment) )

[Gounlaf]

Hi,

Sorry for the delay.
Thanks for your answers; I still have not test yet, I will confirm here if it's OK with solution you gave me.