beginner-corp / begin-data

A durable and fast key/value store for Begin built on top of DynamoDB
79 stars 8 forks source link

Add index.d.ts #85

Closed LumaKernel closed 3 years ago

LumaKernel commented 3 years ago

Adding typing.d.ts for TypeScript users ( and also including JS users ). It enables to use @begin/data in TypeScript way!

Most of doc comments are cited from https://docs.begin.com/en/data/begin-data

Some detailed of my decisions.

Thank you!

ryanblock commented 3 years ago

We do not intend to formally support TypeScript, I think this would be a great contribution for https://github.com/DefinitelyTyped/DefinitelyTyped, wdyt?

LumaKernel commented 3 years ago

Okay, thanks! I will do that.

ryanblock commented 3 years ago

Right on! If you'd like to add myself and @brianleroux as co-maintainers, happy to provide backup/feedback where we can!

LumaKernel commented 3 years ago

I made the PR for DefinitelyTyped and applied necessary fixes. https://github.com/DefinitelyTyped/DefinitelyTyped/pull/54596 @ryanblock @brianleroux Thank you for running. I appreciate reviewing since it may take longer to wait reviewed by DefinitelyTyped owners. If you have time to review, would you visit above link? If you've reviewed, I'll add to owners!

LumaKernel commented 3 years ago

Ah, it looks I need to add as owners beforehand...? Can I add you two ( @ryanblock @brianleroux ) as maintainers?

LumaKernel commented 3 years ago

It's been merged and released as @types/begin__data ❤️

ryanblock commented 3 years ago

Yes, please add us as maintainers! Thanks for creating this, this is great!