From 6c561b57649528d9db318f5f818d703610b9f197 Mon Sep 17 00:00:00 2001 From: zadam Date: Thu, 28 Nov 2019 22:35:55 +0100 Subject: [PATCH] rename API .createNote() to .createNewNote() to allow future backwards compatibility --- docs/backend_api/BackendScriptApi.html | 8 +- docs/backend_api/entities_attribute.js.html | 1 + docs/backend_api/global.html | 378 +++++++++--------- .../services_backend_script_api.js.html | 10 +- src/services/backend_script_api.js | 10 +- 5 files changed, 204 insertions(+), 203 deletions(-) diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html index c1b498d32..deed4723a 100644 --- a/docs/backend_api/BackendScriptApi.html +++ b/docs/backend_api/BackendScriptApi.html @@ -543,7 +543,7 @@ the backend.
Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and -JSON MIME type. See also createNote() for more options. +JSON MIME type. See also createNewNote() for more options.
@@ -736,7 +736,7 @@ JSON MIME type. See also createNote() for more options. -

createNote(paramsopt) → {Promise.<{note: Note, branch: Branch}>}

+

createNewNote(paramsopt) → {Promise.<{note: Note, branch: Branch}>}

@@ -784,7 +784,7 @@ JSON MIME type. See also createNote() for more options. -CreateNoteParams +CreateNewNoteParams @@ -911,7 +911,7 @@ JSON MIME type. See also createNote() for more options.
- Create text note. See also createNote() for more options. + Create text note. See also createNewNote() for more options.
diff --git a/docs/backend_api/entities_attribute.js.html b/docs/backend_api/entities_attribute.js.html index aa9220e39..8a2e0673f 100644 --- a/docs/backend_api/entities_attribute.js.html +++ b/docs/backend_api/entities_attribute.js.html @@ -141,6 +141,7 @@ class Attribute extends Entity { // cannot be static! updatePojo(pojo) { delete pojo.isOwned; + delete pojo.__note; } } diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html index 2221a896e..907f6a8ca 100644 --- a/docs/backend_api/global.html +++ b/docs/backend_api/global.html @@ -102,195 +102,7 @@ -

CreateNoteAttribute

- - - - - - -
Type:
- - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
type - - -string - - - - - - - - attribute type - label, relation etc.
name - - -string - - - - - - - - attribute name
value - - -string - - - - - - <optional>
- - - - 		attribute value
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

CreateNoteParams

+

CreateNewNoteParams

@@ -596,6 +408,194 @@ + +

CreateNoteAttribute

+ + + + + + +
Type:
+ + + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +string + + + + + + + + attribute type - label, relation etc.
name + + +string + + + + + + + + attribute name
value + + +string + + + + + + <optional>
+ + + + 		attribute value
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + diff --git a/docs/backend_api/services_backend_script_api.js.html b/docs/backend_api/services_backend_script_api.js.html index edc16a682..de1512b05 100644 --- a/docs/backend_api/services_backend_script_api.js.html +++ b/docs/backend_api/services_backend_script_api.js.html @@ -206,7 +206,7 @@ function BackendScriptApi(currentNote, apiParams) { */ /** - * Create text note. See also createNote() for more options. + * Create text note. See also createNewNote() for more options. * * @param {string} parentNoteId * @param {string} title @@ -222,7 +222,7 @@ function BackendScriptApi(currentNote, apiParams) { /** * Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and - * JSON MIME type. See also createNote() for more options. + * JSON MIME type. See also createNewNote() for more options. * * @param {string} parentNoteId * @param {string} title @@ -238,7 +238,7 @@ function BackendScriptApi(currentNote, apiParams) { }); /** - * @typedef {object} CreateNoteParams + * @typedef {object} CreateNewNoteParams * @property {string} parentNoteId - MANDATORY * @property {string} title - MANDATORY * @property {string|buffer} content - MANDATORY @@ -253,10 +253,10 @@ function BackendScriptApi(currentNote, apiParams) { /** * @method * - * @param {CreateNoteParams} [params] + * @param {CreateNewNoteParams} [params] * @returns {Promise<{note: Note, branch: Branch}>} object contains newly created entities note and branch */ - this.createNote = noteService.createNewNote; + this.createNewNote = noteService.createNewNote; /** * Log given message to trilium logs. diff --git a/src/services/backend_script_api.js b/src/services/backend_script_api.js index 08e8890b5..15953f241 100644 --- a/src/services/backend_script_api.js +++ b/src/services/backend_script_api.js @@ -178,7 +178,7 @@ function BackendScriptApi(currentNote, apiParams) { */ /** - * Create text note. See also createNote() for more options. + * Create text note. See also createNewNote() for more options. * * @param {string} parentNoteId * @param {string} title @@ -194,7 +194,7 @@ function BackendScriptApi(currentNote, apiParams) { /** * Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and - * JSON MIME type. See also createNote() for more options. + * JSON MIME type. See also createNewNote() for more options. * * @param {string} parentNoteId * @param {string} title @@ -210,7 +210,7 @@ function BackendScriptApi(currentNote, apiParams) { }); /** - * @typedef {object} CreateNoteParams + * @typedef {object} CreateNewNoteParams * @property {string} parentNoteId - MANDATORY * @property {string} title - MANDATORY * @property {string|buffer} content - MANDATORY @@ -225,10 +225,10 @@ function BackendScriptApi(currentNote, apiParams) { /** * @method * - * @param {CreateNoteParams} [params] + * @param {CreateNewNoteParams} [params] * @returns {Promise<{note: Note, branch: Branch}>} object contains newly created entities note and branch */ - this.createNote = noteService.createNewNote; + this.createNewNote = noteService.createNewNote; /** * Log given message to trilium logs.