This is the API documentation for the node-neo4j library. Follow that link for general info, installation instructions, and more.
This API documentation is fairly self-explanatory, but here are some notes:
-
When you
require('neo4j'), all you get back is a reference to theGraphDatabaseclass, so start there. -
The
_parameter in all method signatures signifies an async callback. All async callbacks are of the standard Node form(err, result). -
All async methods that say they "return" something actually pass their results via that async callback. It's just simpler to document those values as standard "return" values.
-
But, all async methods actually do have true return values -- they all return Streamline futures. You don't need to worry about these at all if you don't want to.
If anything else needs explanation, please file an issue.
This API documentation is generated via the excellent Codo library. A big thanks to @netzpirat for the great work and support!