Entry

An Entry is the base class for File and Folder. You can get an instance of Entry via the localFileSystem by fetching an instance of a File or Folder

Example

Copy
// Since Entry cannot be called directly we can use a File or Folder object to invoke Entry as shown below
const fs =  require('uxp').storage.localFileSystem;
const folder = await fs.getPluginFolder(); // returns a Folder instance
const folderEntry = await folder.getEntry("entryName.txt");

// Now we can use folderEntry to invoke the APIs provided by Entry
console.log(folderEntry.isEntry); // isEntry is an API of Entry, in this example it will return true
Copied to your clipboard
// Since Entry cannot be called directly we can use a File or Folder object to invoke Entry as shown below
const fs =  require('uxp').storage.localFileSystem;
const folder = await fs.getPluginFolder(); // returns a Folder instance
const folderEntry = await folder.getEntry("entryName.txt");

// Now we can use folderEntry to invoke the APIs provided by Entry
console.log(folderEntry.isEntry); // isEntry is an API of Entry, in this example it will return true

isEntry : boolean

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

Example

Copy
if (something.isEntry) {
    return something.getMetadata();
}
Copied to your clipboard
if (something.isEntry) {
    return something.getMetadata();
}

isFile : boolean

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

Example

Copy
if (!anEntry.isFile) {
    return "This entry is not a file.";
}
Copied to your clipboard
if (!anEntry.isFile) {
    return "This entry is not a file.";
}

isFolder : boolean

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

Example

Copy
if (!anEntry.isFolder) {
    return "This entry is not a folder.";
}
Copied to your clipboard
if (!anEntry.isFolder) {
    return "This entry is not a folder.";
}

name : string

Read only The name of this entry. Read-only.

Example

Copy
console.log(anEntry.name);
Copied to your clipboard
console.log(anEntry.name);

provider : FileSystemProvider

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

Example

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

url : string

Read only 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

Copy
console.log(anEntry.url);
Copied to your clipboard
console.log(anEntry.url);

nativePath : string

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

Example

Copy
console.log(anEntry.nativePath);
Copied to your clipboard
console.log(anEntry.nativePath);

toString()

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

Returns: string

copyTo(folder, options)

Copies this entry to the specified folder.

Returns: Promise<File | Folder>
Throws:

• EntryExists if the attempt would overwrite an entry and overwrite is false
• PermissionDenied if the underlying file system rejects the attempt
• OutOfSpace if the file system is out of storage space

Example

Copy
await someFile.copyTo(someFolder);
Copied to your clipboard
await someFile.copyTo(someFolder);

Example

Copy
await someFile.copyTo(someFolder, {overwrite: true});
Copied to your clipboard
await someFile.copyTo(someFolder, {overwrite: true});

Example

Copy
await someFolder.copyTo(anotherFolder, {overwrite: true, allowFolderCopy: true});
Copied to your clipboard
await someFolder.copyTo(anotherFolder, {overwrite: true, allowFolderCopy: true});

moveTo(folder, options)

Moves this entry to the target folder, optionally specifying a new name.

Returns: Promise<void>

Example

Copy
await someFile.moveTo(someFolder);
Copied to your clipboard
await someFile.moveTo(someFolder);

Example

Copy
await someFile.moveTo(someFolder, {overwrite: true});
Copied to your clipboard
await someFile.moveTo(someFolder, {overwrite: true});

Example

Copy
await someFolder.moveTo(anotherFolder, {overwrite: true});
Copied to your clipboard
await someFolder.moveTo(anotherFolder, {overwrite: true});

Example

Copy
await someFile.moveTo(someFolder, {newName: 'masterpiece.txt'})
Copied to your clipboard
await someFile.moveTo(someFolder, {newName: 'masterpiece.txt'})

Example

Copy
await someFile.moveTo(someFolder, {newName: 'novel.txt', {overwrite: true})
Copied to your clipboard
await someFile.moveTo(someFolder, {newName: 'novel.txt', {overwrite: true})

delete()

Removes this entry from the file system. If the entry is a folder, it must be empty before deletion. 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
Example

Copy
await aFile.delete();
Copied to your clipboard
await aFile.delete();

getMetadata()

Returns this entry's metadata.

Returns: Promise<EntryMetadata>
Example

Copy
const metadata = aFile.getMetadata();
Copied to your clipboard
const metadata = aFile.getMetadata();

Last updated 11/25/2024

Was this helpful?

Yes

No