Skip to content

formatFailures

Builds the assertion message for a note’s failing buttons.

The captured output is included because a button’s failure is a runtime one — the stack CodeScript Toolkit prints under it is the only diagnosis there is.

Import:

import { formatFailures } from 'obsidian-dev-utils/script-utils/demo-vault-buttons';

Signature:

function formatFailures(noteName: string, failures: readonly DemoVaultButtonResult[]): string

Parameters:

ParameterTypeDescription
noteNamestringThe note the buttons belong to.
failuresreadonly DemoVaultButtonResult[]The failing buttons.

Returns: string — The message.