Class Folder

Represents a folder on a file system. You'll never instantiate this directly, but will get it by calling FileSystemProvider.getTemporaryFolder, FileSystemProvider.getFolder, or via Folder.getEntries.

See

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

Example

// Get the Folder instance via localFileSystem
const fs = require('uxp').storage.localFileSystem;
const folder = await fs.getTemporaryFolder(); // Gets the Folder instance
console.log(folder.isFolder); // returns true

Hierarchy (View Summary)

Entry
- Folder

Index

Constructors

constructor

new Folder(name: string, provider: FileSystemProvider, id: string): Folder
Creates an instance of Entry.
Parameters
- name: string
- provider: FileSystemProvider
- id: string
Returns Folder
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: boolean

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

Example

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

`Readonly`isFolder

isFolder: true

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

`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

createEntry

createEntry(
name: string,
options?: { overwrite?: boolean; type?: TypeSymbol },
): Promise<Folder | File>
Creates an entry within this folder and returns the appropriate instance.
Parameters
- name: string
  The name of the entry to create.
- Optionaloptions: { overwrite?: boolean; type?: TypeSymbol }
  Options for the create operation (all properties are optional)
  - Optionaloverwrite?: boolean
    If true, the create attempt can overwrite an existing file.
  - Optionaltype?: TypeSymbol
    Indicates which kind of entry to create. Pass folder to create a new folder. Note that if the type is file then this method just create a file entry object and not the actual file on the disk. The file actually gets created when you call for eg: write method on the file entry object.
Returns Promise<Folder | File>
The created entry.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Folder/#createentryname-options
Example
```
const myNovel = await aFolder.createEntry("mynovel.txt");
```
Example
```
const catImageCollection = await aFolder.createEntry("cats", {type: types.folder});
```
- Defined in internal/storage.d.ts:472

createFile

createFile(name: string, options?: { overwrite?: boolean }): Promise<File>
Creates a File Entry object within this folder and returns the appropriate instance. Note that this method just create a file entry object and not the actual file on the disk. The file actually gets created when you call for eg: write method on the file entry object.
Parameters
- name: string
  The name of the file to create.
- Optionaloptions: { overwrite?: boolean }
  Options for the create operation (all properties are optional)
  - Optionaloverwrite?: boolean
    If true, the create attempt can overwrite an existing file.
Returns Promise<File>
The created file entry.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Folder/#createfilename-options
Example
```
const myNovelTxtFile = await aFolder.createFile("mynovel.txt");
```
- Defined in internal/storage.d.ts:506

createFolder

createFolder(name: string): Promise<Folder>
Creates a Folder within this folder and returns the appropriate instance.
Parameters
- name: string
  The name of the folder to create.
Returns Promise<Folder>
The created folder entry object.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Folder/#createfoldername
Example
```
const myCollectionsFolder = await aFolder.createFolder("collections");
```
- Defined in internal/storage.d.ts:529

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

getEntries

getEntries(): Promise<Entry[]>
Returns an array of entries contained within this folder.

Returns Promise<Entry[]>
The entries within the folder.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Folder/#getentries
Example
```
const entries = await aFolder.getEntries();
const allFiles = entries.filter(entry => entry.isFile);
```
- Defined in internal/storage.d.ts:451

getEntry

getEntry(filePath: string): Promise<Folder | File>
Gets an entry from within this folder and returns the appropriate instance.
Parameters
- filePath: string
  The name/path of the entry to fetch.
Returns Promise<Folder | File>
The fetched entry.
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Folder/#getentryfilepath
Example
```
const myNovel = await aFolder.getEntry("mynovel.txt");
```
- Defined in internal/storage.d.ts:544

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

renameEntry

renameEntry(
    entry: Entry,
    newName: string,
    options?: { overwrite?: boolean },
): Promise<void>
Renames an entry to a new name.
Parameters
- entry: Entry
  The entry to rename.
- newName: string
  The new name to assign.
- Optionaloptions: { overwrite?: boolean }
  Options for the rename operation (all properties are optional)
  - Optionaloverwrite?: boolean
    If true, renaming can overwrite an existing entry.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-js/Modules/uxp/Persistent%20File%20Storage/Folder/#renameentryentry-newname-options
Example
```
await myNovels.renameEntry(myNovel, "myFantasticNovel.txt");
```
- Defined in internal/storage.d.ts:560

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

`Static`isFolder

isFolder(entry: Entry): boolean
Parameters
- entry: Entry
Returns boolean
- Defined in internal/storage.d.ts:430

Class Folder

See

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Folder

Properties

ReadonlyisEntry

Example

ReadonlyisFile

Example

ReadonlyisFolder

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

createEntry

Parameters

Optionaloverwrite?: boolean

Optionaltype?: TypeSymbol

Returns Promise<Folder | File>

See

Example

Example

createFile

Parameters

Optionaloverwrite?: boolean

Returns Promise<File>

See

Example

createFolder

Parameters

Returns Promise<Folder>

See

Example

delete

Returns Promise<number>

See

Example

getEntries

Returns Promise<Entry[]>

See

Example

getEntry

Parameters

Returns Promise<Folder | File>

See

Example

getMetadata

Returns Promise<EntryMetadata>

See

Example

moveTo

Parameters

OptionalnewName?: string

Optionaloverwrite?: boolean

Returns Promise<void>

`Readonly`isEntry

`Readonly`isFile

`Readonly`isFolder

`Readonly`name

`Readonly`nativePath

`Readonly`provider

`Readonly`url

`Optional`allowFolderCopy?: boolean

`Optional`overwrite?: boolean

`Optional`overwrite?: boolean

`Optional`type?: TypeSymbol

`Optional`overwrite?: boolean

`Optional`newName?: string

`Optional`overwrite?: boolean

`Optional`overwrite?: boolean

`Static`isFolder