Reference

Official

Both Official Unofficial

Both Own Inherited

Base interface for items that point to a different location.

Import:

import type { Reference } from 'obsidian';

Signature:

export interface Reference

Properties

	Property	Type	Description
	displayText?	string	Display text of the link.
	link	string	Link destination.
	original	string	Contains the text as it's written in the document. Not available on Publish.

---

Links to this page:

• FrontmatterLinkCache
• isEmbedCache
• isFrontmatterLinkCache
• isLinkCache
• isReferenceCache
• iterateRefs
• MetadataCache
• PositionedReference
• ReferenceCache