Interface Filesystem

Interface for doing filesystem operations on the platform.

Hierarchy

  • Filesystem

Methods

getFileStats? getFileTimestamp readFile watch

Methods

Optional getFileStats

  • Get the metadata of a file. Components use it to detect that a file changed, appeared, or disappeared.

    Parameters

    • path: string

      The path of the file.

    Returns Promise<undefined | FileStats>

    A promise which will resolve to the file metadata, or to undefined when the file does not exist. The promise is rejected when the operation fails for another reason.

getFileTimestamp

  • The time, in ms since POSIX epoch, that the file was last modified.

    Parameters

    • path: string

      The path to get a timestamp for.

    Returns Promise<number>

    A promise which will resolve to a timestamp if successful, or be rejected if the operation fails.

readFile

  • Read a file into a utf8 encoded string.

    Parameters

    • path: string

      The path of the file to read.

    Returns Promise<string>

    A promise which will resolve to utf8 encoded file content, or be rejected if the operation fails.

watch

  • Watch for changes to the specified path.

    The implementation of this methods should be non-persistent. Meaning that it should not keep the containing process running as long as it is executing. For node this means setting the persistent option to false.

    When the watch itself fails, the implementation should invoke the callback with the event type error instead of raising, so that the owner of the watch can set it up again.

    Parameters

    • path: string

      The path to watch.

    • callback: ((eventType, filename, changedName?) => void)

      Receives the event type, the watched path, and, when the platform reports it, the name of the entry within the watched path that changed. The name is undefined when the platform does not report it.

        • (eventType, filename, changedName?): void

        • Parameters

          • eventType: string
          • filename: string
          • Optional changedName: string
            Optional

          Returns void

    Returns WatchHandle

    An async iterator that watches for changes to path.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc