Skip to content

defineOption

Unofficial

Registers a new editor option.

Import:

import type { defineOption } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

function defineOption(name: string, defaultValue: unknown, onUpdate: (editor: Cm5Editor, val: unknown, old: unknown) => void): void

Parameters:

ParameterTypeDescription
namestringThe option name.
defaultValueunknownThe default value for the option.
onUpdate(editor: Cm5Editor, val: unknown, old: unknown) => voidThe update handler called when the option changes.

Returns: void