Skip to content

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

Open
@Diullei

Description

@Diullei
Member

Create a "getting started" section explaining how to use the typings in a typescript project. Ref: DefinitelyTyped/DefinitelyTyped#4631

Activity

sebastian-lenz

sebastian-lenz commented on Jun 16, 2015

@sebastian-lenz
Member

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.

Diullei

Diullei commented on Jun 17, 2015

@Diullei
MemberAuthor
jessebarnum

jessebarnum commented on Oct 19, 2015

@jessebarnum

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

jamesarosen

jamesarosen commented on Sep 11, 2019

@jamesarosen

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)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @jamesarosen@Diullei@sebastian-lenz@jessebarnum

      Issue actions

        Create a "getting started" section explaining how to use the typings in a typescript project. · Issue #43 · DefinitelyTyped/definitelytyped.github.io