TFolder
Defined in: obsidian.d.ts:4144
Extends
Constructors
new TFolder()
new TFolder():
TFolder
Returns
Inherited from
Properties
children
children:
TAbstractFile[]
Defined in: obsidian.d.ts:4148
deleted
deleted:
boolean
Defined in: src/obsidian/augmentations/TAbstractFile.d.ts:8
Whether the file or folder is being deleted
Inherited from
name
name:
string
Defined in: obsidian.d.ts:3999
Inherited from
parent
parent:
null|TFolder
Defined in: obsidian.d.ts:4003
Inherited from
path
path:
string
Defined in: obsidian.d.ts:3995
Inherited from
vault
vault:
Vault
Defined in: obsidian.d.ts:3991
Inherited from
Methods
getFileCount()
getFileCount():
number
Defined in: src/obsidian/augmentations/TFolder.d.ts:10
Gets the count of files in the folder.
Returns
number
The number of files in the folder.
getFolderCount()
getFolderCount():
number
Defined in: src/obsidian/augmentations/TFolder.d.ts:16
Gets the count of subfolders in the folder.
Returns
number
The number of subfolders in the folder.
getNewPathAfterRename()
getNewPathAfterRename(
newName):string
Defined in: src/obsidian/augmentations/TAbstractFile.d.ts:15
Gets the path after renaming the file or folder.
Parameters
newName
string
The new name of the file or folder.
Returns
string
The new path of the file or folder.
Inherited from
TAbstractFile.getNewPathAfterRename
getParentPrefix()
getParentPrefix():
string
Defined in: src/obsidian/augmentations/TFolder.d.ts:24
Returns the prefix of the folder path. If the folder is in the root ’/’, it returns an empty string. If the folder is ‘a/b/c’, it returns ‘a/b/’.
Returns
string
The prefix of the folder.
isRoot()
isRoot():
boolean
Defined in: obsidian.d.ts:4153
Returns
boolean