Class BRevision

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)

AbstractBeccaEntity<BRevision>
- BRevision

Constructors

constructor

new BRevision(row: RevisionRow, titleDecrypted?: boolean): BRevision
Parameters
- row: RevisionRow
- titleDecrypted: boolean = false
Returns BRevision
Overrides AbstractBeccaEntity.constructor
- Defined in src/becca/entities/brevision.ts:47

Properties

`Optional`blobId

blobId?: string

`Optional`content

content?: string | Buffer<ArrayBufferLike>

`Optional`contentLength

contentLength?: number

`Optional`dateCreated

dateCreated?: string

`Optional`dateLastEdited

dateLastEdited?: string

`Optional`dateModified

dateModified?: string

`Optional`isProtected

isProtected?: boolean

`Optional`isSynced

isSynced?: boolean

mime

mime: string

noteId

noteId: string

`Optional`revisionId

revisionId?: string

title

title: string

type

utcDateCreated

utcDateCreated: string

`Optional`utcDateLastEdited

utcDateLastEdited?: string

`Optional`utcDateModified

utcDateModified?: string

Accessors

`Protected`becca

get becca(): default
Returns default
Inherited from AbstractBeccaEntity.becca
- Defined in src/becca/entities/abstract_becca_entity.ts:47

isDeleted

get isDeleted(): boolean
Returns boolean
Inherited from AbstractBeccaEntity.isDeleted
- Defined in src/becca/entities/abstract_becca_entity.ts:95

`Static`entityName

get entityName(): string
Returns string
- Defined in src/becca/entities/brevision.ts:27

`Static`hashedProperties

get hashedProperties(): string[]
Returns string[]
- Defined in src/becca/entities/brevision.ts:33

`Static`primaryKeyName

get primaryKeyName(): string
Returns string
- Defined in src/becca/entities/brevision.ts:30

Methods

`Protected`_getContent

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

`Protected`_setContent

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

beforeSaving

beforeSaving(): void
Returns void
Overrides AbstractBeccaEntity.beforeSaving
- Defined in src/becca/entities/brevision.ts:182

eraseRevision

eraseRevision(): void
Revisions are not soft-deletable, they are immediately hard-deleted (erased).

Returns void
- Defined in src/becca/entities/brevision.ts:176

generateHash

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

getAttachmentById

getAttachmentById(attachmentId: String, opts?: GetByIdOpts): null | BAttachment
Parameters
- attachmentId: String
- opts: GetByIdOpts = {}
Returns null | BAttachment
- Defined in src/becca/entities/brevision.ts:140

getAttachmentByTitle

getAttachmentByTitle(title: string): BAttachment
Parameters
- title: string
Returns BAttachment
- Defined in src/becca/entities/brevision.ts:168

getAttachments

getAttachments(): BAttachment[]
Returns BAttachment[]
- Defined in src/becca/entities/brevision.ts:127

getAttachmentsByRole

getAttachmentsByRole(role: string): BAttachment[]
Parameters
- role: string
Returns BAttachment[]
- Defined in src/becca/entities/brevision.ts:153

getContent

getContent(): string | Buffer<ArrayBufferLike>
Returns string | Buffer<ArrayBufferLike>
- Defined in src/becca/entities/brevision.ts:98

getJsonContent

getJsonContent(): null | {}
Returns null | {}
Throws
Error in case of invalid JSON
- Defined in src/becca/entities/brevision.ts:104

getJsonContentSafely

getJsonContentSafely(): null | {}
Returns null | {}
valid object or null if the content cannot be parsed as JSON
- Defined in src/becca/entities/brevision.ts:115

getNote

getNote(): BNote
Returns BNote
- Defined in src/becca/entities/brevision.ts:73

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:
        | "canvas"
        | "code"
        | "search"
        | "image"
        | "text"
        | "file"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "relationMap"
        | "render"
        | "mermaid"
        | "book"
        | "webView"
        | "mindMap"
        | "geoMap";
    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:
        | "canvas"
        | "code"
        | "search"
        | "image"
        | "text"
        | "file"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "relationMap"
        | "render"
        | "mermaid"
        | "book"
        | "webView"
        | "mindMap"
        | "geoMap";
    utcDateCreated: string;
    utcDateLastEdited: undefined
    | string;
    utcDateModified: undefined | string;
}
Overrides AbstractBeccaEntity.getPojo
- Defined in src/becca/entities/brevision.ts:188

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:
        | "canvas"
        | "code"
        | "search"
        | "image"
        | "text"
        | "file"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "relationMap"
        | "render"
        | "mermaid"
        | "book"
        | "webView"
        | "mindMap"
        | "geoMap";
    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:
        | "canvas"
        | "code"
        | "search"
        | "image"
        | "text"
        | "file"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "relationMap"
        | "render"
        | "mermaid"
        | "book"
        | "webView"
        | "mindMap"
        | "geoMap";
    utcDateCreated: string;
    utcDateLastEdited: undefined
    | string;
    utcDateModified: undefined | string;
}
Overrides AbstractBeccaEntity.getPojoToSave
- Defined in src/becca/entities/brevision.ts:207

getUtcDateChanged

getUtcDateChanged(): string
Returns string
Inherited from AbstractBeccaEntity.getUtcDateChanged
- Defined in src/becca/entities/abstract_becca_entity.ts:43

hasStringContent

hasStringContent(): boolean
Returns boolean
true if the note has string content (not binary)
Overrides AbstractBeccaEntity.hasStringContent
- Defined in src/becca/entities/brevision.ts:78

init

init(): void
Returns void
Inherited from AbstractBeccaEntity.init
- Defined in src/becca/entities/abstract_becca_entity.ts:89

isContentAvailable

isContentAvailable(): boolean
Returns boolean
- Defined in src/becca/entities/brevision.ts:82

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 AbstractBeccaEntity.markAsDeleted
- Defined in src/becca/entities/abstract_becca_entity.ts:277

markAsDeletedSimple

markAsDeletedSimple(): void
Returns void
Inherited from AbstractBeccaEntity.markAsDeletedSimple
- Defined in src/becca/entities/abstract_becca_entity.ts:303

`Protected`putEntityChange

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

save

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

setContent

setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void
Parameters
- content: string | Buffer<ArrayBufferLike>
- opts: ContentOpts = {}
Returns void
- Defined in src/becca/entities/brevision.ts:123

updateFromRow

updateFromRow(row: RevisionRow): void
Parameters
- row: RevisionRow
Returns void
Overrides AbstractBeccaEntity.updateFromRow
- Defined in src/becca/entities/brevision.ts:57

Class BRevision

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BRevision

Properties

OptionalblobId

Optionalcontent

OptionalcontentLength

OptionaldateCreated

OptionaldateLastEdited

OptionaldateModified

OptionalisProtected

OptionalisSynced

mime

noteId

OptionalrevisionId

title

type

utcDateCreated

OptionalutcDateLastEdited

OptionalutcDateModified

Accessors

Protectedbecca

Returns default

isDeleted

Returns boolean

StaticentityName

Returns string

StatichashedProperties

Returns string[]

StaticprimaryKeyName

Returns string

Methods

Protected_getContent

Returns string | Buffer<ArrayBufferLike>

Protected_setContent

Parameters

Returns void

beforeSaving

Returns void

eraseRevision

Returns void

generateHash

Parameters

Returns string

getAttachmentById

Parameters

Returns null | BAttachment

getAttachmentByTitle

Parameters

Returns BAttachment

getAttachments

Returns BAttachment[]

getAttachmentsByRole

Parameters

Returns BAttachment[]

getContent

Returns string | Buffer<ArrayBufferLike>

getJsonContent

Returns null | {}

Throws

getJsonContentSafely

Returns null | {}

getNote

Returns BNote

getPojo

getPojoToSave

getUtcDateChanged

Returns string

hasStringContent

Returns boolean

init

Returns void

`Optional`blobId

`Optional`content

`Optional`contentLength

`Optional`dateCreated

`Optional`dateLastEdited

`Optional`dateModified

`Optional`isProtected

`Optional`isSynced

`Optional`revisionId

`Optional`utcDateLastEdited

`Optional`utcDateModified

`Protected`becca

`Static`entityName

`Static`hashedProperties

`Static`primaryKeyName

`Protected`_getContent

`Protected`_setContent

`Protected`putEntityChange