@tauri-apps/plugin-fs

Access the file system.

Security

This module prevents path traversal, not allowing absolute paths or parent dir components (i.e. “/usr/path/to/file” or “../path/to/file” paths are not allowed). Paths accessed with this API must be relative to one of the base directories so if you need access to arbitrary filesystem paths, you must write such logic on the core layer instead.

The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.

The scope configuration is an array of glob patterns describing folder paths that are allowed. For instance, this scope configuration only allows accessing files on the databases folder of the $APPDATA directory:

{
  "plugins": {
    "fs": {
      "scope": ["$APPDATA/databases/*"]
    }
  }
}

Notice the use of the $APPDATA variable. The value is injected at runtime, resolving to the app data directory.

The available variables are: $APPCONFIG, $APPDATA, $APPLOCALDATA, $APPCACHE, $APPLOG, $AUDIO, $CACHE, $CONFIG, $DATA, $LOCALDATA, $DESKTOP, $DOCUMENT, $DOWNLOAD, $EXE, $FONT, $HOME, $PICTURE, $PUBLIC, $RUNTIME, $TEMPLATE, $VIDEO, $RESOURCE, $TEMP.

Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.

Note that this scope applies to all APIs on this module.

Property	Type	Description
`fromPathBaseDir`?	`BaseDirectory`	Base directory for `fromPath`.
`toPathBaseDir`?	`BaseDirectory`	Base directory for `toPath`.

Property	Type	Description
`baseDir`?	`BaseDirectory`	Base directory for `path`
`delayMs`?	`number`	Debounce delay
`recursive`?	`boolean`	Watch a directory recursively

Property	Type	Description
`isDirectory`	`boolean`	Specifies whether this entry is a directory or not.
`isFile`	`boolean`	Specifies whether this entry is a file or not.
`isSymlink`	`boolean`	Specifies whether this entry is a symlink or not.
`name`	`string`	The name of the entry (file name with extension or directory name).

Property	Type	Description
`atime`	`null` \| `Date`	The last access time of the file. This corresponds to the `atime` field from `stat` on Unix and `ftLastAccessTime` on Windows. This may not be available on all platforms.
`birthtime`	`null` \| `Date`	The creation time of the file. This corresponds to the `birthtime` field from `stat` on Mac/BSD and `ftCreationTime` on Windows. This may not be available on all platforms.
`blksize`	`null` \| `number`	Blocksize for filesystem I/O. #### Platform-specific - Windows: Unsupported.
`blocks`	`null` \| `number`	Number of blocks allocated to the file, in 512-byte units. #### Platform-specific - Windows: Unsupported.
`dev`	`null` \| `number`	ID of the device containing the file. #### Platform-specific - Windows: Unsupported.
`fileAttributes`	`null` \| `number`	This field contains the file system attribute information for a file or directory. For possible values and their descriptions, see File Attribute Constants in the Windows Dev Center #### Platform-specific - macOS / Linux / Android / iOS: Unsupported.
`gid`	`null` \| `number`	Group ID of the owner of this file. #### Platform-specific - Windows: Unsupported.
`ino`	`null` \| `number`	Inode number. #### Platform-specific - Windows: Unsupported.
`isDirectory`	`boolean`	True if this is info for a regular directory. Mutually exclusive to `FileInfo.isFile` and `FileInfo.isSymlink`.
`isFile`	`boolean`	True if this is info for a regular file. Mutually exclusive to `FileInfo.isDirectory` and `FileInfo.isSymlink`.
`isSymlink`	`boolean`	True if this is info for a symlink. Mutually exclusive to `FileInfo.isFile` and `FileInfo.isDirectory`.
`mode`	`null` \| `number`	The underlying raw `st_mode` bits that contain the standard Unix permissions for this file/directory. #### Platform-specific - Windows: Unsupported.
`mtime`	`null` \| `Date`	The last modification time of the file. This corresponds to the `mtime` field from `stat` on Linux/Mac OS and `ftLastWriteTime` on Windows. This may not be available on all platforms.
`nlink`	`null` \| `number`	Number of hard links pointing to this file. #### Platform-specific - Windows: Unsupported.
`rdev`	`null` \| `number`	Device ID of this file. #### Platform-specific - Windows: Unsupported.
`readonly`	`boolean`	Whether this is a readonly (unwritable) file.
`size`	`number`	The size of the file, in bytes.
`uid`	`null` \| `number`	User ID of the owner of this file. #### Platform-specific - Windows: Unsupported.

Property	Type	Description
`append`?	`boolean`	Sets the option for the append mode. This option, when `true`, means that writes will append to a file instead of overwriting previous contents. Note that setting `{ write: true, append: true }` has the same effect as setting only `{ append: true }`.
`baseDir`?	`BaseDirectory`	Base directory for `path`
`create`?	`boolean`	Sets the option to allow creating a new file, if one doesn’t already exist at the specified path. Requires write or append access to be used.
`createNew`?	`boolean`	Defaults to `false`. If set to `true`, no file, directory, or symlink is allowed to exist at the target location. Requires write or append access to be used. When createNew is set to `true`, create and truncate are ignored.
`mode`?	`number`	Permissions to use if creating the file (defaults to `0o666`, before the process’s umask). Ignored on Windows.
`read`?	`boolean`	Sets the option for read access. This option, when `true`, means that the file should be read-able if opened.
`truncate`?	`boolean`	Sets the option for truncating a previous file. If a file is successfully opened with this option set it will truncate the file to `0` size if it already exists. The file must be opened with write access for truncate to work.
`write`?	`boolean`	Sets the option for write access. This option, when `true`, means that the file should be write-able if opened. If the file already exists, any write calls on it will overwrite its contents, by default without truncating it.

Property	Type	Description
`newPathBaseDir`?	`BaseDirectory`	Base directory for `newPath`.
`oldPathBaseDir`?	`BaseDirectory`	Base directory for `oldPath`.

Property	Type	Description
`append`?	`boolean`	Defaults to `false`. If set to `true`, will append to a file instead of overwriting previous contents.
`baseDir`?	`BaseDirectory`	Base directory for `path`
`create`?	`boolean`	Sets the option to allow creating a new file, if one doesn’t already exist at the specified path (defaults to `true`).
`createNew`?	`boolean`	Sets the option to create a new file, failing if it already exists.
`mode`?	`number`	File permissions. Ignored on Windows.

Parameter	Type
`fromPath`	`string` \| `URL`
`toPath`	`string` \| `URL`
`options`?	`CopyFileOptions`

Parameter	Type
`oldPath`	`string` \| `URL`
`newPath`	`string` \| `URL`
`options`	`RenameOptions`

Parameter	Type
`path`	`string` \| `URL`
`len`?	`number`
`options`?	`TruncateOptions`

Parameter	Type
`offset`	`number`
`whence`	`SeekMode`

Member	Type
`attrs`	`unknown`
`paths`	`string`[]
`type`	`WatchEventKind`

Parameter	Type
`paths`	`string` \| `URL` \| `string`[] \| `URL`[]
`cb`	(`event`) => `void`
`options`?	`DebouncedWatchOptions`

Parameter	Type
`paths`	`string` \| `URL` \| `string`[] \| `URL`[]
`cb`	(`event`) => `void`
`options`?	`WatchOptions`

Parameter	Type
`path`	`string` \| `URL`
`data`	`Uint8Array`
`options`?	`WriteFileOptions`