Lib.createNote method

Lib › createNote

Creates a note and does not return until its content is verifiably on disk, rewriting it if it is not.

Use this instead of app.vault.create in any suite that may run on Android. The emulator transport loses roughly **0.9 %** of vault.create writes (measured: 7 lost in 800 creates): the file lands **0 bytes** on disk while Obsidian's in-memory TFile.stat reports the full byte count, and it does not heal on its own. A suite doing ~34 creates per run therefore has a ~26 % chance of at least one lost write, and whichever test loses that lottery fails on a waitUntil for content that was never written — which is why it reads as an unrelated per-test flake rather than one shared cause.

Verification is by **reading the note back**, never by inspecting TFile.stat: stat is exactly the field that lies here. A rewrite through vault.modify with the same content lands correctly (also measured), so a lost write costs a retry rather than a failure. A note whose content still does not match after the bounded retries throws, naming the path and both lengths, so a genuinely broken write fails loudly instead of spinning.

Harmless everywhere else — on a transport that does not lose writes the read-back matches first time and nothing is rewritten.

Signature:

createNote(this: void, params: CreateNoteParams): Promise<TFile>

Parameters:

Parameter	Type	Description
this	void
params	CreateNoteParams	The note path and content.

Returns: Promise<TFile> — A Promise resolving to the created file, once its content is confirmed.