Feature request --- Add Typescript Typings

[superheri]

Using TypeScript with shepherd.js I have the problem that the package does not have types. Would be nice that types would be added. It can be here on in DefinitelyTyped, as long as there are typings.

Thank you in advance.

[RobbieTheWagner]

Hi @superheri I have not used much Typescript myself, but I would definitely be open to supporting this. Does the code here need to be in TS or can we just provide types? I'm not quite sure how it works.

[superheri]

Something that could be done without rewriting everything in TypeScript, would be to add the TypeScript definition file as a .d.ts file in the src folder and add it to the package.json in a "types":"./src/filename.d.ts" where filename is the actual filename of the definition file.

For more infos about adding the .d.ts file into a npm package :
https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

For docs about how .d.ts file are made :
https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html

If you need more infos or help for creating the types, I'll be happy to help.

[RobbieTheWagner]

@superheri if you have the time to submit a PR for this, that would be awesome!

[superheri]

The only problem with this is that I don't know the full package. So there might be things missing. I can try to do a PR, but it might take me some time.

[RobbieTheWagner]

@superheri the params are pretty well documented in comments, perhaps you could start with doing this just for Step using this as guidance? https://github.com/shipshapecode/shepherd/blob/master/src/js/step.js#L32-L89

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[superheri]

Closing this since the Pull Request has been merged.