FileSuggestManager

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:10

Properties

app

app: App

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:14

Reference to the app

---

fileSuggestions

fileSuggestions: null | object[]

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:18

Selection of files and their paths that can be matched to

---

global

global: boolean

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:22

Whether search should be vault-wide rather than scoped to current file

---

mode

mode: string

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:26

Type of suggestions that should be provided

---

runnable

runnable: null | Runnable

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:30

Executor of the search

Methods

getBlockSuggestions()

getBlockSuggestions(runner, file, text): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:35

Get suggestions for block query

Parameters

runner

Runnable

file

TFile

text

string

Returns

Promise<SearchResult[]>

---

getDisplaySuggestions()

getDisplaySuggestions(runner, linkpath, subpath, alias): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:39

Get suggestions for display alias query

Parameters

runner

Runnable

linkpath

string

subpath

string

alias

string

Returns

Promise<SearchResult[]>

---

getFileSuggestions()

getFileSuggestions(runner, text): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:43

Get suggestions for file query

Parameters

runner

Runnable

text

string

Returns

Promise<SearchResult[]>

---

getGlobalBlockSuggestions()

getGlobalBlockSuggestions(runner, text): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:47

Get suggestions for global block query

Parameters

runner

Runnable

text

string

Returns

Promise<SearchResult[]>

---

getGlobalHeadingSuggestions()

getGlobalHeadingSuggestions(runner, text): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:51

Get suggestions for global heading query

Parameters

runner

Runnable

text

string

Returns

Promise<SearchResult[]>

---

getHeadingSuggestions()

getHeadingSuggestions(runner, file, text): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:55

Get suggestions for file heading query

Parameters

runner

Runnable

file

TFile

text

string

Returns

Promise<SearchResult[]>

---

getSourcePath()

getSourcePath(): null | string

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:61

Determine the source path of current context

Returns

null | string

---

getSuggestionsAsync()

getSuggestionsAsync(runner, text): Promise<SearchResult[]>

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:67

Get suggestions for current input text

Parameters

runner

Runnable

text

string

Returns

Promise<SearchResult[]>

Remark

Type is determined from text: e.g. [[Thi]] will give completions for files, [[Thi^]] for blocks, etc.

---

matchBlock()

matchBlock(path, file, block, sourcePath, content, text_parts): null | SearchResult

Defined in: src/obsidian/internals/FileSuggestManager.d.ts:71

Match search fragments to a block

Parameters

path

string

file

TFile

block

BlockCache

sourcePath

null | string

content

string

text_parts

string[]

Returns

null | SearchResult