api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
api.log(api.startNote.
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
runOutsideOfSync(callback) → {Promise}
+
+
+
+
+
+
+
+ Sync process can make data intermittently inconsistent. Scripts which require strong data consistency
+can use this function to wait for a possible sync process to finish and prevent new sync process from starting
+while it is running.
+
+Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case
+you need to make some DB changes, you need to surround your call with api.transactional(...)
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ callback
+
+
+function
+
+
+
+
+
+
+
+
+
+ function to be executed while sync process is not running
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ - resolves once the callback is finished (callback is awaited)
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
searchForNote(query, searchParamsopt) → {BNote|null}
@@ -6711,7 +6875,7 @@ instances execute the given function.
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
This is the main backend API interface for scripts. All the properties and methods are published in the "api" object
@@ -571,6 +572,20 @@ function BackendScriptApi(currentNote, apiParams) {
}
};
+ /**
+ * Sync process can make data intermittently inconsistent. Scripts which require strong data consistency
+ * can use this function to wait for a possible sync process to finish and prevent new sync process from starting
+ * while it is running.
+ *
+ * Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case
+ * you need to make some DB changes, you need to surround your call with api.transactional(...)
+ *
+ * @method
+ * @param {function} callback - function to be executed while sync process is not running
+ * @returns {Promise} - resolves once the callback is finished (callback is awaited)
+ */
+ this.runOutsideOfSync = syncMutex.doExclusively;
+
/**
* This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
*
diff --git a/src/services/sync_mutex.js b/src/services/sync_mutex.js
index 819371e80..fb95d03c4 100644
--- a/src/services/sync_mutex.js
+++ b/src/services/sync_mutex.js
@@ -1,5 +1,5 @@
/**
- * Sync makes process can make data intermittently inconsistent. Processes which require strong data consistency
+ * Sync process can make data intermittently inconsistent. Processes which require strong data consistency
* (like consistency checks) can use this mutex to make sure sync isn't currently running.
*/