Trilium Backend API
    Preparing search index...

    Interface BOption

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

    interface BOption {
        blobId?: string;
        dateCreated?: string;
        dateModified?: string;
        isProtected?: boolean;
        isSynced?: boolean;
        name: string;
        utcDateCreated: string;
        utcDateModified?: string;
        value: string;
        get becca(): default;
        get isDeleted(): boolean;
        _getContent(): string | Buffer<ArrayBufferLike>;
        _setContent(
            content: string | Buffer<ArrayBufferLike>,
            opts?: ContentOpts,
        ): void;
        beforeSaving(): void;
        generateHash(isDeleted?: boolean): string;
        getPojo(): {
            isSynced: boolean;
            name: string;
            utcDateModified: string;
            value: string;
        };
        getPojoToSave(): {};
        getUtcDateChanged(): string;
        hasStringContent(): boolean;
        init(): void;
        markAsDeleted(deleteId?: string): void;
        markAsDeletedSimple(): void;
        putEntityChange(isDeleted: boolean): void;
        save(opts?: {}): this;
        updateFromRow(row: OptionRow): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    blobId? dateCreated? dateModified? isProtected? isSynced? name utcDateCreated utcDateModified? value

    Accessors

    becca isDeleted

    Methods

    _getContent _setContent beforeSaving generateHash getPojo getPojoToSave getUtcDateChanged hasStringContent init markAsDeleted markAsDeletedSimple putEntityChange save updateFromRow

    Properties

    blobId?: string
    dateCreated?: string
    dateModified?: string
    isProtected?: boolean
    isSynced?: boolean
    name: string
    utcDateCreated: string
    utcDateModified?: string
    value: string

    Accessors

    • get becca(): default

      Returns default

    • get isDeleted(): boolean

      Returns boolean

    Methods

    Protected_getContent

    Protected_setContent

    • Parameters

      • OptionalisDeleted: boolean

      Returns string

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

    • Returns 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

      • OptionaldeleteId: string

      Returns void

    • Parameters

      • isDeleted: boolean

      Returns void

    • Saves entity - executes SQL, but doesn't commit the transaction on its own

      Parameters

      • Optionalopts: {}

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods