Skip to content

VimOption

Unofficial

One registered Vim option.

The global registry holds the fully described option; an editor’s own copy carries only the value that overrides it.

Import:

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

Signature:

export interface VimOption

Properties

PropertyTypeDescription
callback?VimOptionCallbackInvoked to read and write the option, for options not backed by a stored value.
defaultValue?VimOptionValueThe value the option takes until it is set.
type?VimOptionTypeThe kind of value the option holds. Defaults to string when the option was defined without one.
value?VimOptionValueThe option's current value.

Links to this page: