Skip to content

Docs: Add info about file fields #967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs: Add info about file fields #967

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4049734
Docs: Add file fields
liamcain Sep 26, 2025
f98a2e0
Add ctime and mtime
liamcain Sep 26, 2025
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
18 changes: 18 additions & 0 deletions en/Plugins/Bases/Functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,24 @@ Functions you can use on a link. Links can be created from a file (`file.asLink(

Functions you can use with file in the vault.

### Fields

The following fields are available for files:

| Field | Type | Description |
| ----------------- | -------- | ------------------------------------------------------- |
| `file.name` | `string` | The name of this file. |
| `file.basename` | `string` | The name of this file without the file extension. |
| `file.path` | `string` | The full path to this file, relative to the vault root. |
| `file.folder` | `string` | The full path to the parent folder. |
| `file.ext` | `string` | The file extension for this file. |
| `file.size` | `number` | The size of this file, in bytes. |
| `file.properties` | `object` | The note properties for this file. |
| `file.tags` | `list` | The tags for this file. Includes inline tags. |
| `file.links` | `list` | The internal links within this file. |
| `file.ctime` | `date` | Timestamp of when this file was created. |
| `file.mtime` | `date` | Timestamp of when this file was last modified. |

### `asLink()`

`file.asLink(display?: string): Link`
Expand Down