workstreams-ai / slack-block-kit

Slack Block Kit - Javascript
29 stars 6 forks source link

Add Typescript type definitions #5

Open regniblod opened 4 years ago

regniblod commented 4 years ago

Hey!

I'd like to thank you for taking the time to create this project. I'm using it in production in a couple of projects and I love using it.

But I'd like to suggest having type definitions for the library, I'd make development way easier for anyone (including me!) using Typescript. Right now I have to always go to the source code (and npm only installs the compiled one in node_modules) to check the arguments of any functions.

Is there a way to convert the current documentation of the functions into Typescript type definitions? I'd love to help with that.

Cheers!

czechspekk commented 4 years ago

Hi @regniblod feel free to come up with a PR - we'd be happy to have you as a contributor!

So far we kept this library as simple as possible, but Typescript type definitions are a good idea. There even might be something out there in official Slack Typescript types which could help as a base.

Cheers

R