CapacitorAdapter
Defined in: obsidian.d.ts:583
Implementation of the vault adapter for mobile devices.
Extends
Implements
Constructors
new CapacitorAdapter()
new CapacitorAdapter():
CapacitorAdapter
Returns
Properties
basePath
basePath:
string
Defined in: src/obsidian/augmentations/DataAdapter.d.ts:13
Base OS path for the vault (e.g. /home/user/vault, or C:\Users\user\documents\vault)
Implementation of
Inherited from
files
files:
DataAdapterFilesRecord
Defined in: src/obsidian/augmentations/DataAdapter.d.ts:17
Mapping of file/folder path to vault entry, includes non-MD files
Implementation of
Inherited from
fs
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:9
promise
promise:
Promise
<unknown
>
Defined in: src/obsidian/internals/PromisedQueue.d.ts:3
Implementation of
Inherited from
Methods
_exists()
_exists(
fullPath
,sensitive
?):Promise
<boolean
>
Defined in: src/obsidian/augmentations/DataAdapter.d.ts:32
Check if a file exists.
Parameters
fullPath
string
Full path to the file.
sensitive?
boolean
Whether to check case-sensitive.
Returns
Promise
<boolean
>
A promise that resolves to true
if the file exists, false
otherwise.
Implementation of
Inherited from
append()
append(
normalizedPath
,data
,options
?):Promise
<void
>
Defined in: obsidian.d.ts:625
Parameters
normalizedPath
string
data
string
options?
Returns
Promise
<void
>
Implementation of
Inherited from
copy()
copy(
normalizedPath
,normalizedNewPath
):Promise
<void
>
Defined in: obsidian.d.ts:647
Parameters
normalizedPath
string
normalizedNewPath
string
Returns
Promise
<void
>
Implementation of
Inherited from
exists()
exists(
normalizedPath
,sensitive
?):Promise
<boolean
>
Defined in: obsidian.d.ts:651
Parameters
normalizedPath
string
sensitive?
boolean
Returns
Promise
<boolean
>
Implementation of
Inherited from
getFullPath()
getFullPath(
normalizedPath
):string
Defined in: obsidian.d.ts:665
Parameters
normalizedPath
string
Returns
string
Implementation of
Inherited from
getFullRealPath()
getFullRealPath(
normalizedPath
):string
Defined in: src/obsidian/augmentations/DataAdapter.d.ts:46
Get canonical full path of file.
Parameters
normalizedPath
string
Normalized path to file.
Returns
string
String full path to file.
Implementation of
Inherited from
getName()
getName():
string
Defined in: obsidian.d.ts:588
Returns
string
Implementation of
Inherited from
getNativePath()
getNativePath(
normalizedPath
):string
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:11
Parameters
normalizedPath
string
Returns
string
getRealPath()
getRealPath(
path
):string
Defined in: src/obsidian/augmentations/DataAdapter.d.ts:55
Get normalized path. For vault-relative path, it’s normalized vault-relative path. For absolute path, it’s path as is.
Parameters
path
string
Path to file.
Returns
string
Normalized path.
Implementation of
Inherited from
getResourcePath()
getResourcePath(
normalizedPath
):string
Defined in: obsidian.d.ts:633
Parameters
normalizedPath
string
Returns
string
Implementation of
Inherited from
list()
list(
normalizedPath
):Promise
<ListedFiles
>
Defined in: obsidian.d.ts:660
Parameters
normalizedPath
string
Returns
Implementation of
Inherited from
mkdir()
mkdir(
normalizedPath
):Promise
<void
>
Defined in: obsidian.d.ts:593
Parameters
normalizedPath
string
Returns
Promise
<void
>
Implementation of
Inherited from
open()
open(
normalizedPath
):Promise
<void
>
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:18
Parameters
normalizedPath
string
Returns
Promise
<void
>
process()
process(
normalizedPath
,fn
,options
?):Promise
<string
>
Defined in: obsidian.d.ts:629
Parameters
normalizedPath
string
fn
(data
) => string
options?
Returns
Promise
<string
>
Implementation of
Inherited from
queue()
queue<
T
>(fn
):Promise
<T
>
Defined in: src/obsidian/internals/PromisedQueue.d.ts:5
Type Parameters
• T
Parameters
fn
() => T
| Promise
<T
>
Returns
Promise
<T
>
Implementation of
Inherited from
quickList()
quickList(
normalizedFolderPath
,fileEntry
):void
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:19
Parameters
normalizedFolderPath
string
fileEntry
Returns
void
read()
read(
normalizedPath
):Promise
<string
>
Defined in: obsidian.d.ts:609
Parameters
normalizedPath
string
Returns
Promise
<string
>
Implementation of
Inherited from
readBinary()
readBinary(
normalizedPath
):Promise
<ArrayBuffer
>
Defined in: obsidian.d.ts:613
Parameters
normalizedPath
string
Returns
Implementation of
Inherited from
reconcileFileChanged()
reconcileFileChanged(
realFilePath
,normalizedPath
,fileEntry
):void
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:20
Parameters
realFilePath
string
normalizedPath
string
fileEntry
Returns
void
reconcileFileCreation()
reconcileFileCreation(
normalizedPath
,normalizedNewPath
,fileEntry
):Promise
<void
>
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:21
Parameters
normalizedPath
string
normalizedNewPath
string
fileEntry
Returns
Promise
<void
>
remove()
remove(
normalizedPath
):Promise
<void
>
Defined in: obsidian.d.ts:638
Parameters
normalizedPath
string
Returns
Promise
<void
>
Implementation of
Inherited from
rename()
rename(
normalizedPath
,normalizedNewPath
):Promise
<void
>
Defined in: obsidian.d.ts:643
Parameters
normalizedPath
string
normalizedNewPath
string
Returns
Promise
<void
>
Implementation of
Inherited from
rmdir()
rmdir(
normalizedPath
,recursive
):Promise
<void
>
Defined in: obsidian.d.ts:605
Parameters
normalizedPath
string
recursive
boolean
Returns
Promise
<void
>
Implementation of
Inherited from
stat()
Defined in: obsidian.d.ts:656
Parameters
normalizedPath
string
Returns
Implementation of
Inherited from
trashLocal()
trashLocal(
normalizedPath
):Promise
<void
>
Defined in: obsidian.d.ts:601
Parameters
normalizedPath
string
Returns
Promise
<void
>
Implementation of
Inherited from
trashSystem()
trashSystem(
normalizedPath
):Promise
<boolean
>
Defined in: obsidian.d.ts:597
Parameters
normalizedPath
string
Returns
Promise
<boolean
>
Implementation of
Inherited from
watchAndList()
watchAndList():
Promise
<void
>
Defined in: src/obsidian/augmentations/CapacitorAdapter.d.ts:30
Returns
Promise
<void
>
write()
write(
normalizedPath
,data
,options
?):Promise
<void
>
Defined in: obsidian.d.ts:617
Parameters
normalizedPath
string
data
string
options?
Returns
Promise
<void
>
Implementation of
Inherited from
writeBinary()
writeBinary(
normalizedPath
,data
,options
?):Promise
<void
>
Defined in: obsidian.d.ts:621
Parameters
normalizedPath
string
data
options?
Returns
Promise
<void
>