ReplaceCodeBlockParams

Options for replaceCodeBlock.

Import:

import type { ReplaceCodeBlockParams } from 'obsidian-dev-utils/obsidian/markdown-code-block-processor';

Signature:

export interface ReplaceCodeBlockParams extends GetCodeBlockMarkdownInfoParams

Extends: GetCodeBlockMarkdownInfoParams

Properties

Property	Type	Description
abortSignal?	AbortSignal	An abort signal to control the execution of the function.
app	App	An Obsidian app instance. (Inherited from GetCodeBlockMarkdownInfoParams)
codeBlockProvider	ValueProvider<string, ContentArgs>	Provides a new code block.
ctx	MarkdownPostProcessorContext	A MarkdownPostProcessorContext object. (Inherited from GetCodeBlockMarkdownInfoParams)
el	HTMLElement	A HTMLElement representing the code block. (Inherited from GetCodeBlockMarkdownInfoParams)
resourceLockComponent	null | ResourceLockComponent	The resource-lock component used to lock the note while it is being modified.
shouldKeepGapWhenEmpty?	boolean	Whether to keep the gap when the new code block is empty.
shouldPreserveLinePrefix?	boolean	Whether to preserve the line prefix of the code block.
source	string	A source of the code block. (Inherited from GetCodeBlockMarkdownInfoParams)

---

Links to this page:

• replaceCodeBlock