cheerio library for HTML parsing and manipulation. See https://cheerio.js.org for documentation
Note containing the source code that is currently executing (in C terms, __FILE__).
Equal to startNote unless execution has moved into a descendant module note
loaded via require(). Don't confuse this with the concept of the active note in
the UI.
day.js library for date manipulation. See https://day.js.org for documentation
node-html-parser library for HTML parsing. See https://github.com/piotr-nicol/node-html-parser for documentation. This is the recommended replacement for cheerio.
OptionaloriginEntity whose event triggered this execution; undefined when the run was not
event-driven (e.g. started manually via "Execute script" or note.executeScript()).
What it holds depends on the trigger:
~runOnNoteCreation, ~runOnNoteChange, ~runOnNoteTitleChange,
~runOnNoteContentChange — the affected note (BNote);~runOnChildNoteCreation — the newly created child note;~runOnAttributeCreation, ~runOnAttributeChange — the attribute;~runOnBranchCreation, ~runOnBranchChange, ~runOnBranchDeletion — the branch;#run=backendStartup / #run=hourly / #run=daily) — the
script note itself;~searchScript) — the search note.OptionalpathCapture groups from the #customRequestHandler regex that matched this request's
URL, in order. Only present in custom request handlers.
OptionalreqExpress request object. Only present when the script runs as a custom request
handler (a note with the #customRequestHandler label invoked via /custom/...);
undefined for every other backend script.
OptionalresExpress response object — write the HTTP response here. Only present in custom
request handlers; undefined otherwise.
sql
OptionalstartNote where the script execution started — the entry point of the current script bundle
(in C terms, the file containing main()). When a script is spread across multiple code
notes (descendant code notes loaded as modules via require()), every note in the
bundle shares the same startNote, while currentNote differs per note.
Messages from api.log() are grouped under this note.
When a frontend script calls api.runOnBackend(), the frontend's startNote is
preserved here; since that note may not be resolvable on the backend, this can be null.
xml2js library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation
If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file
resolves once the backup is finished
Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and JSON MIME type. See also createNewNote() for more options.
object contains newly created entities note and branch
create new note under this parent
Optionalattributes?: AttributeRow[]Optionaljson?: booleanshould the note be JSON
object contains newly created entities note and branch
Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.
name of the boxicon to be used (e.g. "bx-time")
id of the launcher, only alphanumeric at least 6 characters long
if true, will be created in the "Visible launchers", otherwise in "Available launchers"
will activate the target note/script upon pressing, e.g. "ctrl+e"
for type "script"
for type "note"
one of
OptionalwidgetNoteId?: stringfor type "customWidget"
Create text note. See also createNewNote() for more options.
Enables the complete duplication of the specified original note and all its children into the specified parent note. The new note will be named the same as the original, with (Dup) added to the end of it.
the noteId for the original note to be duplicated
the noteId for the parent note where the duplication is to be placed.
the note and the branch of the newly created note.
If there's a branch between note and parent note, remove it. Otherwise, do nothing.
If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.
if branch is created between note and parent note, set this prefix
escaped string
Instance name identifies particular Trilium instance. It can be useful for scripts if some action needs to happen on only one specific instance.
Retrieves notes with given label name & value
attribute name
Optionalvalue: stringattribute value
Retrieves first note with given label name & value
attribute name
Optionalvalue: stringattribute value
Returns root note of the calendar.
Returns week note for given date. If such a note doesn't exist, it is created.
If the calendar does not support week notes, this method will return `null`.
in YYYY-MM-DD format
specify calendar root note, normally leave empty to use the default calendar
an existing or newly created week note, or null if the calendar does not support week notes.
Log given message to trilium logs and log pane in UI.
Accepts multiple arguments which are joined with spaces, similar to console.log.
Return randomly generated string of given length. This random string generation is NOT cryptographically secure.
of the string
random string
Executes given anonymous function on the frontend(s). Internally, this serializes the anonymous function into string and sends it to frontend(s) via WebSocket. Note that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all instances execute the given function.
script to be executed on the frontend
list of parameters to the anonymous function to be sent to frontend
no return value is provided.
Sync process can make data intermittently inconsistent. Scripts which require strong data consistency can use this function to wait for a possible sync process to finish and prevent new sync process from starting while it is running.
Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case you need to make some DB changes, you need to surround your call with api.transactional(...)
function to be executed while sync process is not running
resolves once the callback is finished (callback is awaited)
This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See https://triliumnext.github.io/Docs/Wiki/search.html for full documentation for all options
This is a powerful search method - you can search by attributes and their values, e.g.: "#dateModified =* MONTH AND #log". See https://triliumnext.github.io/Docs/Wiki/search.html for full documentation for all options
This method finds note by its noteId and prefix and either sets it to the given parentNoteId or removes the branch (if parentNoteId is not given).
This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.
Sort child notes of a given note.
OptionalfoldersFirst?: booleanOptionalreverse?: booleanOptionalsortBy?: string'title', 'dateCreated', 'dateModified' or a label name See https://triliumnext.github.io/Docs/Wiki/sorting.html for details.
Based on the value, either create or remove branch between note and parent note.
true if we want the branch to exist, false if we want it gone
if branch is created between note and parent note, set this prefix
This functions wraps code which is supposed to be running in transaction. If transaction already exists, then we'll use that transaction.
result of func callback
to unescape
unescaped string
This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.