Add TypeScript typings

[dudeofawesome]

No description provided.

[sindresorhus]

In TS 3.1, we can now declare props on functions, so I don't think we need a namespace for this, see: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-1.html

[dudeofawesome]

I'm trying to get this style of definition to work, but I'm not sure how to translate their example (which is for a regular .ts file) to work with a definition file with an ambient context, where you can't make assignments.

[sindresorhus]

Hmm, I think you're right. Actually, we can just export the sync method as a named export.

[dudeofawesome]

Are you talking about like so?

export default function (options?: Options): Promise<PackageMetadata>;
export function sync (options?: Options): PackageMetadata;

I believe that would require a change to the JS if that's the plan.

[sindresorhus]

Yup, exactly like that.

[dudeofawesome]

Alright, I think this is done too.

[sindresorhus]

Very nice work. Thanks for taking the time to make it great. 🙌

[sindresorhus]

For packages with a default export, use export default foo;, not export = foo;. You will have to add module.exports.default = foo; to the index.js file. - https://github.com/sindresorhus/typescript-definition-style-guide

[sindresorhus]

You still need to do #8 (comment)

[sindresorhus]

@dudeofawesome Ping :)

[sindresorhus]

@dudeofawesome Still interested in finishing this? :)