search

clarkie / dynogels

DynamoDB data mapper for node.js. Originally forked from https://github.com/ryanfitz/vogels
Other
490 stars 110 forks source link

Feature: Add Typescript Definition File #119

Open naerbnic opened 6 years ago

naerbnic commented 6 years ago

Currently dynogels doesn't have either a DefinitelyTyped module, nor an index.d.ts file defined for it, making it hard to use from within Typescript. We should add one to this module to support Typescript at least to a degree.

clarkie commented 6 years ago

@naerbnic I've never used Typescript, can you submit a PR? Thanks

naerbnic commented 6 years ago

I will in the next day or two, although I may need help from you to validate that it's the intended interface. I'm happy to answer questions about the syntax if you'd like.

naerbnic commented 6 years ago

Is dynogels intended to support both the browser and node contexts, or only the node context? I'd like to use a binary datatype, but the type differs on the platform.

clarkie commented 6 years ago

I'd say node context only.

I've only ever seen a use for it in node. Surely the AWS credentials would be compromised if you put them in the browser?

MaximusHaximus commented 6 years ago

Would love to see this happen :)

moraneva commented 6 years ago

If you haven't seen it, I created typings for dynogels a while ago https://www.npmjs.com/package/@types/dynogels

naerbnic commented 6 years ago

Thank you very much, Evan. I had a PR out, but I'd be happy to replace it with your typing file. Does that work for you?

On Wed, Dec 20, 2017 at 8:35 AM Evan Moran notifications@github.com wrote:

If you haven't seen it, I created typings for dynogels a while ago https://www.npmjs.com/package/@types/dynogels

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/clarkie/dynogels/issues/119#issuecomment-353113569, or mute the thread https://github.com/notifications/unsubscribe-auth/AApwurt0enndS2b9qb8dfrHxUhDxe7Arks5tCTdYgaJpZM4QcQDN .

moraneva commented 6 years ago

Sure, if you'd like to do that! I'd definitely give it a look over again though just to make sure everything is good. It's definitely preferable to have a definition file in the main project repo so I'm glad you are working on that