SakibulMowla / catch-up

4 stars 2 forks source link

Documented the methods in DBWrapper #55

Closed coderbdsust closed 2 years ago

coderbdsust commented 2 years ago
SakibulMowla commented 2 years ago

Official Getting Started with Node.js and DynamoDB is what I was referring to while writing the code. It's a good starting point. It doesn't contain documentation on how to make batch request and request/response syntax. Those documentation are available in API reference.

Maybe we can mention these 2 links at the top of DBWrapper or in README?

DBWrapper itself doesn't do much other than adding a thin layer of sending the request to dynamodb, receiving response and logging inside catch in case of any error.

coderbdsust commented 2 years ago

Making a good readme file would be good. I was looking some good documentation. Thanks for the link