definitelytyped.github.io icon indicating copy to clipboard operation
definitelytyped.github.io copied to clipboard

Create a "getting started" section explaining how to use the typings in a typescript project.

Open Diullei opened this issue 10 years ago • 4 comments

Create a "getting started" section explaining how to use the typings in a typescript project. Ref: https://github.com/borisyankov/DefinitelyTyped/issues/4631

Diullei avatar Jun 15 '15 16:06 Diullei

I think this is tightly bound to #15 as usage of definition files depends on the IDE you are using. I'm happy to look into this and at least provide some docs for the tools I'm using (IDE free/CLI, WebStorm/PHPStorm, Atom, maybe Sublime) as soon I got time.

sebastian-lenz avatar Jun 16 '15 06:06 sebastian-lenz

@sebastian-lenz 😃

Diullei avatar Jun 17 '15 17:06 Diullei

Yeah, the one-line 'usage' instructions are extremely frustrating. A more complete example would be very helpful.

jessebarnum avatar Oct 19 '15 22:10 jessebarnum

It would be great to know how to set up tsconfig.json. Is

{
  "compilerOptions": {
    "typeRoots": ["./types", "./node_modules/@types"]
  }
}

the minimum viable usage of DefinitelyTyped? What do you do if a package includes its own type definitions (like aws-sdk)?

jamesarosen avatar Sep 11 '19 01:09 jamesarosen