Code Examples

The Node.js Client API ships with code examples to supplement the examples
in the online resources. To run the examples, follow the instructions here:

examples/1readme.txt

Generating Documentation Locally

After installing the project dependencies (including the gulp
build system), you can build the reference documentation locally from the root
directory of the marklogic package:

gulp doc

The documentation is generated in a doc subdirectory. The documentation can also be
accessed online here.

Running Tests

To set up the database and REST server for tests, execute the following
command from the root directory for the marklogic package:

node etc/test-setup.js

After setup, you can run tests for the Node.js Client API with the following
command:

gulp test

To tear down the test database and REST server, execute the following:

node etc/test-teardown.js

Support

The MarkLogic Node.js Client API is maintained by MarkLogic Engineering.
It is designed for use in production applications with MarkLogic Server.
Everyone is encouraged to file bug reports, feature requests, and pull
requests through GitHub. This input is critical and will be carefully
considered, but we can’t promise a specific resolution or timeframe for
any request. In addition, MarkLogic provides technical support
for release tags
of the Node.js Client API to licensed customers under the terms outlined
in the Support Handbook.
For more information or to sign up for support,
visit help.marklogic.com.