Interface DirectoryEntrySync

This interface represents a directory on a file system.

Hierarchy

Index

Properties

Methods

Properties

public filesystem: FileSystemSync

The file system on which the entry resides.

public fullPath: string

The full absolute path from the root to the entry.

public isDirectory: boolean

EntrySync is a directory.

readonly

public isFile: boolean

EntrySync is a file.

readonly

public name: string

The name of the entry, excluding the path leading to it.

Methods

public copyTo(parent: DirectoryEntrySync, newName?: string): EntrySync

Copy an entry to a different location on the file system. It is an error to try to:

  • copy a directory inside itself or to any child at any depth;

  • copy an entry into its parent if a name different from its current one isn't provided;

  • copy a file to a path occupied by a directory;

  • copy a directory to a path occupied by a file;

  • copy any element to a path occupied by a directory which is not empty.
    • A copy of a file on top of an existing file must attempt to delete and replace that file. A copy of a directory on top of an existing empty directory must attempt to delete and replace that directory. Directory copies are always recursive--that is, they copy all contents of the directory.

    Parameters

    Returns

    EntrySync

public createReader(): DirectoryReaderSync

Creates a new DirectoryReaderSync to read EntrySyncs from this DirectorySync.

Returns

DirectoryReaderSync

public getDirectory(path: string, options?: Flags): DirectoryEntrySync

Creates or looks up a directory.

Parameters

  • path: string

    Either an absolute path or a relative path from this DirectoryEntrySync to the directory to be looked up or created. It is an error to attempt to create a directory whose immediate parent does not yet exist.

  • options?: Flags optional
    <ul>
<li> If create and exclusive are both true and the path already exists, getDirectory must fail.</li>
<li> If create is true, the path doesn't exist, and no other error occurs, getDirectory must create and return a corresponding DirectoryEntry.</li>
<li> If create is not true and the path doesn't exist, getDirectory must fail.</li>
<li> If create is not true and the path exists, but is a file, getDirectory must fail.</li>
<li> Otherwise, if no other error occurs, getDirectory must return a DirectoryEntrySync corresponding to path.</li>
</ul>

Returns

DirectoryEntrySync

public getFile(path: string, options?: Flags): FileEntrySync

Creates or looks up a directory.

Parameters

  • path: string

    Either an absolute path or a relative path from this DirectoryEntrySync to the file to be looked up or created. It is an error to attempt to create a file whose immediate parent does not yet exist.

  • options?: Flags optional
    <ul>
<li> If create and exclusive are both true and the path already exists, getFile must fail.</li>
<li> If create is true, the path doesn't exist, and no other error occurs, getFile must create it as a zero-length file and return a corresponding FileEntry.</li>
<li> If create is not true and the path doesn't exist, getFile must fail.</li>
<li> If create is not true and the path exists, but is a directory, getFile must fail.</li>
<li> Otherwise, if no other error occurs, getFile must return a FileEntrySync corresponding to path.</li>
</ul>

Returns

FileEntrySync

public getMetadata(): Metadata

Look up metadata about this entry.

Returns

Metadata

public getParent(): DirectoryEntrySync

Look up the parent DirectoryEntrySync containing this Entry. If this EntrySync is the root of its filesystem, its parent is itself.

Returns

DirectoryEntrySync

public moveTo(parent: DirectoryEntrySync, newName?: string): EntrySync

Move an entry to a different location on the file system. It is an error to try to:

  • move a directory inside itself or to any child at any depth;

  • move an entry into its parent if a name different from its current one isn't provided;

  • move a file to a path occupied by a directory;

  • move a directory to a path occupied by a file;

  • move any element to a path occupied by a directory which is not empty.
    • A move of a file on top of an existing file must attempt to delete and replace that file. A move of a directory on top of an existing empty directory must attempt to delete and replace that directory.

    Parameters

    • parent: DirectoryEntrySync

      The directory to which to move the entry.

    • newName?: string optional

      The new name of the entry. Defaults to the EntrySync's current name if unspecified.

    Returns

    EntrySync

public remove()

Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to attempt to delete the root directory of a filesystem.

public removeRecursively()

Deletes a directory and all of its contents, if any. In the event of an error [e.g. trying to delete a directory that contains a file that cannot be removed], some of the contents of the directory may be deleted. It is an error to attempt to delete the root directory of a filesystem.

public toURL(): string

Returns a URL that can be used to identify this entry. Unlike the URN defined in [FILE-API-ED], it has no specific expiration; as it describes a location on disk, it should be valid at least as long as that location exists.

Returns

string