arangodb / arangojs

The official ArangoDB JavaScript driver.
https://arangodb.github.io/arangojs
Apache License 2.0
601 stars 107 forks source link

docs: built in functions usage example #761

Closed vitoladev closed 2 years ago

vitoladev commented 2 years ago

It would be great to have a usage example for the built in functions of the driver inside the README.md such as collection.document(), collection.documents(), collection.save(), collection.exists() etc.

I can send a PR with this usage example to help people that use this library.

pluma commented 2 years ago

I'm not sure what you mean. Are you aware of the API documentation? https://arangodb.github.io/arangojs/7.7.0/interfaces/collection.documentcollection.html#document

Depending on your editor/IDE you should also see in-line documentation when using those methods.

vitoladev commented 2 years ago

yes, that's exactly what i was looking for, usually i could only see the API documentation inside the methods on VS Code, i didn't found it on my own searching on the website.

It would be good to mention about this API documentation with emphasis on driver's built in functions inside README.md, would be helpful for other people in the same situation.

Thanks!