Skip to content

WikilinkDirectiveScanState

The running state of a directive scan, threaded through the per-line helpers.

Import:

import type { WikilinkDirectiveScanState } from 'obsidian-dev-utils/script-utils/demo-vault-coverage';

Signature:

export interface WikilinkDirectiveScanState

Properties

PropertyTypeDescription
allowedLineIndexesSet<number>The lines a directive has allowed a wikilink on so far.
openRegionnull | OpenWikilinkDirectiveRegionThe region currently open, and whether it has covered a wikilink yet.
pendingNextLineIndexnull | numberThe line a disable-next-line was read on, while it still waits for the line it covers.
problemsstring[]The directive mistakes found so far.
wikilinkLineIndexesReadonlySet<number>The lines of the note that carry a wikilink.