tree: 936936281ef55d6413c8f57e3bc67c64827d0bb3 [path history] [tgz]
  1. Makefile.am
  2. README.md
  3. cli.js
  4. console.js
  5. couchdb.js
  6. couchjs.js
  7. inspector.js
  8. package.json
  9. sandbox.js
  10. stream.js
  11. test/
  12. xml.js
src/couchjs-node/README.md

CouchJS

Drop-in replacement JavaScript engine for Apache CouchDB

CouchJS is a command-line Node.js program. It is 100% compatible with Apache CouchDB's built-in JavaScript system.

By using CouchJS, you will get 100% CouchDB compatibility (the test suite completely passes) but your JavaScript environment is V8, or Node.js.

See share/doc/src/experimental.rst for installation instructions.

Idea

JavaScript is decoupled from the CouchDB core. To do JavaScript stuff, CouchDB runs a normal Unix subprocess, couchjs. This subprocess is just a read-eval-print loop on standard i/o. CouchDB passes couchjs a file name, and that file contains the view server implementation.

This tool duplicates the “REPL” look and feel of couchjs and supports the exact same view server implementation.

Security

I have no idea. I would not trust it for production use.

Log

If you create a file, /tmp/couchjs.log then couchjs will output debugging messages there.

License

Apache 2.0

See the Apache 2.0 license.