josephg / node-foundationdb

Modern Node.js FoundationDB bindings
Other
116 stars 17 forks source link

Port documentation into typescript doc comments #26

Open josephg opened 5 years ago

josephg commented 5 years ago

There's lots of transaction & database methods which are missing documentation comments.

We should do a pass adding typescript tsdoc - compatible doc comments for all the normal function in (at a minimum) lib/transaction.ts and lib/database.ts.

This documentation is picked up by documentation tools and by editors (like vs code), which makes it very handy while using the API.