Class default

Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple 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)

default<default>
- default

Constructors

constructor

new default(row?: BranchRow): default
Parameters
- Optionalrow: BranchRow
Returns default
Overrides default.constructor
- Defined in becca/entities/bbranch.ts:33

Properties

`Optional`blobId

blobId?: string

`Optional`branchId

branchId?: string

`Optional`dateCreated

dateCreated?: string

`Optional`dateModified

dateModified?: string

isExpanded

isExpanded: boolean

`Optional`isProtected

isProtected?: boolean

`Optional`isSynced

isSynced?: boolean

noteId

noteId: string

notePosition

notePosition: number

parentNoteId

parentNoteId: string

prefix

prefix: null | string

utcDateCreated

utcDateCreated: string

`Optional`utcDateModified

utcDateModified?: string

Accessors

`Protected`becca

get becca(): Becca
Returns Becca
Inherited from AbstractBeccaEntity.becca
- Defined in becca/entities/abstract_becca_entity.ts:48

childNote

get childNote(): default
Returns default
- Defined in becca/entities/bbranch.ts:97

isDeleted

get isDeleted(): boolean
Returns boolean
Overrides AbstractBeccaEntity.isDeleted
- Defined in becca/entities/bbranch.ts:120

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
- Defined in becca/entities/bbranch.ts:131

parentNote

get parentNote(): undefined | default
Returns undefined | default
root branch will have undefined parent, all other branches have to have a parent note
- Defined in becca/entities/bbranch.ts:111

`Static`entityName

get entityName(): string
Returns string
- Defined in becca/entities/bbranch.ts:21

`Static`hashedProperties

get hashedProperties(): string[]
Returns string[]
- Defined in becca/entities/bbranch.ts:24

`Static`primaryKeyName

get primaryKeyName(): string
Returns string
- Defined in becca/entities/bbranch.ts:22

Methods

`Protected`_getContent

_getContent(): string | Buffer<ArrayBufferLike>
Returns string | Buffer<ArrayBufferLike>
Inherited from default._getContent
- Defined in becca/entities/abstract_becca_entity.ts:264

`Protected`_setContent

_setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void
Parameters
- content: string | Buffer<ArrayBufferLike>
- opts: ContentOpts = {}
Returns void
Inherited from default._setContent
- Defined in becca/entities/abstract_becca_entity.ts:141

beforeSaving

beforeSaving(): void
Returns void
Overrides default.beforeSaving
- Defined in becca/entities/bbranch.ts:212

createClone

createClone(parentNoteId: string, notePosition?: number): default
Parameters
- parentNoteId: string
- OptionalnotePosition: number
Returns default
- Defined in becca/entities/bbranch.ts:267

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
- Defined in becca/entities/bbranch.ts:142

generateHash

generateHash(isDeleted?: boolean): string
Parameters
- OptionalisDeleted: boolean
Returns string
Inherited from default.generateHash
- Defined in becca/entities/abstract_becca_entity.ts:64

getNote

getNote(): default
Returns default
- Defined in becca/entities/bbranch.ts:106

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;
}
Overrides default.getPojo
- Defined in becca/entities/bbranch.ts:254

`Protected`getPojoToSave

getPojoToSave(): {}
Returns {}
Inherited from default.getPojoToSave
- Defined in becca/entities/abstract_becca_entity.ts:79

getUtcDateChanged

getUtcDateChanged(): string
Returns string
Inherited from default.getUtcDateChanged
- Defined in becca/entities/abstract_becca_entity.ts:44

hasStringContent

hasStringContent(): boolean
Returns boolean
Inherited from default.hasStringContent
- Defined in becca/entities/abstract_becca_entity.ts:83

init

init(): void
Returns void
Overrides default.init
- Defined in becca/entities/bbranch.ts:68

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
Inherited from default.markAsDeleted
- Defined in becca/entities/abstract_becca_entity.ts:280

markAsDeletedSimple

markAsDeletedSimple(): void
Returns void
Inherited from default.markAsDeletedSimple
- Defined in becca/entities/abstract_becca_entity.ts:305

`Protected`putEntityChange

putEntityChange(isDeleted: boolean): void
Parameters
- isDeleted: boolean
Returns void
Inherited from default.putEntityChange
- Defined in becca/entities/abstract_becca_entity.ts:52

save

save(opts?: {}): this
Saves entity - executes SQL, but doesn't commit the transaction on its own
Parameters
- Optionalopts: {}
Returns this
Inherited from default.save
- Defined in becca/entities/abstract_becca_entity.ts:104

update

update(__namedParameters: any): default
Parameters
- __namedParameters: any
Returns default
- Defined in becca/entities/bbranch.ts:56

updateFromRow

updateFromRow(row: BranchRow): void
Parameters
- row: BranchRow
Returns void
Overrides default.updateFromRow
- Defined in becca/entities/bbranch.ts:44

Class default

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

OptionalblobId

OptionalbranchId

OptionaldateCreated

OptionaldateModified

isExpanded

OptionalisProtected

OptionalisSynced

noteId

notePosition

parentNoteId

prefix

utcDateCreated

OptionalutcDateModified

Accessors

Protectedbecca

Returns Becca

childNote

Returns default

isDeleted

Returns boolean

isWeak

Returns boolean

parentNote

Returns undefined | default

StaticentityName

Returns string

StatichashedProperties

Returns string[]

StaticprimaryKeyName

Returns string

Methods

Protected_getContent

Returns string | Buffer<ArrayBufferLike>

Protected_setContent

Parameters

Returns void

beforeSaving

Returns void

createClone

Parameters

Returns default

deleteBranch

Parameters

Returns boolean

generateHash

Parameters

Returns string

getNote

Returns default

getPojo

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

ProtectedgetPojoToSave

Returns {}

getUtcDateChanged

Returns string

hasStringContent

Returns boolean

init

Returns void

markAsDeleted

Parameters

Returns void

markAsDeletedSimple

Returns void

ProtectedputEntityChange

Parameters

Returns void

save

`Optional`blobId

`Optional`branchId

`Optional`dateCreated

`Optional`dateModified

`Optional`isProtected

`Optional`isSynced

`Optional`utcDateModified

`Protected`becca

`Static`entityName

`Static`hashedProperties

`Static`primaryKeyName

`Protected`_getContent

`Protected`_setContent

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

`Protected`getPojoToSave

`Protected`putEntityChange