obsidian-dev-utils
Version:
This is the collection of useful functions that you can use for your Obsidian plugin development
25 lines (24 loc) • 718 B
text/typescript
/**
* @packageDocumentation
*
* This module provides utility functions for working with Obsidian settings.
*/
import type { App } from 'obsidian';
/**
* A format of the new link.
*/
export type NewLinkFormat = 'absolute' | 'relative' | 'shortest';
/**
* Retrieves whether to use relative links based on the Obsidian settings.
*
* @param app - The Obsidian app instance.
* @returns Whether to use relative links.
*/
export declare function getNewLinkFormat(app: App): NewLinkFormat;
/**
* Retrieves whether to use wikilinks based on the Obsidian settings.
*
* @param app - The Obsidian app instance.
* @returns Whether to use wikilinks.
*/
export declare function shouldUseWikilinks(app: App): boolean;