Class PouchdbStore

constructor

• new PouchdbStore(options?: PouchdbStoreOptions): PouchdbStore

  Parameters

  • options: PouchdbStoreOptions = {}

  Returns PouchdbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): PouchClientLike

  Returns the underlying pouchdb database for anything not wrapped here.

  Returns PouchClientLike

put

• put(key: string, value: Record<string, unknown>): Promise<PouchWriteResult>

  Writes a document keyed by _id = key (PouchDB put), merging key in as its _id.

  Parameters

  • key: string
  • value: Record<string, unknown>

  Returns Promise<PouchWriteResult>

insert

• insert(doc: PouchDoc): Promise<PouchWriteResult>

  Native insert: stores a document as-is (must carry its own _id).

  Parameters

  • doc: PouchDoc

  Returns Promise<PouchWriteResult>

get

• get(key: string): Promise<PouchDoc>

  Reads a document by _id (PouchDB get).

  Parameters

  • key: string

  Returns Promise<PouchDoc>

del

• del(key: string): Promise<PouchWriteResult>

  Deletes a document by _id. PouchDB needs the current _rev to delete, so this first gets the document, then removes it.

  Parameters

  • key: string

  Returns Promise<PouchWriteResult>

batch

• batch(ops: PouchBatchOp[]): Promise<void>

  Applies a list of put/del operations. Puts go through bulkDocs; deletes are resolved individually.

  Parameters

  • ops: PouchBatchOp[]

  Returns Promise<void>

list

• list(prefix?: string): Promise<string[]>

  Lists document ids via allDocs. With prefix, restricts to ids >= prefix and <= prefix + '￿' (PouchDB's startkey/endkey range).

  Parameters

  • Optionalprefix: string

  Returns Promise<string[]>