Skip to content
This repository was archived by the owner on Jun 14, 2023. It is now read-only.

difference between getBasePath, getFullPath, getRealPath, getFullReal… #41

Open
ooker777 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

difference between getBasePath, getFullPath, getRealPath, getFullReal… #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions obsidian.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,7 @@ export interface DataAdapter {
*/
append(normalizedPath: string, data: string, options?: DataWriteOptions): Promise<void>;
/**
* To learn what is the different between `getBasePath`, `getFullPath`, `getRealPath`, `getFullRealPath`, visit [this forum thread](https://forum.obsidian.md/t/what-are-the-differences-between-these-adapter-methods-getbasepath-getfullpath-getrealpath-getfullrealpath/32622?u=ooker)
Copy link
Owner

@marcusolsson marcusolsson Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* To learn what is the different between `getBasePath`, `getFullPath`, `getRealPath`, `getFullRealPath`, visit [this forum thread](https://forum.obsidian.md/t/what-are-the-differences-between-these-adapter-methods-getbasepath-getfullpath-getrealpath-getfullrealpath/32622?u=ooker)
* Converts a vault-relative path to a URL that can be used to access the file from the HTML, e.g. to load as a <script> tag, <iframe>, <img>, etc. You only need it if you specifically need the browser to load it in some way.

Rather than to send the reader to another page, I think we should rewrite the insights from that topic. WDYT?

Copy link
Contributor Author

@ooker777 ooker777 Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had thought about that, but decided to referred to the page because it's quite a long text. The conversation has examples in the question to illustrate why they are confusing, and also invites other to provide their thoughts. WDYT?

* @public
*/
getResourcePath(normalizedPath: string): string;
Expand Down