API reference
The complete API reference for obsidian-dev-utils, generated from the library’s TSDoc. Each module below maps to an import subpath (e.g. the string module is obsidian-dev-utils/string).
Modules
Section titled “Modules”- abort-controller
- array
- async
- async-events
- beeper
- blob
- codemirror/state-field-spec
- debug
- debug-controller
- disposable
- enum
- error
- function
- generated-during-build
- html-element
- library
- object-utils
- obsidian-dev-utils-state
- obsidian/active-file-provider
- obsidian/app
- obsidian/async-with-notice
- obsidian/attachment-path
- obsidian/backlink
- obsidian/bases-view-registrar
- obsidian/callout
- obsidian/case-insensitive-file-index
- obsidian/code-block-markdown-information
- obsidian/code-block-reg-exp
- obsidian/command-handlers/abstract-file-command-handler
- obsidian/command-handlers/command-handler
- obsidian/command-handlers/command-handler-component
- obsidian/command-handlers/editor-command-handler
- obsidian/command-handlers/file-command-handler
- obsidian/command-handlers/folder-command-handler
- obsidian/command-handlers/global-command-handler
- obsidian/command-handlers/open-demo-vault-command-handler
- obsidian/command-handlers/open-settings-command-handler
- obsidian/command-handlers/unlock-active-note-command-handler
- obsidian/command-registrar
- obsidian/community-plugins
- obsidian/components/abort-signal-component
- obsidian/components/all-windows-event-component
- obsidian/components/async-error-handler-component
- obsidian/components/async-events-component
- obsidian/components/case-insensitive-file-index-component
- obsidian/components/component-ex
- obsidian/components/console-debug-component
- obsidian/components/disposable-component
- obsidian/components/embed-extensions-component
- obsidian/components/generate-markdown-link-default-params-component
- obsidian/components/layout-ready-component
- obsidian/components/menu-event-registrar-component
- obsidian/components/monkey-around-component
- obsidian/components/plugin-context-component
- obsidian/components/plugin-notice-component
- obsidian/components/plugin-settings-component
- obsidian/components/plugin-settings-tab-component
- obsidian/components/registry-component
- obsidian/components/rename-delete-handler-component
- obsidian/constructors/get-dom-events-handlers-constructor
- obsidian/css-class
- obsidian/data-handler
- obsidian/dataview
- obsidian/dataview-link
- obsidian/demo-vault-helper
- obsidian/desktop-demo-vault-opener
- obsidian/desktop-trusted-input
- obsidian/editor
- obsidian/editor-extension-registrar
- obsidian/editor-suggest-registrar
- obsidian/events
- obsidian/extensions-registrar
- obsidian/file-change
- obsidian/file-manager
- obsidian/file-system
- obsidian/frontmatter
- obsidian/frontmatter-link-cache-with-offsets
- obsidian/hover-link-source-registrar
- obsidian/html-element
- obsidian/i18n/custom-type-options
- obsidian/i18n/default-translations
- obsidian/i18n/i18n
- obsidian/i18n/locales/en
- obsidian/i18n/locales/translations-map
- obsidian/is-in-obsidian
- obsidian/link
- obsidian/logger
- obsidian/loop
- obsidian/markdown
- obsidian/markdown-code-block-processor
- obsidian/markdown-code-block-processor-registrar
- obsidian/markdown-post-processor-registrar
- obsidian/markdown-view
- obsidian/menu-event-registrar
- obsidian/metadata-cache
- obsidian/modals/alert
- obsidian/modals/confirm
- obsidian/modals/minimizable-modal
- obsidian/modals/modal
- obsidian/modals/prompt
- obsidian/modals/select-item
- obsidian/modals/select-option
- obsidian/modals/suggest-modal-command-builder
- obsidian/obsidian-protocol-handler-registrar
- obsidian/obsidian-settings
- obsidian/parse-link
- obsidian/path-settings
- obsidian/pdf
- obsidian/plugin-cli-handler-registrar
- obsidian/plugin/obsidian-plugin-repo-paths
- obsidian/plugin/plugin
- obsidian/plugin/plugin-context
- obsidian/plugin/plugin-event-source
- obsidian/plugin/plugin-settings-tab
- obsidian/queue
- obsidian/react/app-context
- obsidian/reference
- obsidian/resource-lock
- obsidian/resource-url
- obsidian/ribbon-icon-registrar
- obsidian/setting-components/checkbox-component
- obsidian/setting-components/code-highlighter-component
- obsidian/setting-components/date-component
- obsidian/setting-components/date-time-component
- obsidian/setting-components/email-component
- obsidian/setting-components/file-component
- obsidian/setting-components/month-component
- obsidian/setting-components/multiple-dropdown-component
- obsidian/setting-components/multiple-email-component
- obsidian/setting-components/multiple-file-component
- obsidian/setting-components/multiple-text-component
- obsidian/setting-components/number-component
- obsidian/setting-components/password-component
- obsidian/setting-components/setting-component-wrapper
- obsidian/setting-components/telephone-component
- obsidian/setting-components/text-based-component
- obsidian/setting-components/time-component
- obsidian/setting-components/tri-state-checkbox-component
- obsidian/setting-components/typed-dropdown-component
- obsidian/setting-components/typed-multiple-dropdown-component
- obsidian/setting-components/typed-range-text-component
- obsidian/setting-components/typed-text-component
- obsidian/setting-components/url-component
- obsidian/setting-components/validator-component
- obsidian/setting-components/value-component-with-change-tracking
- obsidian/setting-components/week-component
- obsidian/setting-ex
- obsidian/setting-group-ex
- obsidian/status-bar-item-registrar
- obsidian/validation
- obsidian/vault
- obsidian/vault-delete
- obsidian/vault-transaction
- obsidian/view-registrar
- obsidian/workspace
- path
- reg-exp
- script-utils/build
- script-utils/bundlers/esbuild-impl/change-extension-plugin
- script-utils/bundlers/esbuild-impl/copy-to-obsidian-plugins-folder-plugin
- script-utils/bundlers/esbuild-impl/custom-esbuild-options-plugin
- script-utils/bundlers/esbuild-impl/dependency
- script-utils/bundlers/esbuild-impl/fix-esm-plugin
- script-utils/bundlers/esbuild-impl/fix-source-maps-plugin
- script-utils/bundlers/esbuild-impl/obsidian-plugin-builder
- script-utils/bundlers/esbuild-impl/preprocess-plugin
- script-utils/bundlers/esbuild-impl/rename-css-plugin
- script-utils/bundlers/esbuild-impl/svelte-wrapper-plugin
- script-utils/check-project-types
- script-utils/cli-utils
- script-utils/code-generator
- script-utils/commitlint-config
- script-utils/demo-vault
- script-utils/demo-vault-coverage
- script-utils/exec
- script-utils/formatters/dprint
- script-utils/fs
- script-utils/json
- script-utils/linters/cspell
- script-utils/linters/eslint
- script-utils/linters/eslint-agnostic-core-boundary
- script-utils/linters/eslint-config
- script-utils/linters/eslint-no-restricted-syntax
- script-utils/linters/eslint-rules/no-async-callback-to-unsafe-return
- script-utils/linters/eslint-rules/no-unused-params-members
- script-utils/linters/eslint-rules/no-used-underscore-variables
- script-utils/linters/eslint-rules/obsidian-dev-utils-plugin
- script-utils/linters/eslint-rules/params-options-name-match
- script-utils/linters/eslint-rules/prefer-noop-async
- script-utils/linters/eslint-rules/readonly-params-options-result-members
- script-utils/linters/eslint-rules/require-component-suffix
- script-utils/linters/eslint-rules/require-method-template
- script-utils/linters/eslint-rules/require-super-call
- script-utils/linters/eslint-rules/rule-tester-helper
- script-utils/linters/markdownlint
- script-utils/linters/markdownlint-cli2-config
- script-utils/linters/over-exposure
- script-utils/nano-staged-config
- script-utils/npm
- script-utils/npm-publish
- script-utils/npm-run
- script-utils/obsidian-dev-utils-repo-paths
- script-utils/root
- script-utils/test-runners/vitest
- script-utils/validate-declarations
- script-utils/version
- script-utils/warnings-as-errors
- strict-proxy
- string
- transformers/date-transformer
- transformers/duration-transformer
- transformers/group-transformer
- transformers/map-transformer
- transformers/set-transformer
- transformers/skip-private-property-transformer
- transformers/transformer
- transformers/two-way-map-transformer
- transformers/typed-transformer
- two-way-map
- type
- type-guards
- url
- value-provider
- value-wrapper