VimSearchArgs

Unofficial

Both Official Unofficial

Both Own Inherited

Arguments describing how a Vim search command builds and runs its query.

Import:

import type { VimSearchArgs } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface VimSearchArgs

Properties

	Property	Type	Description
	forward?	boolean	Whether the search runs towards the end of the document.
	querySrc?	string	Where the query came from, distinguishing a prompted search from one seeded by the word under the cursor.
	toJumplist?	boolean	Whether the position the search started from is pushed onto the jump list.
	wholeWordOnly?	boolean	Whether the query only matches whole words.

---

Links to this page:

• VimSearchKeyMapping