SlothDatabase | slothdb

This represent a Database

Type parameters

S: object

the database schema
E: BaseEntity<S>

the Entity
V: string

the (optional) view type that defines a list of possible view IDs

Hierarchy

SlothDatabase

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SlothDatabase(model: EntityConstructor<S, E>, root?: string): SlothDatabase

- Defined in models/SlothDatabase.ts:47
Create a new database instance

Parameters
- model: EntityConstructor<S, E>
  
  the model constructor
- Default value root: string = ""
  
  the root name, which is the startKey. I don't recommend it
Returns SlothDatabase

Properties

Private _model

_model: EntityConstructor<S, E>

type: {T}
memberof: SlothDatabase

Private _name

_name: string

type: {string}
memberof: SlothDatabase

_root

_root: string

Private Optional _setupPromise

_setupPromise: Promise<any>

Private _subscribers

_subscribers: object[] = []

Methods

cancel

cancel(factory: PouchFactory<S>, sub: Subscriber<S>): void

- Defined in models/SlothDatabase.ts:343
Unsubscribe a subscriber, so it will not be called anymore Possibly cancel PouchDB changes

Parameters
- factory: PouchFactory<S>
  
  The pouchDB factory to unsubscribe from
- sub: Subscriber<S>
  
  the subscriber to unsubscribe
Returns void

create

create(factory: PouchFactory<S>, props: Partial<S>): E

- Defined in models/SlothDatabase.ts:275
Create a new model instance

Parameters
- factory: PouchFactory<S>
  
  The database factory to attach to the model
- props: Partial<S>
  
  the entity properties
Returns E

an entity instance

Protected dispatch

dispatch(facto: PouchFactory<any>, action: ChangeAction<S>): void

- Defined in models/SlothDatabase.ts:367
Parameters
- facto: PouchFactory<any>
- action: ChangeAction<S>
Returns void

findAllDocs

findAllDocs(factory: PouchFactory<S>, startKey?: string, endKey?: string): Promise<E[]>

- Defined in models/SlothDatabase.ts:238
Fetches all documents for this database and map them with the model

see

PouchDB#allDocs

memberof

SlothDatabase

Parameters
- factory: PouchFactory<S>
  
  the PouchDB factory to use
- Default value startKey: string = this._root || ''
- Default value endKey: string = join(startKey, '\uffff')
Returns Promise<E[]>

a promise that resolves into an array of entity instances

findAllIDs

findAllIDs(factory: PouchFactory<S>, startKey?: string, endKey?: string): Promise<string[]>

- Defined in models/SlothDatabase.ts:210
Fetches all documents IDs for this database and return them

see

PouchDB#allDocs

memberof

SlothDatabase

Parameters
- factory: PouchFactory<S>
  
  the PouchDB factory to use
- Default value startKey: string = this._root || ''
- Default value endKey: string = join(startKey, '\uffff')
Returns Promise<string[]>

a promise that resolves into an array of string IDs

findById

findById(factory: PouchFactory<S>, id: string): Promise<E>

- Defined in models/SlothDatabase.ts:261
Fetch a docuemt from the database

Parameters
- factory: PouchFactory<S>
  
  the PouchDB factory to use
- id: string
  
  the document identifier to fetch
Returns Promise<E>

a promise resolving with the entity instance

Protected getSubscriberFor

getSubscriberFor(factory: PouchFactory<S>): undefined | object

- Defined in models/SlothDatabase.ts:363
Parameters
- factory: PouchFactory<S>
Returns undefined | object

initSetup

initSetup(factory: PouchFactory<S>): Promise<void>

- Defined in models/SlothDatabase.ts:359
Creates view documents (if required)

Parameters
- factory: PouchFactory<S>
Returns Promise<void>

put

put(factory: PouchFactory<S>, props: Partial<S>): Promise<E>

- Defined in models/SlothDatabase.ts:285
Create a new model instance and save it to database

Parameters
- factory: PouchFactory<S>
  
  The database factory to attach to the model
- props: Partial<S>
  
  the entity properties
Returns Promise<E>

an entity instance

query

query(factory: PouchFactory<S>, view: V, startKey?: string, endKey?: string, includeDocs?: boolean): Promise<Response<S>>

- Defined in models/SlothDatabase.ts:78
Run a query

Parameters
- factory: PouchFactory<S>
  
  the pouch factory
- view: V
  
  the view identifier
- Default value startKey: string = ""
  
  the optional startkey
- Default value endKey: string = join(startKey, '\uffff')
  
  the optional endkey
- Default value includeDocs: boolean = false
  
  include_docs
Returns Promise<Response<S>>

queryDocs

queryDocs(factory: PouchFactory<S>, view: V, startKey?: string, endKey?: string): Promise<E[]>

- Defined in models/SlothDatabase.ts:121
Queries and maps docs to Entity objects

Parameters
- factory: PouchFactory<S>
  
  the pouch factory
- view: V
  
  the view identifier
- Default value startKey: string = ""
  
  the optional startkey
- Default value endKey: string = join(startKey, '\uffff')
  
  the optional endkey
Returns Promise<E[]>

queryKeys

queryKeys(factory: PouchFactory<S>, view: V, startKey?: string, endKey?: string): Promise<string[]>

- Defined in models/SlothDatabase.ts:146
Queries keys. Returns an array of emitted keys

Parameters
- factory: PouchFactory<S>
  
  the pouch factory
- view: V
  
  the view identifier
- Default value startKey: string = ""
  
  the optional startkey
- Default value endKey: string = join(startKey, '\uffff')
  
  the optional endkey
Returns Promise<string[]>

queryKeysIDs

queryKeysIDs(factory: PouchFactory<S>, view: V, startKey?: string, endKey?: string): Promise<Dict<string>>

- Defined in models/SlothDatabase.ts:171
Queries keys/_id map. Returns a map of emitted keys/ID

Parameters
- factory: PouchFactory<S>
  
  the pouch factory
- view: V
  
  the view identifier
- Default value startKey: string = ""
  
  the optional startkey
- Default value endKey: string = join(startKey, '\uffff')
  
  the optional endkey
Returns Promise<Dict<string>>

Private setupViews

setupViews(factory: PouchFactory<S>): Promise<void>

- Defined in models/SlothDatabase.ts:373
Parameters
- factory: PouchFactory<S>
Returns Promise<void>

subscribe

subscribe(factory: PouchFactory<S>, sub: Subscriber<S>): void

- Defined in models/SlothDatabase.ts:299
Subscribes a function to PouchDB changes, so that the function will be called when changes are made

see

Subscriber

see

ChangeAction

Parameters
- factory: PouchFactory<S>
  
  the PouchDB factory
- sub: Subscriber<S>
  
  the subscriber function
Returns void

withRoot

withRoot(root: string): SlothDatabase<S, E, never>

- Defined in models/SlothDatabase.ts:196
Returns a database that will only find entities with _id starting with the root path

Parameters
- root: string
  
  the root path
Returns SlothDatabase<S, E, never>

Generated using TypeDoc