API Docs

Class: PouchDB

PD. PouchDB

A class that wraps PouchDB to create a simple document store.

new PouchDB( [dbName])

Create a new simple JSON document store using PouchDB.

Parameters:
Name Type Argument Description
dbName string <optional>

The name of the database store to create/open, defaults to 'DocumentStore'.
Author:
  • drajmarsh

Members

:object

currentDoc

Stores information about the current document.

Type
  • object
:string

dbName

The name of the database store.

Type
  • string
:string

dbServer

The URL of the remote CouchDB server, if any.

Type
  • string

dbSize

The maximum size of the database in MB.

:boolean

isPouchDB <readonly>

A flag indicating that this object is a custom PouchDB wrapper instance.

Type
  • boolean
:PouchDB|null

localDB

The local PouchDB database connection.

Type
  • PouchDB | null
:string

password

The password for authentication.

Type
  • string
:PouchDB|null

remoteDB

The remote PouchDB database connection.

Type
  • PouchDB | null
:string

username

The username for authentication.

Type
  • string

Methods

delete(id) <async>

Deletes a document from the database.

Parameters:
Name Type Description
id string

The database key associated with the document to remove.
Returns:

Returns true if the document was successfully deleted, otherwise false.

Type
boolean

dispose() <async>

Disposes of the database and frees resources.

Returns:

Returns true if the database was successfully destroyed.

Type
boolean

get(id) <async>

Retrieve a document from the database.

Parameters:
Name Type Description
id string

The database key associated with a document.
Returns:

Returns the document if found, otherwise null.

Type
object | null

keys() <async>

Retrieves a list of keys for documents in the database.

Returns:

Returns an array of document keys.

Type
Array.<string>

open() <async>

Open the database and create the object store if it doesn't exist.

Returns:

Returns true if the database was opened successfully, otherwise false.

Type
boolean

rename(oldId, newId) <async>

Renames a document in the database.

Parameters:
Name Type Description
oldId string

The current ID of the document.
newId string

The new ID to assign to the document.
Returns:

Returns true if the document was successfully renamed.

Type
boolean

save(data) <async>

Saves the last loaded document to the database.

Parameters:
Name Type Description
data object

The document to store in the database.
Returns:

Returns true if the document was successfully saved.

Type
boolean

saveAs(id, json) <async>

Saves a document to the database with a different name.

Parameters:
Name Type Description
id string

The new database key to associate with the document.
json object

The JSON object to store in the database.
Returns:

Returns true if the document was successfully saved.

Type
boolean

set(id, data) <async>

Saves a document to the database with the given name.

Parameters:
Name Type Description
id string

The new database key to associate with the document.
data object

The JSON object or string to store in the database.
Returns:

Returns true if the document was successfully saved, otherwise false.

Type
boolean

isSupported() <static>

Checks if the browser/client supports PouchDB.

Returns:

Returns true if PouchDB is supported, otherwise false.

Type
boolean