krakenjs / post-robot

Cross domain post-messaging on the client side using a simple listener/client pattern.
Apache License 2.0
741 stars 92 forks source link

Create TypeScript typings #89

Closed mstuart closed 3 years ago

mstuart commented 3 years ago

See https://github.com/krakenjs/post-robot/issues/31 for more information.

This project isn't written in TypeScript, but many TypeScript users would like to use published typings. For this issue, create TypeScript typings that cover the exported functions, and contribute it back to DefinitelyTyped!

This issue is great for someone who wants to learn more about TypeScript!

JohnnyUrosevic commented 3 years ago

Hi I would to work on this to learn a little bit about TypeScript :)

mstuart commented 3 years ago

Hi @JohnnyUrosevic! Still want to take this? Just checking in, so that we can give others a chance if you're busy. Thanks!

JohnnyUrosevic commented 3 years ago

Hi I still want to work on this, but I'm just a Typescript noob so I'm not exactly sure where to start

Cijin commented 3 years ago

Hi, if this issue is still open. I'd like to take this up.

JohnnyUrosevic commented 3 years ago

go ahead and take it @Cijin

Cijin commented 3 years ago

Thanks, on it :+1:

songz commented 3 years ago

Starting point, from #31 that someone did: https://gist.github.com/NinoScript/6478d60282816393ca75c99937a9f6e5

mstuart commented 3 years ago

Happy hacking @Cijin !

Cijin commented 3 years ago

@mstuart PR created at definitely typed. The owners of the package will be notified automatically by the typescript bot. Thank you @NinoScript for your docs, I have tagged you as an author too.

Here is the link to the PR

Cijin commented 3 years ago

Hey, the PR got merged :smiley: . The npm package is available here: @types/post-robot

mstuart commented 3 years ago

Sweet!! Thanks @Cijin!

songz commented 3 years ago

@mstuart should this issue be closed? Seems like all the functions that postrobot exposes are closed.

mstuart commented 3 years ago

I think so! Thanks for keeping an eye on that @songz!