Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-27 16:26:31 +01:00
Code Issues Packages Projects Releases Activity

frontend script API documentation

Browse Source
This commit is contained in:
azivner
2018-08-23 12:55:45 +02:00
parent 0e7372adbf
commit f5b89432a6
16 changed files with 241 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/services/backend_script_api.js
View File

@@ -17,11 +17,11 @@ const messagingService = require('./messaging');
* @hideconstructor
*/
function BackendScriptApi(startNote, currentNote, originEntity) {
/** @param {Note} */
/** @property {Note} note where script started executing */
this.startNote = startNote;
/** @param {Note} */
/** @property {Note} note where script is currently executing */
this.currentNote = currentNote;
/** @param {Entity} */
/** @property {Entity} entity whose event triggered this executions */
this.originEntity = originEntity;
this.axios = axios;
@@ -145,7 +145,7 @@ function BackendScriptApi(startNote, currentNote, originEntity) {
* @param {string} parentNoteId - create new note under this parent
* @param {string} title
* @param {string} [content]
* @params {object} [extraOptions]
* @param {object} [extraOptions]
* @returns {Promise<Object>} object contains attributes "note" and "branch" which contain newly created entities
*/
this.createNote = noteService.createNote;
@@ -202,7 +202,7 @@ function BackendScriptApi(startNote, currentNote, originEntity) {
* transactional by default.
*
* @method
* @params {function} func
* @param {function} func
* @returns {Promise<?>} result of func callback
*/
this.transactional = sql.transactional;