Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Diullei opened this issue Jun 15, 2015 · 4 comments
Assignees

Comments

@Diullei
Copy link
Member

Diullei commented Jun 15, 2015

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

@sebastian-lenz
Copy link
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.

@sebastian-lenz sebastian-lenz self-assigned this Jun 16, 2015
@Diullei
Copy link
Member Author

Diullei commented Jun 17, 2015

@sebastian-lenz 😃

@jessebarnum
Copy link

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

@jamesarosen
Copy link

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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants