From f108775a6a822abe430971e7d708aeaf9f1e2d79 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 00:28:40 +0000 Subject: [PATCH 1/4] chore(deps): update dependency jsdoc to v4.0.4 --- package-lock.json | 28 ++++++++++++++-------------- package.json | 2 +- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/package-lock.json b/package-lock.json index 47e4aede6..d70bdb233 100644 --- a/package-lock.json +++ b/package-lock.json @@ -149,7 +149,7 @@ "esm": "3.2.25", "iconsur": "1.7.0", "jasmine": "5.5.0", - "jsdoc": "4.0.3", + "jsdoc": "4.0.4", "lorem-ipsum": "2.0.8", "nodemon": "3.1.7", "rcedit": "4.0.1", @@ -5399,10 +5399,11 @@ } }, "node_modules/bluebird": { - "version": "3.7.0", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.0.tgz", - "integrity": "sha512-aBQ1FxIa7kSWCcmKHlcHFlT2jt6J/l4FzC7KcPELkOJOsPOb/bccdhmIrKDfXhwFrmc7vDoDrrepFvGqjyXGJg==", - "dev": true + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", + "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", + "dev": true, + "license": "MIT" }, "node_modules/bmp-js": { "version": "0.1.0", @@ -12020,10 +12021,11 @@ "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" }, "node_modules/jsdoc": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.3.tgz", - "integrity": "sha512-Nu7Sf35kXJ1MWDZIMAuATRQTg1iIPdzh7tqJ6jjvaU/GfDf+qi5UV8zJR3Mo+/pYFvm8mzay4+6O5EWigaQBQw==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.4.tgz", + "integrity": "sha512-zeFezwyXeG4syyYHbvh1A967IAqq/67yXtXvuL5wnqCkFZe8I0vKfm+EO+YEvLguo6w9CDUbrAXVtJSHh2E8rw==", "dev": true, + "license": "Apache-2.0", "dependencies": { "@babel/parser": "^7.20.15", "@jsdoc/salty": "^0.2.1", @@ -12048,17 +12050,12 @@ "node": ">=12.0.0" } }, - "node_modules/jsdoc/node_modules/bluebird": { - "version": "3.7.2", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", - "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", - "dev": true - }, "node_modules/jsdoc/node_modules/escape-string-regexp": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -12068,6 +12065,7 @@ "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", "dev": true, + "license": "MIT", "bin": { "marked": "bin/marked.js" }, @@ -12080,6 +12078,7 @@ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", "dev": true, + "license": "MIT", "bin": { "mkdirp": "bin/cmd.js" }, @@ -12092,6 +12091,7 @@ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" }, diff --git a/package.json b/package.json index 8c67cfba6..83ebcef2f 100644 --- a/package.json +++ b/package.json @@ -189,7 +189,7 @@ "esm": "3.2.25", "iconsur": "1.7.0", "jasmine": "5.5.0", - "jsdoc": "4.0.3", + "jsdoc": "4.0.4", "lorem-ipsum": "2.0.8", "nodemon": "3.1.7", "rcedit": "4.0.1", From 6bbff3efd82eb36b9060d60252c90ff358651405 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Wed, 11 Dec 2024 18:31:29 +0200 Subject: [PATCH 2/4] chore(frontend-docs): fix warnings & update --- docs/frontend_api/BasicWidget.html | 659 +++++++++++++++++- docs/frontend_api/FAttachment.html | 2 +- docs/frontend_api/FAttribute.html | 2 +- docs/frontend_api/FBranch.html | 2 +- docs/frontend_api/FNote.html | 142 ++-- docs/frontend_api/FrontendScriptApi.html | 98 +-- docs/frontend_api/NoteContextAwareWidget.html | 592 +++++++++++++++- docs/frontend_api/RightPanelWidget.html | 593 +++++++++++++++- .../frontend_api/entities_fattachment.js.html | 2 +- docs/frontend_api/entities_fattribute.js.html | 2 +- docs/frontend_api/entities_fblob.js.html | 2 +- docs/frontend_api/entities_fbranch.js.html | 2 +- docs/frontend_api/entities_fnote.js.html | 5 +- docs/frontend_api/global.html | 6 +- docs/frontend_api/index.html | 2 +- .../services_frontend_script_api.js.html | 14 +- .../frontend_api/widgets_basic_widget.js.html | 83 ++- .../widgets_note_context_aware_widget.js.html | 19 +- .../widgets_right_panel_widget.js.html | 8 +- src/public/app/widgets/basic_widget.js | 2 +- .../app/widgets/note_context_aware_widget.js | 2 +- 21 files changed, 2070 insertions(+), 169 deletions(-) diff --git a/docs/frontend_api/BasicWidget.html b/docs/frontend_api/BasicWidget.html index 2e8edd905..69f029e13 100644 --- a/docs/frontend_api/BasicWidget.html +++ b/docs/frontend_api/BasicWidget.html @@ -95,7 +95,7 @@

new BasicW
Source:
@@ -151,6 +151,176 @@

Methods

+

css(name, value)

+ + + + + + +
+ Sets the CSS attribute of the given name to the given value. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the CSS attribute to set (e.g. `padding-left`).
value + + +string + + + + the value of the CSS attribute to set (e.g. `12px`).
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ self for chaining. +
+ + + + + + + + + + + + + + +

cssBlock(block) → {this}

@@ -252,7 +422,7 @@
Parameters:
Source:
@@ -365,7 +535,95 @@

doRenderSource:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

isEnabled()

+ + + + + + +
+ Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -390,6 +648,399 @@

doRenderReturns:

+ + +
+ whether the widget is enabled. +
+ + + + + + + + + + + + + + + +

optChild(condition, …components)

+ + + + + + +
+ Conditionally adds the given components as children to this component. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
condition + + +boolean + + + + + + + + + + whether to add the components.
components + + +any + + + + + + + + + + <repeatable>
+ + 		the components to be added as children to this component provided the condition is truthy.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ self for chaining. +
+ + + + + + + + + + + + + + + +

optCss(condition, name, value)

+ + + + + + +
+ Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
condition + + +boolean + + + + `true` in order to apply the CSS, `false` to ignore it.
name + + +string + + + + the name of the CSS attribute to set (e.g. `padding-left`).
value + + +string + + + + the value of the CSS attribute to set (e.g. `12px`).
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ self for chaining. +
+ + + + @@ -417,7 +1068,7 @@

Home

Classes

sortChildren

sortParents

toggleAttribute

  • toggleAttribute(
        type: AttributeType,
        enabled: boolean,
        name: string,
        value?: string,
    ): void

  • Based on enabled, the attribute is either set or removed.

    Parameters

    • type: AttributeType

      attribute type ('relation', 'label' etc.)

    • enabled: boolean

      toggle On or Off

    • name: string

      attribute name

    • Optionalvalue: string

      attribute value (optional)

      -

    Returns void

toggleLabel

  • toggleLabel(enabled: boolean, name: string, value?: string): void

  • Based on enabled, label is either set or removed.

    +

Returns void

toggleLabel

  • toggleLabel(enabled: boolean, name: string, value?: string): void

  • Based on enabled, label is either set or removed.

    Parameters

    • enabled: boolean

      toggle On or Off

    • name: string

      label name

    • Optionalvalue: string

      label value (optional)

      -

    Returns void

toggleRelation

  • toggleRelation(enabled: boolean, name: string, value?: string): void

  • Based on enabled, relation is either set or removed.

    +

Returns void

toggleRelation

  • toggleRelation(enabled: boolean, name: string, value?: string): void

  • Based on enabled, relation is either set or removed.

    Parameters

    • enabled: boolean

      toggle On or Off

    • name: string

      relation name

    • Optionalvalue: string

      relation value (noteId)

      -

    Returns void

update

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
__validateTypeName_getContent_setContentaddAttributeaddLabeladdRelationareAllNotePathsArchivedbeforeSavingcloneToconvertToParentAttachmentdecryptdeleteNoteeraseExcessRevisionSnapshotsgenerateHashgetAllNotePathsgetAncestorNoteIdsgetAncestorsgetAttachmentByIdgetAttachmentByTitlegetAttachmentsgetAttachmentsByRolegetAttributegetAttributeCaseInsensitivegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBranchesgetChildBranchesgetChildNotesgetContentgetDescendantNoteIdsgetDistanceToAncestorgetFileNamegetFlatTextgetInheritingNotesgetJsonContentgetJsonContentSafelygetLabelgetLabelDefinitionsgetLabelsgetLabelValuegetLabelValuesgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedLabelValuesgetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentNotesgetPojogetPojoToSavegetRelationgetRelationDefinitionsgetRelationsgetRelationTargetgetRelationValuegetRevisionsgetScriptEnvgetSearchResultNotesgetSortedNotePathRecordsgetStrongParentBranchesgetSubtreegetSubtreeNoteIdsgetSubtreeNotesIncludingTemplatedgetTargetRelationsgetTitleOrProtectedgetUtcDateChangedhasAncestorhasAttributehasChildrenhasInheritableArchivedLabelhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationhasStringContentinitinvalidateSubTreeinvalidateThisCacheisContentAvailableisDescendantOfNoteisEligibleForConversionToAttachmentisHiddenCompletelyisHtmlisImageisInheritedisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisStringNotemarkAsDeletedmarkAsDeletedSimpleputEntityChangeremoveAttributeremoveLabelremoveRelationsavesaveAttachmentsaveRevisionsearchNoteInSubtreesearchNotesInSubtreesetAttributesetContentsetJsonContentsetLabelsetRelationsortChildrensortParentstoggleAttributetoggleLabeltoggleRelationupdateupdateFromRow
+

Returns void

update

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
__validateTypeName_getContent_setContentaddAttributeaddLabeladdRelationareAllNotePathsArchivedbeforeSavingcloneToconvertToParentAttachmentdecryptdeleteNoteeraseExcessRevisionSnapshotsgenerateHashgetAllNotePathsgetAncestorNoteIdsgetAncestorsgetAttachmentByIdgetAttachmentByTitlegetAttachmentsgetAttachmentsByRolegetAttributegetAttributeCaseInsensitivegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBranchesgetChildBranchesgetChildNotesgetContentgetDescendantNoteIdsgetDistanceToAncestorgetFileNamegetFlatTextgetInheritingNotesgetJsonContentgetJsonContentSafelygetLabelgetLabelDefinitionsgetLabelsgetLabelValuegetLabelValuesgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedLabelValuesgetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentNotesgetPojogetPojoToSavegetRelationgetRelationDefinitionsgetRelationsgetRelationTargetgetRelationValuegetRevisionsgetScriptEnvgetSearchResultNotesgetSortedNotePathRecordsgetStrongParentBranchesgetSubtreegetSubtreeNoteIdsgetSubtreeNotesIncludingTemplatedgetTargetRelationsgetTitleOrProtectedgetUtcDateChangedhasAncestorhasAttributehasChildrenhasInheritableArchivedLabelhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationhasStringContentinitinvalidateSubTreeinvalidateThisCacheisContentAvailableisDescendantOfNoteisEligibleForConversionToAttachmentisHiddenCompletelyisHtmlisImageisInheritedisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisStringNotemarkAsDeletedmarkAsDeletedSimpleputEntityChangeremoveAttributeremoveLabelremoveRelationsavesaveAttachmentsaveRevisionsearchNoteInSubtreesearchNotesInSubtreesetAttributesetContentsetJsonContentsetLabelsetRelationsortChildrensortParentstoggleAttributetoggleLabeltoggleRelationupdateupdateFromRow
diff --git a/docs/backend_api/classes/becca_entities_boption.default.html b/docs/backend_api/classes/becca_entities_boption.default.html index e8f01a50c..b13ceb36f 100644 --- a/docs/backend_api/classes/becca_entities_boption.default.html +++ b/docs/backend_api/classes/becca_entities_boption.default.html @@ -1,5 +1,5 @@ default | trilium

Class default

Option represents a name-value pair, either directly configurable by the user or some system property.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

blobId? dateCreated? dateModified? @@ -28,7 +28,7 @@ putEntityChange save updateFromRow -

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

name

name: string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

value

value: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

generateHash

getPojo

  • getPojo(): {
        isSynced: undefined
        | boolean;
        name: string;
        utcDateModified: undefined | string;
        value: string;
    }

  • Returns {
        isSynced: undefined | boolean;
        name: string;
        utcDateModified: undefined | string;
        value: string;
    }

ProtectedgetPojoToSave

getUtcDateChanged

hasStringContent

init

markAsDeleted

  • markAsDeleted(deleteId?: null | string): void

  • Mark the entity as (soft) deleted. It will be completely erased later.

    +

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

name

name: string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

value

value: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

generateHash

getPojo

  • getPojo(): {
        isSynced: undefined
        | boolean;
        name: string;
        utcDateModified: undefined | string;
        value: string;
    }

  • Returns {
        isSynced: undefined | boolean;
        name: string;
        utcDateModified: undefined | string;
        value: string;
    }

ProtectedgetPojoToSave

getUtcDateChanged

hasStringContent

init

markAsDeleted

  • markAsDeleted(deleteId?: null | string): void

  • Mark the entity as (soft) deleted. It will be completely erased later.

    This is a low-level method, for notes and branches use note.deleteNote() and 'branch.deleteBranch()` instead.

    -

    Parameters

    • deleteId: null | string = null

    Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

  • deleteId: null | string = null

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/classes/becca_entities_brecent_note.default.html b/docs/backend_api/classes/becca_entities_brecent_note.default.html index 716fc9814..5d536c7b8 100644 --- a/docs/backend_api/classes/becca_entities_brecent_note.default.html +++ b/docs/backend_api/classes/becca_entities_brecent_note.default.html @@ -1,5 +1,5 @@ default | trilium

Class default

RecentNote represents recently visited note.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

blobId? dateCreated? dateModified? @@ -28,7 +28,7 @@ putEntityChange save updateFromRow -

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

noteId

noteId: string

notePath

notePath: string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

ProtectedbeforeSaving

generateHash

getPojo

ProtectedgetPojoToSave

getUtcDateChanged

hasStringContent

init

markAsDeleted

  • markAsDeleted(deleteId?: null | string): void

  • Mark the entity as (soft) deleted. It will be completely erased later.

    +

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

noteId

noteId: string

notePath

notePath: string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

ProtectedbeforeSaving

generateHash

getPojo

ProtectedgetPojoToSave

getUtcDateChanged

hasStringContent

init

markAsDeleted

  • markAsDeleted(deleteId?: null | string): void

  • Mark the entity as (soft) deleted. It will be completely erased later.

    This is a low-level method, for notes and branches use note.deleteNote() and 'branch.deleteBranch()` instead.

    -

    Parameters

    • deleteId: null | string = null

    Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

  • deleteId: null | string = null

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/classes/becca_entities_brevision.default.html b/docs/backend_api/classes/becca_entities_brevision.default.html index 42a0b64e5..da201582a 100644 --- a/docs/backend_api/classes/becca_entities_brevision.default.html +++ b/docs/backend_api/classes/becca_entities_brevision.default.html @@ -1,6 +1,6 @@ default | trilium

Class default

Revision represents a snapshot of note's title and content at some point in the past. It's used for seamless note versioning.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

blobId? content? contentLength? @@ -47,11 +47,11 @@ save setContent updateFromRow -

Constructors

constructor

Properties

OptionalblobId

blobId?: string

Optionalcontent

content?: string | Buffer<ArrayBufferLike>

OptionalcontentLength

contentLength?: number

OptionaldateCreated

dateCreated?: string

OptionaldateLastEdited

dateLastEdited?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

mime

mime: string

noteId

noteId: string

OptionalrevisionId

revisionId?: string

title

title: string

type

type: string

utcDateCreated

utcDateCreated: string

OptionalutcDateLastEdited

utcDateLastEdited?: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

eraseRevision

generateHash

getAttachmentById

getAttachmentByTitle

getAttachments

getAttachmentsByRole

getContent

getJsonContent

getJsonContentSafely

getNote

getPojo

  • getPojo(): {
        blobId: undefined
        | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        blobId: undefined | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

getPojoToSave

  • getPojoToSave(): {
        blobId: undefined
        | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        blobId: undefined | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

getUtcDateChanged

hasStringContent

init

isContentAvailable

markAsDeleted

  • markAsDeleted(deleteId?: null | string): void

  • Mark the entity as (soft) deleted. It will be completely erased later.

    +

Constructors

constructor

Properties

OptionalblobId

blobId?: string

Optionalcontent

content?: string | Buffer<ArrayBufferLike>

OptionalcontentLength

contentLength?: number

OptionaldateCreated

dateCreated?: string

OptionaldateLastEdited

dateLastEdited?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

mime

mime: string

noteId

noteId: string

OptionalrevisionId

revisionId?: string

title

title: string

type

type: string

utcDateCreated

utcDateCreated: string

OptionalutcDateLastEdited

utcDateLastEdited?: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

eraseRevision

generateHash

getAttachmentById

getAttachmentByTitle

getAttachments

getAttachmentsByRole

getContent

getJsonContent

getJsonContentSafely

getNote

getPojo

  • getPojo(): {
        blobId: undefined
        | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        blobId: undefined | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

getPojoToSave

  • getPojoToSave(): {
        blobId: undefined
        | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        blobId: undefined | string;
        content: undefined | string | Buffer<ArrayBufferLike>;
        contentLength: undefined | number;
        dateCreated: undefined | string;
        dateLastEdited: undefined | string;
        isProtected: undefined | boolean;
        mime: string;
        noteId: string;
        revisionId: undefined | string;
        title: undefined | string;
        type: string;
        utcDateCreated: string;
        utcDateLastEdited: undefined | string;
        utcDateModified: undefined | string;
    }

getUtcDateChanged

hasStringContent

init

isContentAvailable

markAsDeleted

  • markAsDeleted(deleteId?: null | string): void

  • Mark the entity as (soft) deleted. It will be completely erased later.

    This is a low-level method, for notes and branches use note.deleteNote() and 'branch.deleteBranch()` instead.

    -

    Parameters

    • deleteId: null | string = null

    Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

setContent

  • setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void

  • Parameters

    • content: string | Buffer<ArrayBufferLike>
    • opts: ContentOpts = {}

    Returns void

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

  • deleteId: null | string = null

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

setContent

  • setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void

  • Parameters

    • content: string | Buffer<ArrayBufferLike>
    • opts: ContentOpts = {}

    Returns void

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/interfaces/becca_entities_rows.AttachmentRow.html b/docs/backend_api/interfaces/becca_entities_rows.AttachmentRow.html index b50d16189..e0d1e5e48 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.AttachmentRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.AttachmentRow.html @@ -1,4 +1,4 @@ -AttachmentRow | trilium

Interface AttachmentRow

interface AttachmentRow {
    attachmentId?: string;
    blobId?: string;
    content?: string | Buffer<ArrayBufferLike>;
    contentLength?: number;
    dateModified?: string;
    isProtected?: boolean;
    mime: string;
    ownerId?: string;
    position?: number;
    role: string;
    title: string;
    utcDateModified?: string;
    utcDateScheduledForErasureSince?: string;
}

Properties

attachmentId? +AttachmentRow | trilium

Interface AttachmentRow

interface AttachmentRow {
    attachmentId?: string;
    blobId?: string;
    content?: string | Buffer<ArrayBufferLike>;
    contentLength?: number;
    dateModified?: string;
    isProtected?: boolean;
    mime: string;
    ownerId?: string;
    position?: number;
    role: string;
    title: string;
    utcDateModified?: string;
    utcDateScheduledForErasureSince?: string;
}

Properties

attachmentId? blobId? content? contentLength? @@ -11,4 +11,4 @@ title utcDateModified? utcDateScheduledForErasureSince? -

Properties

OptionalattachmentId

attachmentId?: string

OptionalblobId

blobId?: string

Optionalcontent

content?: string | Buffer<ArrayBufferLike>

OptionalcontentLength

contentLength?: number

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

mime

mime: string

OptionalownerId

ownerId?: string

Optionalposition

position?: number

role

role: string

title

title: string

OptionalutcDateModified

utcDateModified?: string

OptionalutcDateScheduledForErasureSince

utcDateScheduledForErasureSince?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalattachmentId

attachmentId?: string

OptionalblobId

blobId?: string

Optionalcontent

content?: string | Buffer<ArrayBufferLike>

OptionalcontentLength

contentLength?: number

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

mime

mime: string

OptionalownerId

ownerId?: string

Optionalposition

position?: number

role

role: string

title

title: string

OptionalutcDateModified

utcDateModified?: string

OptionalutcDateScheduledForErasureSince

utcDateScheduledForErasureSince?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.AttributeRow.html b/docs/backend_api/interfaces/becca_entities_rows.AttributeRow.html index 13232fc56..badc7f521 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.AttributeRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.AttributeRow.html @@ -1,4 +1,4 @@ -AttributeRow | trilium

Interface AttributeRow

interface AttributeRow {
    attributeId?: string;
    isInheritable?: boolean;
    name: string;
    noteId?: string;
    position?: null | number;
    type: AttributeType;
    utcDateModified?: string;
    value?: string;
}

Properties

attributeId? +AttributeRow | trilium

Interface AttributeRow

interface AttributeRow {
    attributeId?: string;
    isInheritable?: boolean;
    name: string;
    noteId?: string;
    position?: null | number;
    type: AttributeType;
    utcDateModified?: string;
    value?: string;
}

Properties

attributeId? isInheritable? name noteId? @@ -6,4 +6,4 @@ type utcDateModified? value? -

Properties

OptionalattributeId

attributeId?: string

OptionalisInheritable

isInheritable?: boolean

name

name: string

OptionalnoteId

noteId?: string

Optionalposition

position?: null | number

type

type: AttributeType

OptionalutcDateModified

utcDateModified?: string

Optionalvalue

value?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalattributeId

attributeId?: string

OptionalisInheritable

isInheritable?: boolean

name

name: string

OptionalnoteId

noteId?: string

Optionalposition

position?: null | number

type

type: AttributeType

OptionalutcDateModified

utcDateModified?: string

Optionalvalue

value?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.BlobRow.html b/docs/backend_api/interfaces/becca_entities_rows.BlobRow.html index f5a23e08a..2f038e1c2 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.BlobRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.BlobRow.html @@ -1,6 +1,6 @@ -BlobRow | trilium

Interface BlobRow

interface BlobRow {
    blobId: string;
    content: string | Buffer<ArrayBufferLike>;
    contentLength: number;
    dateModified: string;
    utcDateModified: string;
}

Properties

blobId +BlobRow | trilium

Interface BlobRow

interface BlobRow {
    blobId: string;
    content: string | Buffer<ArrayBufferLike>;
    contentLength: number;
    dateModified: string;
    utcDateModified: string;
}

Properties

blobId content contentLength dateModified utcDateModified -

Properties

blobId

blobId: string

content

content: string | Buffer<ArrayBufferLike>

contentLength

contentLength: number

dateModified

dateModified: string

utcDateModified

utcDateModified: string

Settings

Member Visibility

On This Page

Properties
+

Properties

blobId

blobId: string

content

content: string | Buffer<ArrayBufferLike>

contentLength

contentLength: number

dateModified

dateModified: string

utcDateModified

utcDateModified: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.BranchRow.html b/docs/backend_api/interfaces/becca_entities_rows.BranchRow.html index b5225a135..293f63d5e 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.BranchRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.BranchRow.html @@ -1,4 +1,4 @@ -BranchRow | trilium

Interface BranchRow

interface BranchRow {
    branchId?: string;
    isDeleted?: boolean;
    isExpanded?: boolean;
    noteId: string;
    notePosition?: null | number;
    parentNoteId: string;
    prefix?: null | string;
    utcDateModified?: string;
}

Properties

branchId? +BranchRow | trilium

Interface BranchRow

interface BranchRow {
    branchId?: string;
    isDeleted?: boolean;
    isExpanded?: boolean;
    noteId: string;
    notePosition?: null | number;
    parentNoteId: string;
    prefix?: null | string;
    utcDateModified?: string;
}

Properties

branchId? isDeleted? isExpanded? noteId @@ -6,4 +6,4 @@ parentNoteId prefix? utcDateModified? -

Properties

OptionalbranchId

branchId?: string

OptionalisDeleted

isDeleted?: boolean

OptionalisExpanded

isExpanded?: boolean

noteId

noteId: string

OptionalnotePosition

notePosition?: null | number

parentNoteId

parentNoteId: string

Optionalprefix

prefix?: null | string

OptionalutcDateModified

utcDateModified?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalbranchId

branchId?: string

OptionalisDeleted

isDeleted?: boolean

OptionalisExpanded

isExpanded?: boolean

noteId

noteId: string

OptionalnotePosition

notePosition?: null | number

parentNoteId

parentNoteId: string

Optionalprefix

prefix?: null | string

OptionalutcDateModified

utcDateModified?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.EtapiTokenRow.html b/docs/backend_api/interfaces/becca_entities_rows.EtapiTokenRow.html index 6a8afd207..f21d78572 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.EtapiTokenRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.EtapiTokenRow.html @@ -1,7 +1,7 @@ -EtapiTokenRow | trilium

Interface EtapiTokenRow

interface EtapiTokenRow {
    etapiTokenId?: string;
    isDeleted?: boolean;
    name: string;
    tokenHash: string;
    utcDateCreated?: string;
    utcDateModified?: string;
}

Properties

etapiTokenId? +EtapiTokenRow | trilium

Interface EtapiTokenRow

interface EtapiTokenRow {
    etapiTokenId?: string;
    isDeleted?: boolean;
    name: string;
    tokenHash: string;
    utcDateCreated?: string;
    utcDateModified?: string;
}

Properties

etapiTokenId? isDeleted? name tokenHash utcDateCreated? utcDateModified? -

Properties

OptionaletapiTokenId

etapiTokenId?: string

OptionalisDeleted

isDeleted?: boolean

name

name: string

tokenHash

tokenHash: string

OptionalutcDateCreated

utcDateCreated?: string

OptionalutcDateModified

utcDateModified?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionaletapiTokenId

etapiTokenId?: string

OptionalisDeleted

isDeleted?: boolean

name

name: string

tokenHash

tokenHash: string

OptionalutcDateCreated

utcDateCreated?: string

OptionalutcDateModified

utcDateModified?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.NoteRow.html b/docs/backend_api/interfaces/becca_entities_rows.NoteRow.html index e1ec0ca59..4a56f60b9 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.NoteRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.NoteRow.html @@ -1,4 +1,4 @@ -NoteRow | trilium

Interface NoteRow

interface NoteRow {
    blobId: string;
    content?: string | Buffer<ArrayBufferLike>;
    dateCreated: string;
    dateModified: string;
    deleteId: string;
    isDeleted: boolean;
    isProtected: boolean;
    mime: string;
    noteId: string;
    title: string;
    type:
        | "search"
        | "file"
        | "text"
        | "code"
        | "relationMap"
        | "render"
        | "book"
        | "mermaid"
        | "canvas"
        | "image"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "webView"
        | "mindMap";
    utcDateCreated: string;
    utcDateModified: string;
}

Properties

blobId +NoteRow | trilium

Interface NoteRow

interface NoteRow {
    blobId: string;
    content?: string | Buffer<ArrayBufferLike>;
    dateCreated: string;
    dateModified: string;
    deleteId: string;
    isDeleted: boolean;
    isProtected: boolean;
    mime: string;
    noteId: string;
    title: string;
    type:
        | "search"
        | "file"
        | "text"
        | "code"
        | "relationMap"
        | "render"
        | "book"
        | "mermaid"
        | "canvas"
        | "image"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "webView"
        | "mindMap";
    utcDateCreated: string;
    utcDateModified: string;
}

Properties

blobId content? dateCreated dateModified @@ -11,4 +11,4 @@ type utcDateCreated utcDateModified -

Properties

blobId

blobId: string

Optionalcontent

content?: string | Buffer<ArrayBufferLike>

dateCreated

dateCreated: string

dateModified

dateModified: string

deleteId

deleteId: string

isDeleted

isDeleted: boolean

isProtected

isProtected: boolean

mime

mime: string

noteId

noteId: string

title

title: string

type

type:
    | "search"
    | "file"
    | "text"
    | "code"
    | "relationMap"
    | "render"
    | "book"
    | "mermaid"
    | "canvas"
    | "image"
    | "noteMap"
    | "launcher"
    | "doc"
    | "contentWidget"
    | "webView"
    | "mindMap"

utcDateCreated

utcDateCreated: string

utcDateModified

utcDateModified: string

Settings

Member Visibility

On This Page

Properties
+

Properties

blobId

blobId: string

Optionalcontent

content?: string | Buffer<ArrayBufferLike>

dateCreated

dateCreated: string

dateModified

dateModified: string

deleteId

deleteId: string

isDeleted

isDeleted: boolean

isProtected

isProtected: boolean

mime

mime: string

noteId

noteId: string

title

title: string

type

type:
    | "search"
    | "file"
    | "text"
    | "code"
    | "relationMap"
    | "render"
    | "book"
    | "mermaid"
    | "canvas"
    | "image"
    | "noteMap"
    | "launcher"
    | "doc"
    | "contentWidget"
    | "webView"
    | "mindMap"

utcDateCreated

utcDateCreated: string

utcDateModified

utcDateModified: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.OptionRow.html b/docs/backend_api/interfaces/becca_entities_rows.OptionRow.html index 951402e00..6b9427cd8 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.OptionRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.OptionRow.html @@ -1,11 +1,11 @@ OptionRow | trilium

Interface OptionRow

Database representation of an option.

Options are key-value pairs that are used to store information such as user preferences (for example the current theme, sync server information), but also information about the state of the application).

-
interface OptionRow {
    isSynced: boolean;
    name: string;
    utcDateModified?: string;
    value: string;
}

Properties

isSynced +
interface OptionRow {
    isSynced: boolean;
    name: string;
    utcDateModified?: string;
    value: string;
}

Properties

isSynced name utcDateModified? value

Properties

isSynced

isSynced: boolean

true if the value should be synced across multiple instances (e.g. locale) or false if it should be local-only (e.g. theme).

-

name

name: string

The name of the option.

-

OptionalutcDateModified

utcDateModified?: string

value

value: string

The value of the option.

-

Settings

Member Visibility

On This Page

Properties
+

name

name: string

The name of the option.

+

OptionalutcDateModified

utcDateModified?: string

value

value: string

The value of the option.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.RecentNoteRow.html b/docs/backend_api/interfaces/becca_entities_rows.RecentNoteRow.html index d7458d9da..d4fdb1f9d 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.RecentNoteRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.RecentNoteRow.html @@ -1,4 +1,4 @@ -RecentNoteRow | trilium

Interface RecentNoteRow

interface RecentNoteRow {
    noteId: string;
    notePath: string;
    utcDateCreated?: string;
}

Properties

noteId +RecentNoteRow | trilium

Interface RecentNoteRow

interface RecentNoteRow {
    noteId: string;
    notePath: string;
    utcDateCreated?: string;
}

Properties

noteId notePath utcDateCreated? -

Properties

noteId

noteId: string

notePath

notePath: string

OptionalutcDateCreated

utcDateCreated?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

noteId

noteId: string

notePath

notePath: string

OptionalutcDateCreated

utcDateCreated?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/interfaces/becca_entities_rows.RevisionRow.html b/docs/backend_api/interfaces/becca_entities_rows.RevisionRow.html index a6a5402d3..64ed1ab21 100644 --- a/docs/backend_api/interfaces/becca_entities_rows.RevisionRow.html +++ b/docs/backend_api/interfaces/becca_entities_rows.RevisionRow.html @@ -1,4 +1,4 @@ -RevisionRow | trilium

Interface RevisionRow

interface RevisionRow {
    blobId?: string;
    contentLength?: number;
    dateCreated: string;
    dateLastEdited?: string;
    isProtected?: boolean;
    mime: string;
    noteId: string;
    revisionId?: string;
    title: string;
    type: string;
    utcDateCreated: string;
    utcDateLastEdited?: string;
    utcDateModified: string;
}

Properties

blobId? +RevisionRow | trilium

Interface RevisionRow

interface RevisionRow {
    blobId?: string;
    contentLength?: number;
    dateCreated: string;
    dateLastEdited?: string;
    isProtected?: boolean;
    mime: string;
    noteId: string;
    revisionId?: string;
    title: string;
    type: string;
    utcDateCreated: string;
    utcDateLastEdited?: string;
    utcDateModified: string;
}

Properties

blobId? contentLength? dateCreated dateLastEdited? @@ -11,4 +11,4 @@ utcDateCreated utcDateLastEdited? utcDateModified -

Properties

OptionalblobId

blobId?: string

OptionalcontentLength

contentLength?: number

dateCreated

dateCreated: string

OptionaldateLastEdited

dateLastEdited?: string

OptionalisProtected

isProtected?: boolean

mime

mime: string

noteId

noteId: string

OptionalrevisionId

revisionId?: string

title

title: string

type

type: string

utcDateCreated

utcDateCreated: string

OptionalutcDateLastEdited

utcDateLastEdited?: string

utcDateModified

utcDateModified: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalblobId

blobId?: string

OptionalcontentLength

contentLength?: number

dateCreated

dateCreated: string

OptionaldateLastEdited

dateLastEdited?: string

OptionalisProtected

isProtected?: boolean

mime

mime: string

noteId

noteId: string

OptionalrevisionId

revisionId?: string

title

title: string

type

type: string

utcDateCreated

utcDateCreated: string

OptionalutcDateLastEdited

utcDateLastEdited?: string

utcDateModified

utcDateModified: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/backend_api/types/becca_entities_rows.AttributeType.html b/docs/backend_api/types/becca_entities_rows.AttributeType.html index 26f515f7b..c55212d07 100644 --- a/docs/backend_api/types/becca_entities_rows.AttributeType.html +++ b/docs/backend_api/types/becca_entities_rows.AttributeType.html @@ -1 +1 @@ -AttributeType | trilium

Type Alias AttributeType

AttributeType: "label" | "relation" | "label-definition" | "relation-definition"

Settings

Member Visibility
+AttributeType | trilium

Type Alias AttributeType

AttributeType: "label" | "relation" | "label-definition" | "relation-definition"

Settings

Member Visibility
diff --git a/docs/backend_api/types/becca_entities_rows.NoteType.html b/docs/backend_api/types/becca_entities_rows.NoteType.html index f509dd66e..8352415bc 100644 --- a/docs/backend_api/types/becca_entities_rows.NoteType.html +++ b/docs/backend_api/types/becca_entities_rows.NoteType.html @@ -1 +1 @@ -NoteType | trilium

Type Alias NoteType

NoteType: typeof ALLOWED_NOTE_TYPES[number]

Settings

Member Visibility
+NoteType | trilium

Type Alias NoteType

NoteType: typeof ALLOWED_NOTE_TYPES[number]

Settings

Member Visibility
diff --git a/docs/backend_api/variables/becca_entities_rows.ALLOWED_NOTE_TYPES.html b/docs/backend_api/variables/becca_entities_rows.ALLOWED_NOTE_TYPES.html index 57d702701..9e0de4bf4 100644 --- a/docs/backend_api/variables/becca_entities_rows.ALLOWED_NOTE_TYPES.html +++ b/docs/backend_api/variables/becca_entities_rows.ALLOWED_NOTE_TYPES.html @@ -1,4 +1,4 @@ ALLOWED_NOTE_TYPES | trilium

Variable ALLOWED_NOTE_TYPESConst

ALLOWED_NOTE_TYPES: readonly [
    "file",
    "image",
    "search",
    "noteMap",
    "launcher",
    "doc",
    "contentWidget",
    "text",
    "relationMap",
    "render",
    "canvas",
    "mermaid",
    "book",
    "webView",
    "code",
    "mindMap",
] = ...

There are many different Note types, some of which are entirely opaque to the end user. Those types should be used only for checking against, they are not for direct use.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/backend_api/variables/services_backend_script_api.default.html b/docs/backend_api/variables/services_backend_script_api.default.html index 7f9939dd7..0411fa280 100644 --- a/docs/backend_api/variables/services_backend_script_api.default.html +++ b/docs/backend_api/variables/services_backend_script_api.default.html @@ -1 +1 @@ -default | trilium

Variable default

default: new (currentNote: default, apiParams: ApiParams) => Api

Settings

Member Visibility
+default | trilium

Variable default

default: new (currentNote: default, apiParams: ApiParams) => Api

Settings

Member Visibility
diff --git a/docs/backend_api/variables/services_sql.default.html b/docs/backend_api/variables/services_sql.default.html index ccc3ed24f..037d90e28 100644 --- a/docs/backend_api/variables/services_sql.default.html +++ b/docs/backend_api/variables/services_sql.default.html @@ -1,7 +1,7 @@ default | trilium

Variable default

default: {
    copyDatabase: (targetFilePath: string) => Promise<void>;
    dbConnection: Database;
    disableSlowQueryLogging: <T>(cb: () => T) => T;
    execute: (query: string, params?: any) => RunResult;
    executeMany: (query: string, params: any) => void;
    executeScript: (query: string) => DatabaseType;
    fillParamList: (
        paramIds: string[] | Set<string>,
        truncate?: boolean,
    ) => void;
    getColumn: <T>(query: string, params?: any) => T[];
    getManyRows: <T>(query: string, params: any) => T[];
    getMap: <K extends string | number | symbol, V>(
        query: string,
        params?: any,
    ) => Record<K, V>;
    getRawRows: <T extends {} | unknown[]>(query: string, params?: any) => T[];
    getRow: <T>(query: string, params?: any) => T;
    getRowOrNull: <T>(query: string, params?: any) => T | null;
    getRows: <T>(query: string, params?: any) => T[];
    getValue: <T>(query: string, params?: any) => T;
    insert: <T extends {}>(
        tableName: string,
        rec: T,
        replace?: boolean,
    ) => undefined | null | number | bigint;
    iterateRows: <T>(query: string, params?: any) => IterableIterator<T>;
    rebuildIntegrationTestDatabase: () => void;
    replace: <T extends {}>(tableName: string, rec: T) => number | null;
    transactional: <T>(
        func: (statement: Statement<unknown[], unknown>) => T,
    ) => any;
    upsert: <T extends {}>(
        tableName: string,
        primaryKey: string,
        rec: T,
    ) => void;
}

Type declaration

  • copyDatabase: (targetFilePath: string) => Promise<void>
  • dbConnection: Database
  • disableSlowQueryLogging: <T>(cb: () => T) => T
  • execute: (query: string, params?: any) => RunResult

    Execute SQL

    -

    Method

  • executeMany: (query: string, params: any) => void
  • executeScript: (query: string) => DatabaseType
  • fillParamList: (paramIds: string[] | Set<string>, truncate?: boolean) => void
  • getColumn: <T>(query: string, params?: any) => T[]

    Get a first column in an array.

    -

    Method

  • getManyRows: <T>(query: string, params: any) => T[]
  • getMap: <K extends string | number | symbol, V>(
        query: string,
        params?: any,
    ) => Record<K, V>

    Get a map of first column mapping to second column.

    -

    Method

  • getRawRows: <T extends {} | unknown[]>(query: string, params?: any) => T[]
  • getRow: <T>(query: string, params?: any) => T

    Get first returned row.

    -

    Method

  • getRowOrNull: <T>(query: string, params?: any) => T | null
  • getRows: <T>(query: string, params?: any) => T[]

    Get all returned rows.

    -

    Method

  • getValue: <T>(query: string, params?: any) => T

    Get single value from the given query - first column from first returned row.

    -

    Method

  • insert: <T extends {}>(
        tableName: string,
        rec: T,
        replace?: boolean,
    ) => undefined | null | number | bigint
  • iterateRows: <T>(query: string, params?: any) => IterableIterator<T>
  • rebuildIntegrationTestDatabase: () => void
  • replace: <T extends {}>(tableName: string, rec: T) => number | null
  • transactional: <T>(func: (statement: Statement<unknown[], unknown>) => T) => any
  • upsert: <T extends {}>(tableName: string, primaryKey: string, rec: T) => void

Settings

Member Visibility
+
  • executeMany: (query: string, params: any) => void
  • executeScript: (query: string) => DatabaseType
  • fillParamList: (paramIds: string[] | Set<string>, truncate?: boolean) => void
  • getColumn: <T>(query: string, params?: any) => T[]

    Get a first column in an array.

    +
  • getManyRows: <T>(query: string, params: any) => T[]
  • getMap: <K extends string | number | symbol, V>(
        query: string,
        params?: any,
    ) => Record<K, V>

    Get a map of first column mapping to second column.

    +
  • getRawRows: <T extends {} | unknown[]>(query: string, params?: any) => T[]
  • getRow: <T>(query: string, params?: any) => T

    Get first returned row.

    +
  • getRowOrNull: <T>(query: string, params?: any) => T | null
  • getRows: <T>(query: string, params?: any) => T[]

    Get all returned rows.

    +
  • getValue: <T>(query: string, params?: any) => T

    Get single value from the given query - first column from first returned row.

    +
  • insert: <T extends {}>(
        tableName: string,
        rec: T,
        replace?: boolean,
    ) => undefined | null | number | bigint
  • iterateRows: <T>(query: string, params?: any) => IterableIterator<T>
  • rebuildIntegrationTestDatabase: () => void
  • replace: <T extends {}>(tableName: string, rec: T) => number | null
  • transactional: <T>(func: (statement: Statement<unknown[], unknown>) => T) => any
  • upsert: <T extends {}>(tableName: string, primaryKey: string, rec: T) => void

    • Settings

    Member Visibility
    diff --git a/src/services/sql.ts b/src/services/sql.ts index 0f1cf5ea4..d2b14c669 100644 --- a/src/services/sql.ts +++ b/src/services/sql.ts @@ -347,7 +347,6 @@ export default { /** * Get single value from the given query - first column from first returned row. * - * @method * @param query - SQL query with ? used as parameter placeholder * @param params - array of params if needed * @returns single value @@ -357,7 +356,6 @@ export default { /** * Get first returned row. * - * @method * @param query - SQL query with ? used as parameter placeholder * @param params - array of params if needed * @returns - map of column name to column value @@ -368,7 +366,6 @@ export default { /** * Get all returned rows. * - * @method * @param query - SQL query with ? used as parameter placeholder * @param params - array of params if needed * @returns - array of all rows, each row is a map of column name to column value @@ -381,7 +378,6 @@ export default { /** * Get a map of first column mapping to second column. * - * @method * @param query - SQL query with ? used as parameter placeholder * @param params - array of params if needed * @returns - map of first column to second column @@ -391,7 +387,6 @@ export default { /** * Get a first column in an array. * - * @method * @param query - SQL query with ? used as parameter placeholder * @param params - array of params if needed * @returns array of first column of all returned rows @@ -401,7 +396,6 @@ export default { /** * Execute SQL * - * @method * @param query - SQL query with ? used as parameter placeholder * @param params - array of params if needed */