Events
View as MarkdownMarkdownProvides the ability to subscribe to various events raised by the local database.
All changes
Invoke the given callback when the database has been changed.
Parameters
- Name
callback- Type
- (PouchDB.Core.ChangesResponseChange<object>) => void
- Description
A function which is called with an object indicating the changes feed.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onChange(changes => {
console.log('Database has been changed', changes)
});
// Later, dispose
subscription.dispose();
Note changes
Invoke the given callback when a note has been added, modified or deleted.
Parameters
- Name
callback- Type
- (PouchDB.Core.ChangesResponseChange<Note>) => void
- Description
A function which is called with an object indicating the changes feed.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onNoteChange(changes => {
console.log('Note has been changed', changes)
});
// Later, dispose
subscription.dispose();
Book changes
Invoke the given callback when a notebook has been added, modified or deleted.
Parameters
- Name
callback- Type
- (PouchDB.Core.ChangesResponseChange<Book>) => void
- Description
A function which is called with an object indicating the changes feed.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onBookChange(changes => {
console.log('Notebook has been changed', changes)
});
// Later, dispose
subscription.dispose();
Tag changes
Invoke the given callback when a tag has been added, modified or deleted.
Parameters
- Name
callback- Type
- (PouchDB.Core.ChangesResponseChange<Tag>) => void
- Description
A function which is called with an object indicating the changes feed.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onTagChange(changes => {
console.log('Tag has been changed', changes)
});
// Later, dispose
subscription.dispose();
Index build start
Invoke the given callback when the app started building the search index.
Parameters
- Name
callback- Type
- () => void
- Description
A Function to be invoked.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onIndexBuildStart(() => {
console.log('Search index building has been started')
});
// Later, dispose
subscription.dispose();
Index build progress
Invoke the given callback each time the app applied a batch of changes to the search index.
The callback receives an object with prevSeq (the sequence the run started from), seq (the sequence reached so far), and latestSeq (the database's update sequence when the run started).
Parameters
- Name
callback- Type
- (progress: object) => void
- Description
A function which is called with the progress.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onIndexBuildProgress(progress => {
console.log('Search index building:', progress.seq, '/', progress.latestSeq)
});
// Later, dispose
subscription.dispose();
Index build end
Invoke the given callback when the app finished building the search index.
Parameters
- Name
callback- Type
- () => void
- Description
A Function to be invoked.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onIndexBuildEnd(() => {
console.log('Search index building has been finished')
});
// Later, dispose
subscription.dispose();
Index build error
Invoke the given callback when the app failed to build the search index.
Parameters
- Name
callback- Type
- (error: Error) => void
- Description
A function which is called with an error.
Returns
Returns a Disposable on which .dispose() can be called to unsubscribe.
Example
const db = env.localDB
const subscription = db.onIndexBuildError(error => {
console.log('Search index building has failed', error)
});
// Later, dispose
subscription.dispose();