Skip to content
Obsidian Dev Utils
v102.1.0
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Guides
Getting started
Commands
Cross-plugin APIs
Debugging
Demo Vault
Helper Functions
Modals
Plugin Helpers
Popovers
Setting Components
Styling
Testing
API reference
abort-controller
Overview
abortSignalAny
abortSignalNever
abortSignalTimeout
getSharedAbortController
getSharedAbortSignal
INFINITE_TIMEOUT
onAbort
ResettableAbortController
waitForAbort
array
Overview
filterInPlace
snapshot
unique
uniqueInPlace
array-buffer
Overview
toArrayBuffer
async
Overview
addErrorHandler
asyncFilter
asyncFilterInPlace
asyncFlatMap
asyncMap
chain
convertAsyncToSync
convertSyncToAsync
disableAsyncOperationTracking
enableAsyncOperationTracking
handleSilentError
ignoreError
invokeAsyncSafely
invokeAsyncSafelyAfterDelay
InvokeAsyncSafelyAfterDelayParams
isAsyncOperationTrackingEnabled
marksAsTerminateRetry
neverEnds
nextTickAsync
normalizePromisable
promiseAllAsyncFnsSequentially
promiseAllSequentially
PromiseResolve
queueMicrotaskAsync
requestAnimationFrameAsync
RetryOptions
retryWithTimeout
RetryWithTimeoutParams
runWithTimeout
RunWithTimeoutParams
setImmediateAsync
setTimeoutAsync
sleep
SleepParams
timeout
TimeoutContext
TimeoutParams
toArray
waitForAllAsyncOperations
async-events
Overview
AsyncEventRef
AsyncEventRefDisposable
AsyncEvents
AsyncEventsBase
AsyncEventSource
AsyncEventTrigger
CallbackArguments
EventMapBase
GenericAsyncEventSource
mixinAsyncEvents
subscribeAsyncDisposableEvent
SubscribeAsyncDisposableEventParams
beeper
Overview
Beeper
blob
Overview
blobToArrayBuffer
blobToDataUrl
blobToJpegArrayBuffer
BlobToJpegArrayBufferOptions
dataUrlToArrayBuffer
isImageFile
bytes
Overview
formatBytes
codemirror
state-field-spec
Overview
StateFieldSpec
debug
Overview
enableLibraryDebuggers
getDebugController
getDebugger
getLibDebugger
printWithStackTrace
PrintWithStackTraceParams
showInitialDebugMessage
debug-controller
Overview
DebugController
desktop-zip-extractor
Overview
extractZipArchive
ExtractZipArchiveParams
ZipExtractionFileSystem
ZipExtractionMkdirOptions
disposable
Overview
AsyncCallbackDisposable
AsyncCallbackDisposableConstructorParams
AsyncDisposableBase
AsyncDisposableEx
AsyncDisposeCallback
CallbackDisposable
CallbackDisposableConstructorParams
CombineAsyncDisposable
CombineAsyncDisposableConstructorParams
CombineDisposable
CombineDisposableConstructorParams
DisposableBase
DisposableEx
dispose
disposeAsync
DisposeCallback
DisposeErrorBehavior
DisposeOrder
isAsyncDisposable
isAsyncDisposableEx
isDisposable
isDisposableEx
MultipleDisposeBehavior
toAsyncDisposableEx
toDisposableEx
enum
Overview
getEnumKey
getEnumValue
error
Overview
ASYNC_WRAPPER_ERROR_MESSAGE
CustomStackTraceError
CustomStackTraceErrorConstructorParams
drainCollectedUnhandledAsyncErrors
emitAsyncErrorEvent
errorToString
ErrorWrapper
getStackTrace
isAsyncErrorIgnoreContextActive
printError
registerAsyncErrorEventHandler
SilentError
startAsyncErrorIgnoreContext
startCollectingUnhandledAsyncErrors
stopCollectingUnhandledAsyncErrors
throwExpression
function
Overview
cloneFunction
createFunction
GenericAsyncFunction
GenericAsyncVoidFunction
GenericFunction
GenericPromisableFunction
GenericPromisableVoidFunction
GenericVoidFunction
getFunctionExpressionString
noop
noopAsync
noopAsyncSingletonPromise
omitAsyncReturnType
omitReturnType
generated-during-build
Overview
LIBRARY_STYLES
LIBRARY_VERSION
html-element
Overview
createDivAsync
createElAsync
createFragmentAsync
createSpanAsync
createSvgAsync
ensureLoaded
getDocumentWindow
getZIndex
isElementVisibleInOffsetParent
isLoaded
onAncestorScrollOrResize
toPx
ValidatorElement
waitUntilConnected
jpeg-metadata
Overview
extractJpegMetadataSegments
injectJpegMetadataSegments
library
Overview
Library
LIBRARY_NAME
LibraryInitParams
object-utils
Overview
assignWithNonEnumerableProperties
castTo
cloneWithNonEnumerableProperties
deleteProperties
deleteProperty
extractDefaultExportInterop
FunctionHandlingMode
getAllEntries
getAllKeys
getNestedPropertyValue
getPrototypeOf
isDeepEqual
nameof
normalizeOptionalProperties
removeUndefinedProperties
setNestedPropertyValue
SetNestedPropertyValueParams
toJson
ToJsonOptions
obsidian
active-file-provider
Overview
ActiveFileProvider
AppActiveFileProvider
app
Overview
getApp
async-with-notice
Overview
retryWithTimeoutNotice
RetryWithTimeoutNoticeParams
runWithTimeoutNotice
RunWithTimeoutNoticeParams
attachment-path
Overview
AttachmentPathContext
DUMMY_PATH
getAttachmentFilePath
GetAttachmentFilePathParams
getAttachmentFolderPath
GetAttachmentFolderPathParams
getAttachmentFolderPathSyncOrNull
GetAttachmentFolderPathSyncOrNullParams
getAvailablePathForAttachments
GetAvailablePathForAttachmentsExtendedFunctionParams
GetAvailablePathForAttachmentsFunctionExtended
GetAvailablePathForAttachmentsParams
getCheckIsAttachmentUnitFolderFunction
hasOwnAttachmentFolder
HasOwnAttachmentFolderParams
isAtProperAttachmentPath
IsAtProperAttachmentPathParams
attachment-unit-folder
Overview
findAttachmentUnitFolderPath
FindAttachmentUnitFolderPathFromAppParams
FindAttachmentUnitFolderPathParams
FindAttachmentUnitFolderPathWithPredicateParams
rebasePathOntoFolder
RebasePathOntoFolderParams
backlink
Overview
renderBacklinksTable
renderDelayedBacklinks
renderDelayedBacklinksForFolder
RenderDelayedBacklinksForFolderParams
RenderDelayedBacklinksParams
bases-view-registrar
Overview
BasesViewRegistrar
BasesViewRegistrarRegisterBasesViewParams
PluginBasesViewRegistrar
callout
Overview
CalloutMode
renderCallout
RenderCalloutParams
wrapForCallout
canvas
Overview
getCanvasReferences
case-insensitive-file-index
Overview
CaseInsensitiveFileIndex
getCaseInsensitiveFileIndex
setCaseInsensitiveFileIndex
unsetCaseInsensitiveFileIndex
code-block-markdown-information
Overview
CodeBlockMarkdownInformation
code-block-reg-exp
Overview
createCodeBlockRegExp
command-handlers
abstract-file-command-handler
Overview
AbstractFileCommandHandler
AbstractFileCommandHandlerConstructorParams
AbstractFileCommandHandlerHandleAbstractFileMenuParams
AbstractFileCommandHandlerHandleAbstractFilesMenuParams
AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams
AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams
command-handler
Overview
CommandHandler
CommandHandlerConstructorParams
CommandHandlerRegistrationContext
command-handler-component
Overview
CommandHandlerComponent
CommandHandlerFactory
editor-command-handler
Overview
EditorCommandHandler
EditorCommandHandlerConstructorParams
EditorCommandHandlerEditorCheckCallbackParams
EditorCommandHandlerHandleEditorMenuParams
EditorCommandHandlerHandleViewportMenuParams
file-command-handler
Overview
FileCommandHandler
FileCommandHandlerShouldAddToFileMenuParams
FileCommandHandlerShouldAddToFilesMenuParams
folder-command-handler
Overview
FolderCommandHandler
FolderCommandHandlerShouldAddToFolderMenuParams
FolderCommandHandlerShouldAddToFoldersMenuParams
global-command-handler
Overview
GlobalCommandHandler
open-demo-vault-command-handler
Overview
OpenDemoVaultCommandHandler
OpenDemoVaultCommandHandlerConstructorParams
open-settings-command-handler
Overview
OpenSettingsCommandHandler
OpenSettingsCommandHandlerConstructorParams
unlock-active-note-command-handler
Overview
UnlockActiveNoteCommandHandler
UnlockActiveNoteCommandHandlerConstructorParams
command-registrar
Overview
CommandRegistrar
PluginCommandRegistrar
community-plugins
Overview
CommunityPluginRef
CommunityPluginSearchResult
configureCommunityPlugin
ConfigureCommunityPluginParams
ConfigureCommunityPluginResult
disableCommunityPlugin
DisableCommunityPluginParams
enableCommunityPlugin
EnableCommunityPluginParams
getCommunityPluginRepo
getLatestReleaseVersion
installCommunityPlugin
InstallCommunityPluginParams
installConfigureEnableCommunityPlugin
InstallConfigureEnableCommunityPluginParams
searchCommunityPlugins
toggleEnableCommunityPlugin
ToggleEnableCommunityPluginParams
toggleInstallCommunityPlugin
ToggleInstallCommunityPluginParams
uninstallCommunityPlugin
UninstallCommunityPluginParams
components
abort-signal-component
Overview
AbortSignalComponent
all-windows-event-component
Overview
AllWindowsEventComponent
AllWindowsEventComponentRegisterAllDocumentsDomEventParams
AllWindowsEventComponentRegisterAllWindowsDomEventParams
async-error-handler-component
Overview
AsyncErrorHandlerComponent
async-events-component
Overview
registerAsyncEvent
case-insensitive-file-index-component
Overview
CaseInsensitiveFileIndexComponent
component-ex
Overview
ComponentEx
console-debug-component
Overview
ConsoleDebugComponent
disposable-component
Overview
asDisposableComponent
embed-extensions-component
Overview
EmbedExtensionsComponent
generate-markdown-link-default-params-component
Overview
GenerateMarkdownLinkDefaultParamsComponent
GenerateMarkdownLinkDefaultParamsComponentConstructorParams
layout-ready-component
Overview
CallbackLayoutReadyComponent
LayoutReadyComponent
menu-event-registrar-component
Overview
MenuEventRegistrarComponent
monkey-around-component
Overview
around
Factories
FunctionKeys
hasPatchToken
MethodKeys
MonkeyAroundComponent
MonkeyAroundComponentRegisterFunctionPatchParams
MonkeyAroundComponentRegisterMethodPatchParams
PatchHandlerFunction
PatchHandlerParams
PostPatchHandlerFunction
PostPatchHandlerParams
notebook-navigator-menu-event-registrar-component
Overview
NotebookNavigatorMenuEventRegistrarComponent
NotebookNavigatorMenuEventRegistrarComponentConstructorParams
plugin-context-component
Overview
PluginContextComponent
plugin-gate-component
Overview
PluginConflict
PluginConflictSeverity
PluginDependency
PluginGateComponent
PluginGateComponentConstructorParams
plugin-notice-component
Overview
PluginNoticeCloseClickEvent
PluginNoticeComponent
PluginNoticeComponentDelayedNotice
PluginNoticeComponentShowNoticeAfterDelayParams
PluginNoticeComponentShowNoticeOptions
PluginNoticeHideInfo
PluginNoticeMode
plugin-settings-component
Overview
PluginSettingsComponentBase
PluginSettingsComponentBaseConstructorParams
PluginSettingsComponentBaseOnSaveSettingsParams
PluginSettingsState
ReadonlyPluginSettings
ReadonlyPluginSettingsState
SettingsValidator
plugin-settings-tab-component
Overview
PluginSettingsTabComponent
plugin-suggestion-component
Overview
PluginSuggestionComponent
PluginSuggestionComponentConstructorParams
SuggestedPluginState
pointer-position-component
Overview
PointerPositionComponent
registry-component
Overview
RegistryComponent
rename-delete-handler-component
Overview
GetRescuePathParams
RenameDeleteHandlerComponent
RenameDeleteHandlerSettings
rmdir-guard-component
Overview
NOT_EMPTY_DIRECTORY_ERROR_CODE
RmdirGuardComponent
settings-migration-component
Overview
SettingsMigrationComponent
SettingsMigrationComponentConstructorParams
syntax-highlighting-component
Overview
SyntaxHighlightingComponent
SyntaxHighlightingComponentGrammarFactoryParams
SyntaxHighlightingComponentGrammarSource
SyntaxHighlightingComponentRegisterCodeBlockLanguageParams
SyntaxHighlightingComponentRegisterPrismLanguageParams
constructors
get-dom-events-handlers-constructor
Overview
getDomEventsHandlersConstructor
css-class
Overview
CssClass
data-handler
Overview
DataHandler
PluginDataHandler
dataview
Overview
ArrayOrDataArray
CombinedPage
DataviewInlineApi
DomElementInfoWithContainer
getRenderedContainer
insertCodeBlock
InsertCodeBlockParams
PageFile
PageFiles
reloadCurrentFileCache
renderIframe
RenderIframeParams
renderPaginatedList
RenderPaginatedListParams
RenderPaginatedParams
renderPaginatedTable
RenderPaginatedTableParams
dataview-link
Overview
fixTitle
FixTitleParams
makeLinkWithPath
demo-vault-helper
Overview
bootstrapDemoVault
BootstrapDemoVaultParams
demo-vault-helper-settings
Overview
DemoVaultHelperSettings
demo-vault-naming
Overview
getDemoVaultArchiveFileName
getDemoVaultFolderName
GetDemoVaultFolderNameParams
desktop-demo-vault-opener
Overview
openDemoVault
OpenDemoVaultParams
desktop-trusted-input
Overview
clickElement
ClickElementParams
clickMouse
ClickMouseParams
hoverElement
HoverElementParams
MouseButton
moveMouse
MoveMouseParams
pressKey
PressKeyParams
typeIntoEditor
TypeIntoEditorParams
unhoverElement
UnhoverElementParams
editor
Overview
syncOpenEditorBuffersForPath
toggleEditorReadOnly
editor-extension-registrar
Overview
EditorExtensionRegistrar
PluginEditorExtensionRegistrar
editor-suggest-registrar
Overview
EditorSuggestRegistrar
PluginEditorSuggestRegistrar
events
Overview
EventRefDisposable
subscribeDisposableEvent
SubscribeDisposableEventParams
subscribeEvent
SubscribeEventParams
extensions-registrar
Overview
ExtensionsRegistrar
ExtensionsRegistrarRegisterExtensionsParams
PluginExtensionsRegistrar
file-change
Overview
applyContentChanges
ApplyContentChangesParams
applyFileChanges
ApplyFileChangesOptions
ApplyFileChangesParams
FileChange
isCanvasChange
isCanvasFileNodeChange
isCanvasTextNodeChange
isContentChange
isFrontmatterChange
isFrontmatterChangeWithOffsets
toFrontmatterChangeWithOffsets
file-manager
Overview
addAlias
AddAliasParams
deleteAlias
DeleteAliasParams
processFrontmatter
ProcessFrontmatterOptions
ProcessFrontmatterParams
waitForPendingLinkUpdates
file-system
Overview
asArrayOfFiles
asArrayOfFolders
asFile
asFileOrNull
asFolder
asFolderOrNull
BASE_FILE_EXTENSION
CANVAS_FILE_EXTENSION
checkExtension
doesExist
DoesExistParams
FileSystemType
getAbstractFile
getAbstractFileOrNull
GetAbstractFileOrNullParams
GetAbstractFileParams
getBasename
GetBasenameParams
getExtension
GetExtensionParams
getFile
getFileOrNull
GetFileOrNullParams
GetFileParams
getFileSystemType
getFolder
getFolderOrNull
GetFolderOrNullParams
GetFolderParams
getMarkdownFiles
GetMarkdownFilesParams
getOrCreateFile
getOrCreateFolder
getPath
isAbstractFile
isBaseFile
isCanvasFile
isFile
isFolder
isMarkdownFile
isNote
isTreatedAsAttachment
IsTreatedAsAttachmentParams
MARKDOWN_FILE_EXTENSION
MissingPathTreatment
PathOrAbstractFile
PathOrFile
PathOrFolder
trimMarkdownExtension
folder-note
Overview
FOLDER_NOTES_PLUGIN_ID
FolderNoteConfig
FolderNoteLocation
resolveFolderNote
resolveFolderNoteConfig
ResolveFolderNoteConfigParams
ResolveFolderNoteParams
frontmatter
Overview
CombinedFrontmatter
ObsidianFrontmatter
ObsidianPublishFrontmatter
parseFrontmatter
removeEmptyFrontmatterValues
RemoveEmptyFrontmatterValuesParams
setFrontmatter
frontmatter-link-cache-with-offsets
Overview
FrontmatterLinkCacheWithOffsets
isFrontmatterLinkCacheWithOffsets
toFrontmatterLinkCacheWithOffsets
hover-link-source-registrar
Overview
HoverLinkSourceRegistrar
HoverLinkSourceRegistrarRegisterHoverLinkSourceParams
PluginHoverLinkSourceRegistrar
html-element
Overview
appendCodeBlock
applySpellcheckMode
ApplySpellcheckModeParams
asCodeBlock
createFragmentWithCodeBlocks
i18n
custom-type-options
Overview
CustomTypeOptionsBase
CustomTypeOptionsResources
default-translations
Overview
DefaultTranslationsBase
i18n
Overview
DEFAULT_NS
initI18N
t
TranslationsMap
locales
en
Overview
en
translations-map
Overview
DEFAULT_LANGUAGE
defaultTranslationsMap
is-in-obsidian
Overview
isInObsidian
link
Overview
BacklinkConversionParams
BacklinksLike
BacklinksSnapshot
buildBacklinksSnapshot
BuildBacklinksSnapshotParams
convertLink
ConvertLinkParams
editBacklinks
EditBacklinksOptions
EditBacklinksParams
editBacklinksSnapshot
EditBacklinksSnapshotOptions
EditBacklinksSnapshotParams
editLinks
editLinksInContent
EditLinksInContentParams
EditLinksOptions
EditLinksParams
extractLinkFile
ExtractLinkFileParams
fixFrontmatterMarkdownLinks
generateMarkdownLink
GenerateMarkdownLinkParams
generateRawMarkdownLink
GenerateRawMarkdownLinkParams
getGenerateMarkdownLinkDefaultParamsFns
hasAngleBrackets
hasEmbedSyntax
hasLeadingDot
hasLeadingSlash
hasWikilinkSyntax
LinkPathStyle
LinkStyle
MutableBacklinksSnapshot
shouldResetAlias
ShouldResetAliasParams
splitSubpath
SplitSubpathResult
updateFileUrlLinksInContent
UpdateFileUrlLinksInContentParams
updateFileUrlLinksInFile
UpdateFileUrlLinksInFileParams
updateLink
UpdateLinkParams
updateLinksInContent
updateLinksInFile
UpdateLinksInFileParams
link-update-progress
Overview
LinkUpdateProgress
LinkUpdateProgressReporter
logger
Overview
invokeAsyncAndLog
InvokeAsyncAndLogParams
loop
Overview
loop
LoopBuildNoticeMessageParams
LoopParams
markdown
Overview
fullRender
FullRenderParams
markdownToHtml
MarkdownToHtmlParams
registerLinkHandlers
RegisterLinkHandlersParams
renderExternalLink
RenderExternalLinkParams
renderInternalLink
RenderInternalLinkFolderNoteOptions
RenderInternalLinkParams
markdown-code-block-processor
Overview
getCodeBlockMarkdownInfo
GetCodeBlockMarkdownInfoParams
insertAfterCodeBlock
insertBeforeCodeBlock
InsertCodeBlockParams
removeCodeBlock
RemoveCodeBlockParams
replaceCodeBlock
ReplaceCodeBlockParams
markdown-code-block-processor-registrar
Overview
MarkdownCodeBlockProcessorRegistrar
PluginMarkdownCodeBlockProcessorRegistrar
markdown-post-processor-registrar
Overview
MarkdownPostProcessorRegistrar
MarkdownPostProcessorRegistrarRegisterMarkdownPostProcessorParams
PluginMarkdownPostProcessorRegistrar
markdown-view
Overview
getFullContentHtml
menu-event-registrar
Overview
EditorMenuEventHandler
FileMenuEventHandler
FilesMenuEventHandler
MarkdownViewportMenuEventHandler
MenuEventRegistrar
metadata-cache
Overview
CachedMetadataEx
CachedMetadataExFeature
ensureMetadataCacheReady
getBacklinksForFileOrPath
getBacklinksForFileSafe
GetBacklinksForFileSafeOptions
GetBacklinksForFileSafeParams
GetBacklinksForFileSafeWrapper
getCacheSafe
GetCacheSafeOptions
getFrontmatterSafe
getLinks
GetLinksParams
isCachedMetadataEx
ParseCacheOptions
parseMetadata
ParseMetadataOptions
registerFileCacheForNonExistingFile
RegisterFileCacheForNonExistingFileParams
registerFiles
unregisterFileCacheForNonExistingFile
unregisterFiles
mobile-trusted-input
Overview
clickElement
clickMouse
hoverElement
moveMouse
pressKey
typeIntoEditor
unhoverElement
modals
alert
Overview
alert
AlertParams
confirm
Overview
confirm
ConfirmParams
minimizable-modal
Overview
MinimizableModal
MinimizableModalConstructorOptions
modal
Overview
ModalBase
ModalBaseConstructorParams
ModalParamsBase
showModal
modal-command-builder
Overview
CheckboxCommand
CommandBase
DropDownCommand
KeyboardCommand
ModalCommandBuilder
ModalCommandBuilderBuildOptions
ModalCommands
ModalCommandsHost
ModalCommandsRenderMode
ModalCommandsTarget
prompt
Overview
prompt
PromptParams
select-item
Overview
selectItem
SelectItemParams
select-option
Overview
selectOption
SelectOptionItem
SelectOptionParams
suggest-modal-command-builder
Overview
SuggestModalCommandBuilder
SuggestModalCommandBuilderBuildOptions
note-priority
Overview
filterHighestPriorityNotePaths
FilterHighestPriorityNotePathsParams
findNoPriorityWinnerReason
FindNoPriorityWinnerReasonParams
findNotePriorityRank
FindNotePriorityRankParams
NO_PRIORITY_MATCH
NoPriorityWinnerReason
pickHighestPriorityNotePath
PickHighestPriorityNotePathParams
notebook-navigator
Overview
NOTEBOOK_NAVIGATOR_MENU_SOURCE
NOTEBOOK_NAVIGATOR_PLUGIN_ID
NotebookNavigatorApi
NotebookNavigatorFileMenuContext
NotebookNavigatorFileMenuSelection
NotebookNavigatorFileMenuSelectionMode
NotebookNavigatorFolderMenuContext
NotebookNavigatorMenuContext
NotebookNavigatorMenuDispose
NotebookNavigatorMenus
resolveNotebookNavigatorApi
obsidian-protocol-handler-registrar
Overview
ObsidianProtocolHandlerRegistrar
PluginObsidianProtocolHandlerRegistrar
obsidian-settings
Overview
getNewLinkFormat
isSpellcheckEnabled
isSpellcheckEnabledForMode
NewLinkFormat
shouldUseWikilinks
SpellcheckMode
parse-link
Overview
escapeAlias
isParseLinkFrontmatterReference
isParseLinkReference
parseFrontmatterLinks
ParseFrontmatterLinksResult
parseLink
ParseLinkFrontmatterReference
ParseLinkFrontmatterReferenceWithOffsets
ParseLinkReference
ParseLinkResult
parseLinks
toParseLinkReference
ToParseLinkReferenceParams
unescapeAlias
path-settings
Overview
PathSettings
pathsValidator
pdf
Overview
printToPdf
plugin
obsidian-plugin-repo-paths
Overview
ObsidianPluginRepoPaths
plugin
Overview
PluginBase
reloadPlugin
showErrorAndDisablePlugin
plugin-api
Overview
PluginApiContract
PluginApiDeclaration
PluginApiMethodContract
PluginApiPayloadKind
PluginApiRef
PluginApiRefEventMap
PluginApiRevokedError
PluginApiUnavailabilityReason
PluginApiUnavailableError
PluginApiUnavailableErrorConstructorParams
PluginApiValidationError
PluginApiValidationErrorConstructorParams
publishPluginApi
PublishPluginApiParams
watchPluginApi
WatchPluginApiParams
WhenAvailablePluginApiOptions
plugin-context
Overview
addPluginCssClasses
initDebugController
initPluginContext
plugin-event-source
Overview
PluginEventMap
PluginEventSource
PluginEventSourceImpl
plugin-install-state
Overview
getInstalledPluginState
GetInstalledPluginStateParams
getInstalledPluginVersion
GetInstalledPluginVersionParams
installAndEnablePlugin
InstallAndEnablePluginParams
InstalledPluginState
plugin-lifecycle-events
Overview
PLUGIN_LOADED_EVENT_NAME
PLUGIN_UNLOADED_EVENT_NAME
PluginLifecycleEventName
PluginLifecycleEventPayload
triggerPluginLifecycleEvent
TriggerPluginLifecycleEventParams
plugin-settings-tab
Overview
BindOptions
BindOptionsExtended
PluginSettingsTabBase
PluginSettingsTabBaseBindExtendedParams
PluginSettingsTabBaseBindParams
PluginSettingsTabBaseConstructorParams
PluginSettingsTabBaseSettingExParams
PluginSettingsTabBaseSettingGroupExParams
SAVE_TO_FILE_CONTEXT
settings-migration-api
Overview
MigrateSettingsParams
MigrateSettingsResult
SettingsMigrationApi
plugin-cli-handler-registrar
Overview
CliHandlerRegistrar
CliHandlerRegistrarRegisterCliHandlerParams
PluginCliHandlerRegistrar
popovers
field-popover
Overview
editFieldsInPopover
EditFieldsInPopoverParams
PopoverField
popover
Overview
PopoverValueGetter
showPopover
ShowPopoverBuildParams
ShowPopoverParams
popover-anchor
Overview
createAnchorFromDocumentCenter
createAnchorFromElement
createAnchorFromPoint
createAnchorFromSelection
PopoverAnchor
queue
Overview
addToQueue
addToQueueAndWait
AddToQueueAndWaitParams
AddToQueueParams
flushQueue
react
app-context
Overview
AppContext
useApp
reference
Overview
CanvasFileNodeReference
CanvasReference
CanvasTextNodeReference
isCanvasFileNodeReference
isCanvasReference
isCanvasTextNodeReference
isReferenceInOffsetRange
OffsetRange
referenceToFileChange
sortReferences
resource-lock
Overview
isResourceLockedForPath
isResourceLockedForPathByAncestor
lockResourceForPath
LockResourceForPathParams
requestResourceUnlockForPath
ResourceLockComponent
ResourceLockComponentLockForPathParams
ResourceLockedError
ResourceLockMode
unlockResourceForPath
resource-url
Overview
relativePathToResourceUrl
RelativePathToResourceUrlParams
ribbon-icon-registrar
Overview
PluginRibbonIconRegistrar
RibbonIconRegistrar
RibbonIconRegistrarAddRibbonIconParams
setting-components
checkbox-component
Overview
CheckboxComponent
code-highlighter-component
Overview
CodeHighlighterComponent
date-component
Overview
DateComponent
date-time-component
Overview
DateTimeComponent
email-component
Overview
EmailComponent
file-component
Overview
FileComponent
month-component
Overview
IsoMonth
MonthComponent
multiple-dropdown-component
Overview
MultipleDropdownComponent
multiple-email-component
Overview
MultipleEmailComponent
multiple-file-component
Overview
MultipleFileComponent
multiple-text-component
Overview
MultipleTextComponent
number-component
Overview
NumberComponent
password-component
Overview
PasswordComponent
setting-component-wrapper
Overview
ensureWrapped
telephone-component
Overview
TelephoneComponent
text-based-component
Overview
getTextBasedComponentValue
TextBasedComponent
time-component
Overview
TimeComponent
tri-state-checkbox-component
Overview
TriStateCheckboxComponent
typed-dropdown-component
Overview
TypedDropdownComponent
typed-multiple-dropdown-component
Overview
TypedMultipleDropdownComponent
typed-range-text-component
Overview
TypedRangeTextComponent
typed-text-component
Overview
TypedTextComponent
TypedTextComponentConstructorParams
url-component
Overview
UrlComponent
validator-component
Overview
getValidatorComponent
ValidatorComponent
value-component-with-change-tracking
Overview
ValueComponentWithChangeTracking
week-component
Overview
IsoWeek
WeekComponent
setting-ex
Overview
adoptSettingEx
SettingEx
setting-group-ex
Overview
SettingGroupEx
status-bar-item-registrar
Overview
PluginStatusBarItemRegistrar
StatusBarItemRegistrar
templater
Overview
getTemplaterFunctions
GetTemplaterFunctionsParams
getTemplaterRenderTargetFile
parseTemplate
ParseTemplateParams
requireTemplaterApi
resolveTemplaterApi
TEMPLATER_PLUGIN_ID
TemplaterActiveFileProvider
TemplaterApi
TemplaterFunctionsGenerator
TemplaterRunMode
TemplaterRunningConfig
TemplaterUnavailabilityReason
TemplaterUnavailableError
trusted-input
Overview
clickElement
clickMouse
hoverElement
moveMouse
pressKey
typeIntoEditor
unhoverElement
validation
Overview
getOsAndObsidianUnsafePathCharsRegExp
getOsUnsafePathCharsRegExp
hasWindowsTrailingChars
isValidationMessageHolder
isWindowsReservedName
OBSIDIAN_UNSAFE_FILENAME_CHARS
trimWindowsTrailingChars
UNIX_UNSAFE_PATH_CHARS
ValidationMessageHolder
WINDOWS_UNSAFE_PATH_CHARS
vault
Overview
cleanupEmptyFolders
CleanupEmptyFoldersParams
ContentArguments
copySafe
CopySafeParams
createFolderSafe
CreateFolderSafeResult
createTemporaryFile
createTemporaryFolder
deleteEmptyFolder
deleteEmptyFolderHierarchy
EmptyFolderBehavior
getAbstractFilePathSafe
GetAbstractFilePathSafeParams
getAvailablePath
getFilePathSafe
getFolderPathSafe
getMarkdownFilesSorted
getNoteFilesSorted
getOrCreateAbstractFileSafe
GetOrCreateAbstractFileSafeParams
getOrCreateFileSafe
getOrCreateFolderSafe
getSafeRenamePath
GetSafeRenamePathParams
InvokeFileActionSafeResult
invokeWithFileSystemLock
InvokeWithFileSystemLockParams
isChild
isChildOrSelf
IsChildOrSelfParams
IsChildParams
isEmptyFolder
listSafe
process
ProcessOptions
ProcessParams
readSafe
renameSafe
RenameSafeParams
saveNote
trashSafe
vault-delete
Overview
deleteIfNotUsed
DeleteIfNotUsedResult
RescueStillUsedFileParams
vault-transaction
Overview
VaultTransaction
VaultTransactionConstructorParams
view-registrar
Overview
PluginViewRegistrar
ViewRegistrar
workspace
Overview
ensureLayoutReady
getAllContainers
getAllDomWindows
getMainWindow
switchToMainWindow
switchToWindow
obsidian-dev-utils-state
Overview
getObsidianDevUtilsState
resetObsidianDevUtilsState
path
Overview
basename
delimiter
dirname
extname
format
getFileName
getFolderName
isAbsolute
join
makeFileName
MakeFileNameParams
normalizeIfRelative
normalizePath
parse
posix
relative
resolve
separator
toPosixBuffer
toPosixPath
reg-exp
Overview
ALWAYS_MATCH_REG_EXP
escapeRegExp
getMandatoryNamedGroup
getOptionalNamedGroup
isValidRegExp
NEVER_MATCH_REG_EXP
oneOf
RegExpMergeFlagsConflictStrategy
script-utils
build
Overview
buildClean
buildCompile
buildCompileSvelte
buildCompileTypeScript
buildTemplates
bundlers
esbuild-impl
change-extension-plugin
Overview
changeExtensionPlugin
rewriteImportPathExtensions
copy-to-obsidian-plugins-folder-plugin
Overview
copyToObsidianPluginsFolderPlugin
CopyToObsidianPluginsFolderPluginParams
custom-esbuild-options-plugin
Overview
customEsbuildOptionsPlugin
dependency
Overview
getDependenciesToBundle
getDependenciesToSkip
fix-esm-plugin
Overview
fixEsmPlugin
fix-source-maps-plugin
Overview
fixSourceMapsPlugin
FixSourceMapsPluginParams
obsidian-plugin-builder
Overview
banner
build
BuildMode
buildObsidianPlugin
BuildObsidianPluginParams
BuildOptions
dev
invokeEsbuild
preprocess-plugin
Overview
ensureBrowserProcess
keepName
preprocessPlugin
rename-css-plugin
Overview
renameCssPlugin
svelte-wrapper-plugin
Overview
svelteWrapperPlugin
check-project-types
Overview
checkProjectTypes
CheckProjectTypesParams
ParsedTsConfig
parseTsConfig
toCanonical
cli-utils
Overview
CliTaskResult
cmdEscapeCommandLine
toCommandLine
toPosixCommandLine
wrapCliTask
code-generator
Overview
generate
commitlint-config
Overview
obsidianDevUtilsConfig
demo-vault
Overview
archivePluginDemoVault
demo-vault-app-json
Overview
buildArchivedDemoVaultAppJsonContent
BuildArchivedDemoVaultAppJsonContentParams
DEMO_VAULT_APP_JSON_SETTINGS
DemoVaultAppJson
findOwnedDemoVaultAppJsonSettings
FindOwnedDemoVaultAppJsonSettingsParams
parseDemoVaultAppJson
ParseDemoVaultAppJsonParams
demo-vault-buttons
Overview
CODE_SCRIPT_TOOLKIT_PLUGIN_ID
DemoVaultButtonResult
DemoVaultNote
formatFailures
listNotesWithButtons
registerDemoVaultButtonSuite
RegisterDemoVaultButtonSuiteOptions
demo-vault-coverage
Overview
DemoVaultAuthoringSpec
DemoVaultConfigInterfaceCoverageSpec
DemoVaultCoverageChecker
DemoVaultCoverageCheckerConstructorParams
DemoVaultCoverageCheckerFindStaleReferencesParams
DemoVaultCoverageCheckerFindUndemonstratedMembersParams
DemoVaultCoverageCheckerFindUnlinkedFeatureDocsParams
DemoVaultCoverageCheckerFindUnreachableNotesParams
DemoVaultCoverageCheckerGetExportedFunctionNamesParams
DemoVaultCoverageCheckerGetInterfaceMembersParams
DemoVaultDocsCoverageSpec
DemoVaultFunctionsCoverageSpec
DemoVaultInterfaceCoverageSpec
DemoVaultInterfaceMemberKind
DemoVaultNonTrivialGuardSpec
DemoVaultNote
InterfaceMembers
NoteLine
OpenWikilinkDirectiveRegion
registerDemoVaultCoverageSuite
RegisterDemoVaultCoverageSuiteParams
WikilinkDirectiveScan
WikilinkDirectiveScanState
env-toggle
Overview
getDisabledScriptEnvVariableName
isEnvVariableOff
loadEnvFileIfExists
exec
Overview
appendNodeOption
buildChildEnv
CommandPart
exec
ExecArgument
ExecDetailedOptions
ExecOptions
ExecResult
ExecSimpleOptions
formatters
dprint
Overview
format
FormatOptions
fs
Overview
BufferResultOptions
DirentResultOptions
readdirPosix
StringResultOptions
gate
Overview
gate
GateOptions
parseGateArguments
git
Overview
getNonIgnoredFiles
GetNonIgnoredFilesOptions
json
Overview
editJson
EditJsonOptions
EditJsonParams
editJsonSync
EditJsonSyncOptions
EditJsonSyncParams
readJson
readJsonSync
writeJson
writeJsonSync
linters
cspell
Overview
spellcheck
SpellcheckOptions
eslint
Overview
lint
LintOptions
eslint-agnostic-core-boundary
Overview
agnosticCoreBoundaryNoRestrictedImportPatterns
NoRestrictedImportPatternEntry
eslint-config
Overview
defineEslintConfigs
DefineEslintConfigsOptions
EslintConfigContext
eslint-no-restricted-syntax
Overview
noRestrictedSyntaxRuleEntries
NoRestrictedSyntaxRuleEntry
eslint-rules
manifest-description
Overview
manifestDescription
MESSAGE_ID_CONTAINS_OBSIDIAN
MESSAGE_ID_MISSING_PERIOD
MESSAGE_ID_NOT_CAPITALIZED
MESSAGE_ID_SELF_REFERENCE
MESSAGE_ID_TOO_LONG
MESSAGE_ID_TOO_SHORT
manifest-helpers
Overview
findManifestMember
getManifestObject
getManifestStringValue
getMemberKey
getStringValue
JSON_NODE_TYPE_BOOLEAN
JSON_NODE_TYPE_OBJECT
JSON_NODE_TYPE_STRING
JsonDocumentNode
JsonLiteralNode
JsonMemberNode
JsonNode
JsonObjectNode
jsonPlugin
toReportNode
UNRELEASED_VERSION
manifest-id
Overview
manifestId
MESSAGE_ID_CONTAINS_OBSIDIAN
MESSAGE_ID_ENDS_WITH_PLUGIN
MESSAGE_ID_INVALID_CHARACTERS
manifest-name
Overview
manifestName
MESSAGE_ID_CONTAINS_OBSIDIAN
MESSAGE_ID_CONTAINS_PLUGIN
MESSAGE_ID_INVALID_CHARACTERS
manifest-schema
Overview
manifestSchema
MESSAGE_ID_DISALLOWED_KEY
MESSAGE_ID_DUPLICATE_KEY
MESSAGE_ID_EMPTY_FUNDING_URL
MESSAGE_ID_INVALID_FUNDING_URL
MESSAGE_ID_INVALID_TYPE
MESSAGE_ID_MISSING_KEY
MESSAGE_ID_MUST_BE_ROOT_OBJECT
no-async-callback-to-unsafe-return
Overview
MESSAGE_ID
noAsyncCallbackToUnsafeReturn
no-over-cap-wait-in-eval-in-obsidian
Overview
MESSAGE_ID
noOverCapWaitInEvalInObsidian
no-untrusted-input-events
Overview
MESSAGE_ID
noUntrustedInputEvents
no-unused-params-members
Overview
MESSAGE_ID
noUnusedParamsMembers
no-used-underscore-variables
Overview
MESSAGE_ID
noUsedUnderscoreVariables
obsidian-dev-utils-plugin
Overview
obsidianDevUtilsPlugin
params-options-name-match
Overview
MESSAGE_ID
paramsOptionsNameMatch
prefer-noop-async
Overview
MESSAGE_ID
preferNoopAsync
readonly-params-options-result-members
Overview
MESSAGE_ID
readonlyParamsOptionsResultMembers
require-component-suffix
Overview
MESSAGE_ID_ABSTRACT_NEEDS_BASE
MESSAGE_ID_BASE_NOT_ABSTRACT
MESSAGE_ID_MISSING_SUFFIX
requireComponentSuffix
require-method-template
Overview
MESSAGE_ID_MISSING_TEMPLATE
MESSAGE_ID_MISSING_TEMPLATE_DESCRIPTION
requireMethodTemplate
require-super-call
Overview
MESSAGE_ID
requireSuperCall
rule-tester-helper
Overview
toRuleTesterModule
markdownlint
Overview
lint
LintOptions
markdownlint-cli2-config
Overview
obsidianDevUtilsConfig
markdownlint-ignores
Overview
checkIsInNodeModules
NODE_MODULES_IGNORE_GLOB
over-exposure
Overview
analyzeOverExposure
AnalyzeOverExposureParams
createLanguageServiceHost
CreateLanguageServiceHostParams
createProjectLanguageService
CreateProjectLanguageServiceParams
CurrentExposure
findOverExposure
FindOverExposureParams
formatOverExposureFindings
FormatOverExposureFindingsOptions
LIFECYCLE_ALLOWLIST
OverExposureFileSystem
OverExposureFinding
OverExposureProgress
OverExposureSkipReason
SuggestedExposure
nano-staged-config
Overview
getNanoStagedConfig
obsidianDevUtilsConfig
npm
Overview
editNpmShrinkWrapJson
EditNpmShrinkWrapJsonOptions
editPackageJson
EditPackageJsonOptions
editPackageJsonSync
EditPackageJsonSyncOptions
editPackageLockJson
EditPackageLockJsonOptions
editPackageLockJsonSync
EditPackageLockJsonSyncOptions
getNpmShrinkWrapJsonPath
getPackageJsonPath
getPackageLockJsonPath
PackageLockJson
readPackageJson
readPackageJsonSync
readPackageLockJson
readPackageLockJsonSync
writePackageJson
writePackageJsonSync
writePackageLockJson
writePackageLockJsonSync
npm-publish
Overview
publish
npm-run
Overview
npmRun
npmRunOptional
NpmRunOptionalResult
obsidian-dev-utils-repo-paths
Overview
ObsidianDevUtilsRepoPaths
package-manager
Overview
getPackageManager
getPackageManagerRunCommand
PackageManager
resolveToolCommand
ResolveToolCommandParams
root
Overview
execFromRoot
ExecFromRootOptions
getRootFolder
resolvePathFromRoot
ResolvePathFromRootParams
resolvePathFromRootSafe
ResolvePathFromRootSafeParams
toRelativeFromRoot
ToRelativeFromRootParams
test-runners
integration-test-plugin
Overview
getIntegrationTestPluginPopulate
OBSIDIAN_DEV_UTILS_INTEGRATION_TEST_PLUGIN_ID
registerIntegrationTestLibResolver
vitest
Overview
test
testCoverage
TestCoverageOptions
TestOptions
testWatch
TestWatchOptions
vitest-config
Overview
defineObsidianPluginVitestConfig
DefineObsidianPluginVitestConfigOptions
ObsidianPluginVitestConfigContext
ObsidianPluginVitestProjectConfig
validate-declarations
Overview
validateDeclarations
ValidateDeclarationsOptions
version
Overview
addGitTag
addUpdatedFilesToGit
AddUpdatedFilesToGitOptions
assertGitHubCliInstalled
assertGitInstalled
assertGitRepoClean
autolinkBareUrls
copyUpdatedManifest
DesktopReleasesJson
getNewVersion
getReleaseNotes
getVersionUpdateType
gitPush
Manifest
ParsedVersionArguments
parseVersionArguments
publishGitHubRelease
updateChangelog
UpdateChangelogOptions
updateVersion
updateVersionInFiles
UpdateVersionOptions
validate
VersionUpdateType
warnings-as-errors
Overview
installWarningsAsErrors
throwOnWarning
strict-proxy
Overview
bypassStrictProxy
strictProxy
StrictProxyPartial
string
Overview
AsyncReplacer
EMPTY
ensureEndsWith
EnsureEndsWithParams
ensureLfEndings
ensureStartsWith
EnsureStartsWithParams
escape
getLfNormalizedOffsetToOriginalOffsetMapper
hasSingleOccurrence
HasSingleOccurrenceParams
indent
IndentParams
insertAt
InsertAtParams
makeValidVariableName
normalizeString
replace
replaceAll
replaceAllAsync
ReplaceAllAsyncParams
ReplaceAllParams
ReplaceArguments
Replacer
trimEnd
TrimEndParams
trimStart
TrimStartParams
unescape
unindent
UnindentParams
transformers
date-transformer
Overview
DateTransformer
duration-transformer
Overview
DurationTransformer
group-transformer
Overview
GroupTransformer
map-transformer
Overview
MapTransformer
set-transformer
Overview
SetTransformer
skip-private-property-transformer
Overview
SkipPrivatePropertyTransformer
transformer
Overview
Transformer
two-way-map-transformer
Overview
TwoWayMapTransformer
typed-transformer
Overview
TypedTransformer
two-way-map
Overview
TwoWayMap
type
Overview
ExactKeys
ExactMembers
ExtractEventMap
MaybeReturn
PropertyValues
StringKeys
TypeAsserter
type-guards
Overview
assert
assertGenericObject
assertNever
assertNonNullable
ensureGenericObject
ensureNonNullable
GenericObject
url
Overview
encodeUrl
isFileUrl
isUrl
normalizeFileUrl
pathToFileUrl
value-provider
Overview
resolveValue
ValueProvider
value-wrapper
Overview
ValueWrapper
GitHub
Select theme
Dark
Light
Auto
GetInstalledPluginVersionParams.app
GetInstalledPluginVersionParams
› app
Type:
App
The Obsidian app instance.