From 02ce82eaf5133c671797ba6b3890ff10358a8d84 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Wed, 11 Dec 2024 18:47:19 +0200 Subject: [PATCH] chore(backend-docs): solve a few warnings --- ...ntities_abstract_becca_entity.default.html | 8 +- .../becca_entities_battachment.default.html | 14 +- .../becca_entities_battribute.default.html | 8 +- .../classes/becca_entities_bblob.default.html | 8 +- .../becca_entities_bbranch.default.html | 14 +- .../becca_entities_betapi_token.default.html | 8 +- .../classes/becca_entities_bnote.default.html | 144 +++++++++--------- .../becca_entities_boption.default.html | 8 +- .../becca_entities_brecent_note.default.html | 8 +- .../becca_entities_brevision.default.html | 16 +- .../becca_entities_rows.AttachmentRow.html | 4 +- .../becca_entities_rows.AttributeRow.html | 4 +- .../becca_entities_rows.BlobRow.html | 4 +- .../becca_entities_rows.BranchRow.html | 4 +- .../becca_entities_rows.EtapiTokenRow.html | 4 +- .../becca_entities_rows.NoteRow.html | 4 +- .../becca_entities_rows.OptionRow.html | 8 +- .../becca_entities_rows.RecentNoteRow.html | 4 +- .../becca_entities_rows.RevisionRow.html | 4 +- .../becca_entities_rows.AttributeType.html | 2 +- .../types/becca_entities_rows.NoteType.html | 2 +- ...ecca_entities_rows.ALLOWED_NOTE_TYPES.html | 2 +- .../services_backend_script_api.default.html | 2 +- .../variables/services_sql.default.html | 12 +- src/services/sql.ts | 6 - 25 files changed, 148 insertions(+), 154 deletions(-) diff --git a/docs/backend_api/classes/becca_entities_abstract_becca_entity.default.html b/docs/backend_api/classes/becca_entities_abstract_becca_entity.default.html index 70ae1b216..4ae0766fe 100644 --- a/docs/backend_api/classes/becca_entities_abstract_becca_entity.default.html +++ b/docs/backend_api/classes/becca_entities_abstract_becca_entity.default.html @@ -1,5 +1,5 @@ default | trilium

Class default<T>Abstract

Base class for all backend entities.

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor +

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

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

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

Methods

Protected_getContent

Protected_setContent

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

  • Parameters

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

    Returns void

ProtectedbeforeSaving

generateHash

AbstractgetPojo

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

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

Methods

Protected_getContent

Protected_setContent

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

  • Parameters

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

    Returns void

ProtectedbeforeSaving

generateHash

AbstractgetPojo

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

AbstractupdateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

AbstractupdateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/classes/becca_entities_battachment.default.html b/docs/backend_api/classes/becca_entities_battachment.default.html index 382811e3c..f4ea26a88 100644 --- a/docs/backend_api/classes/becca_entities_battachment.default.html +++ b/docs/backend_api/classes/becca_entities_battachment.default.html @@ -1,6 +1,6 @@ default | trilium

Class default

Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for larger amounts of data and generally not accessible to the user.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

attachmentId? blobId? contentLength? @@ -47,10 +47,10 @@ larger amounts of data and generally not accessible to the user.

save setContent updateFromRow -

Constructors

constructor

Properties

OptionalattachmentId

attachmentId?: string

OptionalblobId

blobId?: string

OptionalcontentLength

contentLength?: number

optionally added to the entity

-

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisDecrypted

isDecrypted?: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

mime

mime: string

OptionalnoteId

noteId?: number

ownerId

ownerId: string

either noteId or revisionId to which this attachment belongs

-

Optionalposition

position?: number

role

role: string

title

title: string

Optionaltype

type?: "file" | "image"

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

OptionalutcDateScheduledForErasureSince

utcDateScheduledForErasureSince?: null | string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

convertToNote

copy

decrypt

generateHash

getContent

getFileName

getNote

getPojo

  • getPojo(): {
        attachmentId: undefined
        | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

  • Returns {
        attachmentId: undefined | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

getPojoToSave

  • getPojoToSave(): {
        attachmentId: undefined
        | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

  • Returns {
        attachmentId: undefined | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

getTitleOrProtected

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

OptionalattachmentId

attachmentId?: string

OptionalblobId

blobId?: string

OptionalcontentLength

contentLength?: number

optionally added to the entity

+

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisDecrypted

isDecrypted?: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

mime

mime: string

OptionalnoteId

noteId?: number

ownerId

ownerId: string

either noteId or revisionId to which this attachment belongs

+

Optionalposition

position?: number

role

role: string

title

title: string

Optionaltype

type?: "file" | "image"

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

OptionalutcDateScheduledForErasureSince

utcDateScheduledForErasureSince?: null | string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

convertToNote

copy

decrypt

generateHash

getContent

getFileName

getNote

getPojo

  • getPojo(): {
        attachmentId: undefined
        | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

  • Returns {
        attachmentId: undefined | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

getPojoToSave

  • getPojoToSave(): {
        attachmentId: undefined
        | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

  • Returns {
        attachmentId: undefined | string;
        blobId: undefined | string;
        contentLength: undefined | number;
        dateModified: undefined | string;
        isDeleted: boolean;
        isProtected: boolean;
        mime: string;
        ownerId: string;
        position: undefined | number;
        role: string;
        title: undefined | string;
        utcDateModified: undefined | string;
        utcDateScheduledForErasureSince: undefined | null | string;
    }

getTitleOrProtected

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>
    • Optionalopts: ContentOpts

    Returns void

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

setContent

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/classes/becca_entities_battribute.default.html b/docs/backend_api/classes/becca_entities_battribute.default.html index a34359a10..f5d75b8f6 100644 --- a/docs/backend_api/classes/becca_entities_battribute.default.html +++ b/docs/backend_api/classes/becca_entities_battribute.default.html @@ -1,6 +1,6 @@ default | trilium

Class default

Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

attributeId blobId? dateCreated? @@ -47,7 +47,7 @@ and relation (representing named relationship between source and target note)

update updateFromRow validate -

Constructors

constructor

Properties

attributeId

attributeId: string

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

isInheritable

isInheritable: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

name

name: string

noteId

noteId: string

position

position: number

type

type: AttributeType

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

value

value: string

Accessors

Protectedbecca

isAffectingSubtree

isDeleted

note

targetNote

targetNoteId

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

createClone

generateHash

getDefinedName

getDefinition

getNote

getPojo

  • getPojo(): {
        attributeId: string;
        isDeleted: boolean;
        isInheritable: boolean;
        name: string;
        noteId: string;
        position: number;
        type: AttributeType;
        utcDateModified: undefined
        | string;
        value: string;
    }

  • Returns {
        attributeId: string;
        isDeleted: boolean;
        isInheritable: boolean;
        name: string;
        noteId: string;
        position: number;
        type: AttributeType;
        utcDateModified: undefined | string;
        value: string;
    }

ProtectedgetPojoToSave

getTargetNote

getUtcDateChanged

hasStringContent

init

isAutoLink

isDefinition

markAsDeleted

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

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

    +

Constructors

constructor

Properties

attributeId

attributeId: string

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

isInheritable

isInheritable: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

name

name: string

noteId

noteId: string

position

position: number

type

type: AttributeType

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

value

value: string

Accessors

Protectedbecca

isAffectingSubtree

isDeleted

note

targetNote

targetNoteId

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

createClone

generateHash

getDefinedName

getDefinition

getNote

getPojo

  • getPojo(): {
        attributeId: string;
        isDeleted: boolean;
        isInheritable: boolean;
        name: string;
        noteId: string;
        position: number;
        type: AttributeType;
        utcDateModified: undefined
        | string;
        value: string;
    }

  • Returns {
        attributeId: string;
        isDeleted: boolean;
        isInheritable: boolean;
        name: string;
        noteId: string;
        position: number;
        type: AttributeType;
        utcDateModified: undefined | string;
        value: string;
    }

ProtectedgetPojoToSave

getTargetNote

getUtcDateChanged

hasStringContent

init

isAutoLink

isDefinition

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

update

updateFromRow

validate

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

update

updateFromRow

validate

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/classes/becca_entities_bblob.default.html b/docs/backend_api/classes/becca_entities_bblob.default.html index 2f692516b..beb757b33 100644 --- a/docs/backend_api/classes/becca_entities_bblob.default.html +++ b/docs/backend_api/classes/becca_entities_bblob.default.html @@ -1,5 +1,5 @@ default | trilium

Class default

Base class for all backend entities.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

blobId? content contentLength @@ -28,7 +28,7 @@ putEntityChange save updateFromRow -

Constructors

constructor

Properties

OptionalblobId

blobId?: string

content

content: string | Buffer<ArrayBufferLike>

contentLength

contentLength: number

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

ProtectedbeforeSaving

generateHash

getPojo

  • getPojo(): {
        blobId: undefined
        | string;
        content: null | string | Buffer<ArrayBufferLike>;
        contentLength: number;
        dateModified: undefined | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        blobId: undefined | string;
        content: null | string | Buffer<ArrayBufferLike>;
        contentLength: number;
        dateModified: undefined | string;
        utcDateModified: undefined | 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

content

content: string | Buffer<ArrayBufferLike>

contentLength

contentLength: number

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

ProtectedbeforeSaving

generateHash

getPojo

  • getPojo(): {
        blobId: undefined
        | string;
        content: null | string | Buffer<ArrayBufferLike>;
        contentLength: number;
        dateModified: undefined | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        blobId: undefined | string;
        content: null | string | Buffer<ArrayBufferLike>;
        contentLength: number;
        dateModified: undefined | string;
        utcDateModified: undefined | 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

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_bbranch.default.html b/docs/backend_api/classes/becca_entities_bbranch.default.html index 6f6aa797e..dedfb0639 100644 --- a/docs/backend_api/classes/becca_entities_bbranch.default.html +++ b/docs/backend_api/classes/becca_entities_bbranch.default.html @@ -2,7 +2,7 @@ parents.

Note that you should not rely on the branch's identity, since it can change easily with a note's move. Always check noteId instead.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

blobId? branchId? dateCreated? @@ -42,16 +42,16 @@ Always check noteId instead.

save update updateFromRow -

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionalbranchId

branchId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

isExpanded

isExpanded: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

noteId

noteId: string

notePosition

notePosition: number

parentNoteId

parentNoteId: string

prefix

prefix: null | string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

childNote

isDeleted

isWeak

  • get isWeak(): boolean

  • Branch is weak when its existence should not hinder deletion of its note. +

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionalbranchId

branchId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

isExpanded

isExpanded: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

noteId

noteId: string

notePosition

notePosition: number

parentNoteId

parentNoteId: string

prefix

prefix: null | string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

childNote

isDeleted

isWeak

  • get isWeak(): boolean

  • Branch is weak when its existence should not hinder deletion of its note. As a result, note with only weak branches should be immediately deleted. An example is shared or bookmarked clones - they are created automatically and exist for technical reasons, not as user-intended actions. From user perspective, they don't count as real clones and for the purpose of deletion should not act as a clone.

    -

    Returns boolean

parentNote

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

createClone

deleteBranch

  • deleteBranch(deleteId?: string, taskContext?: TaskContext): boolean

  • Delete a branch. If this is a last note's branch, delete the note as well.

    +

    Returns boolean

parentNote

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

createClone

deleteBranch

  • deleteBranch(deleteId?: string, taskContext?: TaskContext): boolean

  • Delete a branch. If this is a last note's branch, delete the note as well.

    Parameters

    • OptionaldeleteId: string

      optional delete identified

    • OptionaltaskContext: TaskContext

    Returns boolean

    true if note has been deleted, false otherwise

    -

generateHash

getNote

getPojo

  • getPojo(): {
        branchId: undefined
        | string;
        isDeleted: boolean;
        isExpanded: boolean;
        noteId: string;
        notePosition: number;
        parentNoteId: string;
        prefix: null | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        branchId: undefined | string;
        isDeleted: boolean;
        isExpanded: boolean;
        noteId: string;
        notePosition: number;
        parentNoteId: string;
        prefix: null | string;
        utcDateModified: undefined | string;
    }

ProtectedgetPojoToSave

getUtcDateChanged

hasStringContent

init

markAsDeleted

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

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

    +

generateHash

getNote

getPojo

  • getPojo(): {
        branchId: undefined
        | string;
        isDeleted: boolean;
        isExpanded: boolean;
        noteId: string;
        notePosition: number;
        parentNoteId: string;
        prefix: null | string;
        utcDateModified: undefined | string;
    }

  • Returns {
        branchId: undefined | string;
        isDeleted: boolean;
        isExpanded: boolean;
        noteId: string;
        notePosition: number;
        parentNoteId: string;
        prefix: null | string;
        utcDateModified: undefined | 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

update

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

update

updateFromRow

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/backend_api/classes/becca_entities_betapi_token.default.html b/docs/backend_api/classes/becca_entities_betapi_token.default.html index 7811fc953..a82e30a78 100644 --- a/docs/backend_api/classes/becca_entities_betapi_token.default.html +++ b/docs/backend_api/classes/becca_entities_betapi_token.default.html @@ -6,7 +6,7 @@ Used by:

The format user is presented with is "_". This is also called "authToken" to distinguish it from tokenHash and token.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

blobId? dateCreated? dateModified? @@ -36,7 +36,7 @@ from tokenHash and token.

putEntityChange save updateFromRow -

Constructors

constructor

Properties

OptionalblobId

blobId?: string

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

OptionaletapiTokenId

etapiTokenId?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

name

name: string

tokenHash

tokenHash: string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

generateHash

getPojo

  • getPojo(): {
        etapiTokenId: undefined
        | string;
        isDeleted: boolean;
        name: string;
        tokenHash: string;
        utcDateCreated: string;
        utcDateModified: undefined | string;
    }

  • Returns {
        etapiTokenId: undefined | string;
        isDeleted: boolean;
        name: string;
        tokenHash: string;
        utcDateCreated: string;
        utcDateModified: undefined | 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

OptionaletapiTokenId

etapiTokenId?: string

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

name

name: string

tokenHash

tokenHash: string

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

Protectedbecca

isDeleted

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

Protected_getContent

Protected_setContent

beforeSaving

generateHash

getPojo

  • getPojo(): {
        etapiTokenId: undefined
        | string;
        isDeleted: boolean;
        name: string;
        tokenHash: string;
        utcDateCreated: string;
        utcDateModified: undefined | string;
    }

  • Returns {
        etapiTokenId: undefined | string;
        isDeleted: boolean;
        name: string;
        tokenHash: string;
        utcDateCreated: string;
        utcDateModified: undefined | 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

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_bnote.default.html b/docs/backend_api/classes/becca_entities_bnote.default.html index 74e685829..7d34d4eba 100644 --- a/docs/backend_api/classes/becca_entities_bnote.default.html +++ b/docs/backend_api/classes/becca_entities_bnote.default.html @@ -1,5 +1,5 @@ default | trilium

Class default

Trilium's main entity, which can represent text note, image, code note, file attachment etc.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

__flatTextCache blobId? children @@ -169,23 +169,23 @@ toggleRelation update updateFromRow -

Constructors

constructor

Properties

__flatTextCache

__flatTextCache: null | string

OptionalblobId

blobId?: string

children

children: default[]

contentAndAttachmentsAndRevisionsSize

contentAndAttachmentsAndRevisionsSize: null | number

size of the note content, attachment contents and revision contents in bytes

-

contentAndAttachmentsSize

contentAndAttachmentsSize: null | number

size of the note content, attachment contents in bytes

-

contentSize

contentSize: null | number

size of the content in bytes

-

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

isBeingDeleted

isBeingDeleted: boolean

set during the deletion operation, before it is completed (removed from becca completely).

-

isDecrypted

isDecrypted: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

mime

mime: string

noteId

noteId: string

ownedAttributes

ownedAttributes: default[]

parentBranches

parentBranches: default[]

parents

parents: default[]

revisionCount

revisionCount: null | number

number of note revisions for this note

-

targetRelations

targetRelations: default[]

title

title: string

type

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

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

attributeCount

Protectedbecca

childrenCount

dateCreatedObj

dateModifiedObj

isArchived

isDeleted

labelCount

ownedAttributeCount

ownedLabelCount

ownedRelationCount

ownedRelationCountIncludingLinks

parentCount

relationCount

relationCountIncludingLinks

targetRelationCount

targetRelationCountIncludingLinks

utcDateCreatedObj

utcDateModifiedObj

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

__validateTypeName

  • __validateTypeName(type?: null | string, name?: null | string): void

  • Parameters

    • Optionaltype: null | string
    • Optionalname: null | string

    Returns void

Protected_getContent

Protected_setContent

addAttribute

  • addAttribute(
        type: AttributeType,
        name: string,
        value?: string,
        isInheritable?: boolean,
        position?: null | number,
    ): default

  • Adds a new attribute to this note. The attribute is saved and returned. +

Constructors

constructor

Properties

__flatTextCache

__flatTextCache: null | string

OptionalblobId

blobId?: string

children

children: default[]

contentAndAttachmentsAndRevisionsSize

contentAndAttachmentsAndRevisionsSize: null | number

size of the note content, attachment contents and revision contents in bytes

+

contentAndAttachmentsSize

contentAndAttachmentsSize: null | number

size of the note content, attachment contents in bytes

+

contentSize

contentSize: null | number

size of the content in bytes

+

OptionaldateCreated

dateCreated?: string

OptionaldateModified

dateModified?: string

isBeingDeleted

isBeingDeleted: boolean

set during the deletion operation, before it is completed (removed from becca completely).

+

isDecrypted

isDecrypted: boolean

OptionalisProtected

isProtected?: boolean

OptionalisSynced

isSynced?: boolean

mime

mime: string

noteId

noteId: string

ownedAttributes

ownedAttributes: default[]

parentBranches

parentBranches: default[]

parents

parents: default[]

revisionCount

revisionCount: null | number

number of note revisions for this note

+

targetRelations

targetRelations: default[]

title

title: string

type

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

utcDateCreated

utcDateCreated: string

OptionalutcDateModified

utcDateModified?: string

Accessors

attributeCount

Protectedbecca

childrenCount

dateCreatedObj

dateModifiedObj

isArchived

isDeleted

labelCount

ownedAttributeCount

ownedLabelCount

ownedRelationCount

ownedRelationCountIncludingLinks

parentCount

relationCount

relationCountIncludingLinks

targetRelationCount

targetRelationCountIncludingLinks

utcDateCreatedObj

utcDateModifiedObj

StaticentityName

StatichashedProperties

StaticprimaryKeyName

Methods

__validateTypeName

  • __validateTypeName(type?: null | string, name?: null | string): void

  • Parameters

    • Optionaltype: null | string
    • Optionalname: null | string

    Returns void

Protected_getContent

Protected_setContent

addAttribute

  • addAttribute(
        type: AttributeType,
        name: string,
        value?: string,
        isInheritable?: boolean,
        position?: null | number,
    ): default

  • Adds a new attribute to this note. The attribute is saved and returned. See addLabel, addRelation for more specific methods.

    Parameters

    • type: AttributeType

      attribute type (label / relation)

    • name: string

      name of the attribute, not including the leading ~/#

    • value: string = ""

      value of the attribute - text for labels, target note ID for relations; optional.

      -
    • isInheritable: boolean = false
    • position: null | number = null

    Returns default

addLabel

  • addLabel(name: string, value?: string, isInheritable?: boolean): default

  • Adds a new label to this note. The label attribute is saved and returned.

    +
  • isInheritable: boolean = false
  • position: null | number = null

Returns default

addLabel

  • addLabel(name: string, value?: string, isInheritable?: boolean): default

  • Adds a new label to this note. The label attribute is saved and returned.

    Parameters

    • name: string

      name of the label, not including the leading #

    • value: string = ""

      text value of the label; optional

      -
    • isInheritable: boolean = false

    Returns default

addRelation

  • addRelation(
        name: string,
        targetNoteId: string,
        isInheritable?: boolean,
    ): default

  • Adds a new relation to this note. The relation attribute is saved and +

  • isInheritable: boolean = false

Returns default

addRelation

areAllNotePathsArchived

beforeSaving

cloneTo

convertToParentAttachment

Returns default

areAllNotePathsArchived

beforeSaving

cloneTo

convertToParentAttachment

decrypt

deleteNote

decrypt

deleteNote

eraseExcessRevisionSnapshots

generateHash

getAllNotePaths

Returns void

eraseExcessRevisionSnapshots

generateHash

getAllNotePaths

getAncestorNoteIds

getAncestors

getAttachmentById

getAttachmentByTitle

getAttachments

getAttachmentsByRole

getAttribute

getAncestorNoteIds

getAncestors

getAttachmentById

getAttachmentByTitle

getAttachments

getAttachmentsByRole

getAttribute

getAttributeCaseInsensitive

getAttributes

getAttributeCaseInsensitive

getAttributes

getAttributeValue

getAttributeValue

getBestNotePath

getBestNotePath

getBestNotePathString

getBestNotePathString

getBranches

getChildBranches

getChildNotes

getContent

getBranches

getChildBranches

getChildNotes

getContent

getDescendantNoteIds

getDistanceToAncestor

getFileName

getFlatText

getDescendantNoteIds

getDistanceToAncestor

getFileName

getFlatText

getInheritingNotes

getInheritingNotes

getJsonContent

getJsonContentSafely

getLabel

getJsonContent

getJsonContentSafely

getLabel

getLabelDefinitions

getLabels

getLabelDefinitions

getLabels

getLabelValue

getLabelValue

getLabelValues

getLabelValues

getOwnedAttribute

getOwnedAttribute

getOwnedAttributes

getOwnedAttributes

getOwnedAttributeValue

getOwnedAttributeValue

getOwnedLabel

getOwnedLabel

getOwnedLabels

getOwnedLabels

getOwnedLabelValue

getOwnedLabelValue

getOwnedLabelValues

getOwnedLabelValues

getOwnedRelation

getOwnedRelation

getOwnedRelations

getOwnedRelations

getOwnedRelationValue

getOwnedRelationValue

getParentBranches

getParentNotes

getPojo

getPojoToSave

getRelation

getParentBranches

getParentNotes

getPojo

getPojoToSave

getRelation

getRelationDefinitions

getRelations

getRelationDefinitions

getRelations

getRelationTarget

getRelationValue

getRelationTarget

getRelationValue

getRevisions

getScriptEnv

getSearchResultNotes

getSortedNotePathRecords

getStrongParentBranches

getSubtree

getSubtreeNoteIds

getSubtreeNotesIncludingTemplated

getTargetRelations

getTitleOrProtected

getUtcDateChanged

hasAncestor

hasAttribute

hasChildren

hasInheritableArchivedLabel

hasLabel

getRevisions

getScriptEnv

getSearchResultNotes

getSortedNotePathRecords

getStrongParentBranches

getSubtree

getSubtreeNoteIds

getSubtreeNotesIncludingTemplated

getTargetRelations

getTitleOrProtected

getUtcDateChanged

hasAncestor

hasAttribute

hasChildren

hasInheritableArchivedLabel

hasLabel

hasOwnedAttribute

hasOwnedAttribute

hasOwnedLabel

hasOwnedLabel

hasOwnedRelation

hasOwnedRelation

hasRelation

hasRelation

hasStringContent

init

invalidateSubTree

invalidateThisCache

isContentAvailable

isDescendantOfNote

isEligibleForConversionToAttachment

isHiddenCompletely

isHtml

isImage

isInherited

isInHiddenSubtree

isJavaScript

isJson

isLabelTruthy

hasStringContent

init

invalidateSubTree

invalidateThisCache

isContentAvailable

isDescendantOfNote

isEligibleForConversionToAttachment

isHiddenCompletely

isHtml

isImage

isInherited

isInHiddenSubtree

isJavaScript

isJson

isLabelTruthy

isLaunchBarConfig

isOptions

isRoot

isStringNote

markAsDeleted

isLaunchBarConfig

isOptions

isRoot

isStringNote

markAsDeleted

markAsDeletedSimple

ProtectedputEntityChange

removeAttribute

markAsDeletedSimple

ProtectedputEntityChange

removeAttribute

removeLabel

Returns void

removeLabel

removeRelation

Returns void

removeRelation

save

saveAttachment

save

saveAttachment

saveRevision

searchNoteInSubtree

searchNotesInSubtree

setAttribute

Returns default

saveRevision

searchNoteInSubtree

searchNotesInSubtree

setAttribute

setContent

setJsonContent

setLabel

Returns void

setContent

setJsonContent

setLabel

setRelation

Returns void

setRelation

sortChildren

sortParents

toggleAttribute

Returns void

sortChildren

sortParents

toggleAttribute

toggleLabel

Returns void

toggleLabel

toggleRelation

Returns void

toggleRelation

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

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

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 @@ It's used for seamless note versioning.

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

Returns void

markAsDeletedSimple

ProtectedputEntityChange

save

setContent

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 */