Class File

Represents a file on a file system. Provides methods for reading from and writing to the file. You'll never instantiate a File directly; instead you'll get access via a storage.FileSystemProvider.

Keep in mind that File as such doesn't need a require() statement, however a localFileSystem will need it.

See

https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/File/

Example

// Get the object of a File instance
const fs = require('uxp').storage.localFileSystem;
const file = await fs.createEntryWithUrl("file:/Users/user/Documents/tmp"); // Gets a File instance
console.log(file.isFile); // returns true

Hierarchy (View Summary)

Entry
- File

Index

Constructors

constructor

new File(name: string, provider: FileSystemProvider, id: string): File
Creates an instance of Entry.
Parameters
- name: string
- provider: FileSystemProvider
- id: string
Returns File
Inherited from Entry.constructor
- Defined in internal/storage.d.ts:84

Properties

`Readonly`isEntry

isEntry: boolean

Indicates that this instance is an Entry. Useful for type-checking.

Example

if (something.isEntry) {
  return something.getMetadata();
}

`Readonly`isFile

isFile: true

Indicates that this instance is a file.

Example

if (anEntry.isFile) {
  await anEntry.read();
}

`Readonly`isFolder

isFolder: boolean

Indicates that this instance is not a folder. Useful for type-checking.

Example

if (!anEntry.isFolder) {
  return "This entry is not a folder.";
}

mode

mode: ModeSymbol

Indicates whether this file is read-only or read-write. See readOnly and readWrite.

Example

if (aFile.mode === modes.readOnly) {
  throw new Error("Can't write to a file opened as read-only.");
}

`Readonly`name

name: string

The name of this entry. Read-only.

Example

console.log(anEntry.name);

`Readonly`nativePath

nativePath: string

The platform native file-system path of this entry. Read-only

Example

console.log(anEntry.nativePath);

`Readonly`provider

provider: FileSystemProvider

The associated provider that services this entry. Read-only.

Example

if (entryOne.provider !== entryTwo.provider) {
  throw new Error("Providers are not the same");
}

`Readonly`url

url: string

The url of this entry. You can use this url as input to other entities of the extension system like for eg: set as src attribute of a Image widget in UI. Read-only.

Example

console.log(anEntry.url);

Methods

copyTo

copyTo(
folder: Folder,
options?: { allowFolderCopy?: boolean; overwrite?: boolean },
): Promise<Folder | File>
Copies this entry to the specified folder.
Parameters
- folder: Folder
  The folder to which to copy this entry.
- Optionaloptions: { allowFolderCopy?: boolean; overwrite?: boolean }
  Options for the copy operation (all properties are optional)
  - OptionalallowFolderCopy?: boolean
    If true, allows copying the folder.
  - Optionaloverwrite?: boolean
    If true, allows overwriting existing entries.
Returns Promise<Folder | File>
Throws
EntryExists If the attempt would overwrite an entry and overwrite is false.

Throws
PermissionDenied If the underlying file system rejects the attempt.

Throws
OutOfSpace If the file system is out of storage space.

See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Entry/#copytofolder-options
Example
```
await someFile.copyTo(someFolder);
```
Example
```
await someFile.copyTo(someFolder, {overwrite: true});
```
Example
```
await someFolder.copyTo(anotherFolder, {overwrite: true, allowFolderCopy: true});
```
Inherited from Entry.copyTo
- Defined in internal/storage.d.ts:117

delete

delete(): Promise<number>
Removes this entry from the file system. If the entry is a folder, all the contents will also be removed.

Note: Currently when using this method, a permission denied error will occur if attempting to delete a folder that was selected from a storage picker or added via drag-and-drop.

Returns Promise<number>
The number is 0 if succeeded, otherwise throws an Error.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Entry/#delete
Example
```
await aFile.delete();
```
Inherited from Entry.delete
- Defined in internal/storage.d.ts:194

getMetadata

getMetadata(): Promise<EntryMetadata>
Returns this entry's metadata.

Returns Promise<EntryMetadata>
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Entry/#getmetadata
Example
```
const metadata = aFile.getMetadata();
```
Inherited from Entry.getMetadata
- Defined in internal/storage.d.ts:206

moveTo

moveTo(
folder: Folder,
options?: { newName?: string; overwrite?: boolean },
): Promise<void>
Moves this entry to the target folder, optionally specifying a new name.
Parameters
- folder: Folder
  The folder to which to move this entry.
- Optionaloptions: { newName?: string; overwrite?: boolean }
  Options for the move operation (all properties are optional)
  - OptionalnewName?: string
    If specified, the entry is renamed to this name.
  - Optionaloverwrite?: boolean
    If true allows the move to overwrite existing files.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Entry/#movetofolder-options
Example
```
await someFile.moveTo(someFolder);
```
Example
```
await someFile.moveTo(someFolder, {overwrite: true});
```
Example
```
await someFolder.moveTo(anotherFolder, {overwrite: true});
```
Example
```
await someFile.moveTo(someFolder, {newName: 'masterpiece.txt'})
```
Example
```
await someFile.moveTo(someFolder, {newName: 'novel.txt', {overwrite: true})
```
Inherited from Entry.moveTo
- Defined in internal/storage.d.ts:164

read

read(options?: { format?: FormatSymbol }): Promise<string | ArrayBuffer>
Reads data from the file and returns it. The file format can be specified with the format option. If a format is not supplied, the file is assumed to be a text file using UTF8 encoding.
Parameters
- Optionaloptions: { format?: FormatSymbol }
  Options for the read operation (all properties are optional)
  - Optionalformat?: FormatSymbol
    The format of the file; see utf8 and binary.
Returns Promise<string | ArrayBuffer>
The contents of the file.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/File/#readoptions
Example
```
const text = await myNovel.read();
```
Example
```
const data = await myNovel.read({format: formats.binary});
```
- Defined in internal/storage.d.ts:368

toString

toString(): string
Returns the details of the given entry like name, type and native path in a readable string format.

Returns string
Inherited from Entry.toString
- Defined in internal/storage.d.ts:89

write

write(
data: string | ArrayBuffer,
options?: { append?: boolean; format?: FormatSymbol },
): Promise<number>
Writes data to a file, appending if desired. The format of the file is controlled via the format option, and defaults to UTF8.
Parameters
- data: string | ArrayBuffer
  The data to write to the file.
- Optionaloptions: { append?: boolean; format?: FormatSymbol }
  Options for the write operation (all properties are optional)
  - Optionalappend?: boolean
    If true, the data is written to the end of the file.
  - Optionalformat?: FormatSymbol
    The format of the file; see utf8 and binary.
Returns Promise<number>
The length of the contents written to the file.
Throws
FileIsReadOnly If writing to a read-only file.

Throws
OutOfSpace If writing to the file causes the file system to exceed the available space (or quota).

See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/File/#writedata-options
Example
```
await myNovel.write("It was a dark and stormy night.\n");
await myNovel.write("Cliches and tropes aside, it really was.", {append: true});
```
Example
```
const data = new ArrayBuffer();
await aDataFile.write(data, {format: formats.binary});
```
- Defined in internal/storage.d.ts:399

`Static`isFile

isFile(entry: Entry): boolean
Determines if the entry is a file or not. This is safe to use even if the entry is null or undefined.
Parameters
- entry: Entry
  The entry to check.
Returns boolean
If true, the entry is a file.
- Defined in internal/storage.d.ts:321

Class File

See

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns File

Properties

ReadonlyisEntry

Example

ReadonlyisFile

Example

ReadonlyisFolder

Example

mode

Example

Readonlyname

Example

ReadonlynativePath

Example

Readonlyprovider

Example

Readonlyurl

Example

Methods

copyTo

Parameters

OptionalallowFolderCopy?: boolean

Optionaloverwrite?: boolean

Returns Promise<Folder | File>

Throws

Throws

Throws

See

Example

Example

Example

delete

Returns Promise<number>

See

Example

getMetadata

Returns Promise<EntryMetadata>

See

Example

moveTo

Parameters

OptionalnewName?: string

Optionaloverwrite?: boolean

Returns Promise<void>

See

Example

Example

Example

Example

Example

read

Parameters

Optionalformat?: FormatSymbol

Returns Promise<string | ArrayBuffer>

See

Example

Example

toString

Returns string

write

Parameters

Optionalappend?: boolean

Optionalformat?: FormatSymbol

Returns Promise<number>

Throws

Throws

See

Example

Example

`Readonly`isEntry

`Readonly`isFile

`Readonly`isFolder

`Readonly`name

`Readonly`nativePath

`Readonly`provider

`Readonly`url

`Optional`allowFolderCopy?: boolean

`Optional`overwrite?: boolean

`Optional`newName?: string

`Optional`overwrite?: boolean

`Optional`format?: FormatSymbol

`Optional`append?: boolean

`Optional`format?: FormatSymbol

`Static`isFile