Typescript d.ts

Question

Typescript d.ts

lommez opened this issue 8 years ago · 12 comments

Hi Nathanael,

Do you have plans for creating the type definitions for the library?

Answer 1 · 2017-05-30T04:06:34.000Z

Hi @lommez - any reason you want the definitions? Just curious 😄 if it's for intellisense your IDE should have localStorage available from the browser spec and since the API is the exact same (last I checked) it should work. If there's another reason you want the typings, let me know and I can throw something together to improve this piece. I love good type definitions 👍 just want to make sure we are on the same page for needing it here. I'm using VSCode and when coding on a .ts file it picks up the Storage object and provides the intellisense when keying localStorage or sessionStorage

Answer 2 · 2017-05-30T05:16:05.000Z

Makes sense. I'll try to throw something together soon for this.

…

On Tue, May 30, 2017 at 12:11 AM, Glenn Greibesland < ***@***.***> wrote: Take a look here: https://youtu.be/unICbsPGFIA Type definitions is one of the things that is required in libraries if you want to support AoT and Tree Shaking. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#8 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFulhC361MOBIO8SFy8F4RAXuao7vRH1ks5r-6T2gaJpZM4NdwIl> .

Answer 3 · 2017-06-05T22:20:48.000Z

Hi Brad,
Sorry for the delay.
That´s my case, the AoT and tree shaking features.

Answer 4 · 2017-06-15T03:40:37.000Z

Gonna take a run at this soon @lommez

Answer 5 · 2017-06-15T04:08:14.000Z

This will likely require a few test runs from you @lommez to make sure it works 😄 hope you are able to help out. I have a def file ready and it works but I'm not 100% certain it's perfect for this case. Since this module contains both sessionStorage and localStorage it might need to be expanded a bit. I'll submit the d.ts in a PR in a few and you can try it in your project and see if it is sufficient for AoT or not.

Answer 6 · 2017-06-15T04:14:43.000Z

PR#11 has the d.ts file @lommez if you want to try it out and see if it's sufficient to get AoT working

Answer 7 · 2017-06-15T04:18:39.000Z

@lommez - I'm thinking right now that if this doesn't work we need to add the methods to a global augmentation definition and namespace both localStorage and sessionStorage and have all the methods duped for both. That might be the trick for AoT here and the better approach actually going forward 👍 so keep me posted on your progress here please.

Answer 8 · 2017-06-30T12:11:00.000Z

hi @bradmartin !
Thanks so much and I'm sorry for the long delay to answer you.
I will take look at this file and give you a feedback as soon as possible.

Answer 9 · 2017-07-07T12:02:39.000Z

@bradmartin,
I tried to use your file but didn't work. Don't you have to extend an interface or something like that?

Answer 10 · 2017-07-07T13:01:16.000Z

I'm not entirely sure what is really needed for the aot bits. Written many definitions for plugins and I know some work with aot, or so I'm told :) so I thought that would be it. With this plugin exposing the names session and localStorage it might take a little more work to get it working.

Answer 11 · 2019-04-29T06:32:08.000Z

Any news on this?

Answer 12 · 2019-04-29T16:06:39.000Z

@IngoBleile -- Brad created some typings #11 - but no one has confirmed they work -- so I haven't accepted the PR. I'm pretty sure they work as Brad is the man! But I personally would hate to accept a PR that I don't know for sure works. And since this is open source work, this is extremely low on my todo list to actually spin up another test app in TS to test the typings vs pretty much any other work ...
So if you want to contribute; grab the typings test them out and then let me know if they work. 😀