Typescript Typings

[origin1tech]

Any chance of getting some @types/router typings published? Or are there any floating around that we can make official and publish.

[blakeembrey]

@types has no relation to this module, if you want someone in the community to type it you can ask at https://github.com/DefinitelyTyped/DefinitelyTyped which is where @types is published from. You can also contribute them yourself. I'll leave this issue open to add a TypeScript definition to the router itself, but it sounds like you're after something else that doesn't exist (yet).

[origin1tech]

actually no I'm talking about the type definitions. However it would be appropriate to publish once done to @types for ease of install with Typescript 2.x. Sorry if I wasn't clear, but yes we'd need the defs first obviously :)

[dougwilson]

@origin1tech I'm not sure if third parties even have the rights to publish under other user's namespaces, like the @types namespace. I think @blakeembrey has the right path forward, unless you can share some documentation on how we would be able to publish under that npm namespace?

I personally have never written typings before, so probably someone who knew how to write them would have to (I think @blakeembrey does).

[blakeembrey]

@origin1tech I do know what you're talking about. DefinitelyTyped is the location you should ask if you want something published to @types. The @types on NPM has zero relation to the module itself. I would hopefully know, I am a member of @DefinitelyTyped, wrote @types and @typings and helped TypeScript with the @types implementation 😄

[blakeembrey]

@dougwilson We can't, and we wouldn't want to. Once someone has written a definition, we can add it to the module ourselves and publish to NPM directly (using typings in package.json like https://github.com/pillarjs/path-to-regexp/blob/master/package.json#L6). This makes it easier for TypeScript users as they can forgo the installation from @types altogether and it just works.

[origin1tech]

@blakeembrey I'm fully aware of that....my point is simply that it would be nice to get defs for router and then publish an @types project for ease of install. I get that they are unrelated, however if the author creates the definitions it's helpful as there's less chance of things getting missed.

[blakeembrey]

@origin1tech You're missing the point. Please re-read my comments. If the goal is "ease of install" we would add them to this module, and not @types. That way, as a TypeScript user, you don't have to do anything to have it work - which is ease of install to me, compared to having to install an additional module. That's why I suggested keeping it open for that, and to ignore @types.

[origin1tech]

Maybe I'm missing something but Typescript is suggesting @types as the path for installing defs. I talk to some of those fellas on the regular pretty certain on that.

see https://blogs.msdn.microsoft.com/typescript/2016/06/15/the-future-of-declaration-files/

[dougwilson]

@origin1tech that article has the following line:

Specifically, Blake Embrey, the maintainer and creator of Typings, has worked closely with us during this entire process and given us valuable feedback

And you are talking to Blake in this very thread :)

[blakeembrey]

@origin1tech You're incorrect. That approach is relevant only for third-party typings (E.g. those from Typings/DefinitelyTyped). Modules themselves can publish their own type definitions, and that has been the preferred approach for first-party typings since TypeScript 1.5. Since you opened the issue on the module itself, I would assume the best approach is the easiest for you as a user.

[origin1tech]

@blakeembrey how does that work if you exclude "node_modules" in your tsconfig.json. How does it get imported unless you specify it in "typeRoots" manually?

[blakeembrey]

@origin1tech You can read up on how exclude works in the TypeScript handbook, but it won't break that. exclude is there to ignore "entry-points" of the project. If something requires into node_modules or elsewhere, it'll still load those type definitions as required for type checking. It wouldn't be a very effective process if that didn't work 😄 If you want to test it out, give it a go on the module I linked above.

echo "import pathToRegexp = require('path-to-regexp')" > index.ts
npm install path-to-regexp
tsc index.ts

The process of looking up native typings is related to moduleResolution in TypeScript, so it needs to be using moduleResolution: node.

[blakeembrey]

Here's a response by Daniel on the same article you posted.

[blakeembrey]

If you've used Typings before, @types is basically doing the same resolution, filling that gap in tooling - just all natively within the NPM and TypeScript ecosystems now instead of having separate tools for it. You can also see in Typings that it has been the advice for authors since release (https://github.com/typings/registry#contributing).

[origin1tech]

@blakeembrey seen that before but was under the impression any external module, best practice would be @types.

testing it on some of own projects really quick...