@aidenlx/relation-resolver

Relation Resolver

Provide API to resolve relations defined in obsidian notes

How to use

Put this in relation.d.ts

import { ChangeInfo, RelationResolverAPI } from "relation-resolver";

declare module "obsidian" {
  interface MetadataCache {
    on(
      name: "relation:changed",
      callback: (info: ChangeInfo, api: RelationResolverAPI) => any,
      ctx?: any,
    ): EventRef;
    on(
      name: "relation:resolved",
      callback: (api: RelationResolverAPI) => any,
      ctx?: any,
    ): EventRef;
  }
  interface App {
    plugins: {
      plugins: {
        [id: string]: any;
        ["relation-resolver"]?: {
          api: RelationResolverAPI;
        };
      };
    };
  }
}

Compatibility

The required API feature is only available for Obsidian v0.9.12+.

Installation

From GitHub

• Download the Latest Release from the Releases section of the GitHub Repository
• Put files to your vault's plugins folder: <vault>/.obsidian/plugins/relation-resolver
• Reload Obsidian
• If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise, head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.

Note: The .obsidian folder may be hidden. On macOS, you should be able to press Command+Shift+Dot to show the folder in Finder.

From Obsidian

Not yet available

• Open Settings > Third-party plugin
• Make sure Safe mode is off
• Click Browse community plugins
• Search for this plugin
• Click Install
• Once installed, close the community plugins window and the patch is ready to use.