require('uxp').storage.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.

isFolder

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

getEntries()

Returns an array of entries contained within this folder.

Returns: Promise<Array<Entry>> - The entries within the folder.
Example

const entries = await aFolder.getEntries();
const allFiles = entries.filter(entry => entry.isFile);
CopyCopied to your clipboard
1const entries = await aFolder.getEntries();
2const allFiles = entries.filter(entry => entry.isFile);

createEntry(name, options)

Creates an entry within this folder and returns the appropriate instance.

Returns: Promise<File | Folder> - the created entry

Example

const myNovel = await aFolder.createEntry("mynovel.txt");
CopyCopied to your clipboard
const myNovel = await aFolder.createEntry("mynovel.txt");

Example

const catImageCollection = await aFolder.createEntry("cats", {type: types.folder});
CopyCopied to your clipboard
const catImageCollection = await aFolder.createEntry("cats", {type: types.folder});

createFile(name, options)

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.

Returns: Promise<File> - the created file entry

Example

const myNovelTxtFile = await aFolder.createFile("mynovel.txt");
CopyCopied to your clipboard
const myNovelTxtFile = await aFolder.createFile("mynovel.txt");

createFolder(name)

Creates a Folder within this folder and returns the appropriate instance.

Returns: Promise<Folder> - the created folder entry object

Example

const myCollectionsFolder = await aFolder.createFolder("collections");
CopyCopied to your clipboard
const myCollectionsFolder = await aFolder.createFolder("collections");

getEntry(filePath)

Gets an entry from within this folder and returns the appropriate instance.

Returns: Promise<File | Folder> - the fetched entry.

Example

const myNovel = await aFolder.getEntry("mynovel.txt");
CopyCopied to your clipboard
const myNovel = await aFolder.getEntry("mynovel.txt");

renameEntry(entry, newName, options)

Renames an entry to a new name.

Returns: Promise<void>

Example

await myNovels.rename(myNovel, "myFantasticNovel.txt");
CopyCopied to your clipboard
await myNovels.rename(myNovel, "myFantasticNovel.txt");

isFolder(entry): boolean

Checks if an entry is a folder. Safe to use if entry might be null or undefined. Useful for type checking.

Returns: boolean - if true, the entry is a folder

Last updated 8/10/2021

Was this helpful?

Yes

No