Class: Connection

Members

passwdString

Ths password to use for connecting to the CouchDB host

req_defaultsObject

Default request configuration. We set the accept header and configure
request to encode/decode json for us.

requestObject

An Object fulfilling the request API

See:

• request

urlString

The url to the CouchDB instance

useCookieboolean

Indicates whether to use Cookie authentication

userString

The username to use for connecting to the couchdb host

Methods

delete(path, parms){Promise}

connection.js, line 298

Convenience method to send a DELETE request to a CouchDB host.

Name	Type	Description
path	String	the path to the desired object below the host-URL
parms	Object	Object containing key/vale pairs of parametrers to be appended to the URL. Must be JSON encodable.

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.

get(path, parms){Promise}

connection.js, line 249

Convenience method to send a GET request to a CouchDB host.

Name	Type	Description
path	String	the path to the desired object below the host-URL
parms	Object	Object containing key/vale pairs of parametrers to be appended to the URL must be JSON encodable

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.

head(path, parms){Promise}

connection.js, line 313

Convenience method to send a HEAD request to a CouchDB host.

Name	Type	Description
path	String	the path to the desired object below the host-URL
parms	Object	Object containing key/vale pairs of parametrers to be appended to the URL. Must be JSON encodable.

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.

http_request(method, path, opts){Promise}

connection.js, line 134

The bare-metal HTTP request handling function returning a promise.

WARNING: it is recommended to use make_request as it can handle
automatic cookie-based login/relogin.

Name	Type	Description
method	String	The HTTP verb to be used in the request
path	String	The relative path for the request
opts	Object	An Object containing optional parameters for the request: Name Type Description headers Object Object containing key/value pairs of custom HTTP Headers parms Object Object containing key/value pairs of parameters to be appended to the URL must be JSON encodable body Object Object or Array to be JSON encoded and put into the request body

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.

login_and_retry(){Promise}

connection.js, line 193

Do a cookie-based login to the CouchDB and then retry a given request.

Returns:

a promise that either resolves successful to the
result of the specified request or is rejected because
of the failed authentication.

make_request(method, path, opts){Promise}

connection.js, line 226

The central workhorse for HTTP requests. Does automatic login and relogin
in casse 'useCookie' is set on the connection and credentials have been
supplied.

Name	Type	Description
method	String	The HTTP verb to be used in the request
path	String	The relative path for the request
opts	Object	An Object containing optional parameters for the request: Name Type Description headers Object Object containing key/value pairs of custom HTTP Headers parms Object Object containing key/value pairs of parameters to be appended to the URL must be JSON encodable body Object Object or Array to be JSON encoded and put into the request body

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.

openDB(dbname, options){Promise}

connection.js, line 332

Convenience method to open a database on a CouchDB host.

Name	Type	Description
dbname	String	the name of the database to be opened on the database host.
options	Object	options for creating the database. Name Type Description create bool indicates whether the database should be created by the host if it is not yet existing.

Returns:

Promise object. If the promise resolves a
Database is returned. In case the database does not exist and
cannot be created either, a CouchError is thrown.

post(path, body, parms){Promise}

connection.js, line 266

Convenience method to send a POST request to a CouchDB host.

Name	Type	Description
path	String	the path to the desired object below the host-URL
body	Object	Object or Array to be JSON encoded and put into the request body
parms	Object	Object containing key/vale pairs of parametrers to be appended to the URL must be JSON encodable

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.

put(path, body, parms){Promise}

connection.js, line 283

Convenience method to send a PUT request to a CouchDB host.

Name	Type	Description
path	String	the path to the desired object below the host-URL
body	Object	Object or Array to be JSON encoded and put into the request body
parms	Object	Object containing key/vale pairs of parametrers to be appended to the URL must be JSON encodable

Returns:

Promise object. If the promise resolves a
CouchResult is returned, if it rejects a CouchError is
returned.