Skip to content

iterateRefs

Iterates references in order, stopping as soon as the callback returns true.

Import:

import { iterateRefs } from 'obsidian-test-mocks/obsidian';

Signature:

function iterateRefs(refs: Reference[], callback: (ref: Reference) => MaybeReturn<boolean>): boolean

Parameters:

Parameter Type Description
refs Reference[] The references to iterate.
callback (ref: Reference) => MaybeReturn<boolean> Called for each reference; returning true stops the iteration.

Returns: boolean — true when the callback returned true, false otherwise.