FuseJS/FileSystem Module (JS) - Fuse Documentation

Jump to:
Table of Contents

Provides an interface to the file system.

var FileSystem = require("FuseJS/FileSystem");

Using the asynchronous Promise based functions is recommended to keep your UI responsive, although synchronous variants are also available if preferred.

When saving files private to the application you can use the dataDirectory property as a base path.

Example

This example writes a text to a file, and then reads it back:

var FileSystem = require("FuseJS/FileSystem");
var path = FileSystem.dataDirectory + "/" + "testfile.tmp";

FileSystem.writeTextToFile(path, "hello world")
    .then(function() {
        return FileSystem.readTextFromFile(path);
    })
    .then(function(text) {
        console.log("The read file content was: " + text);
    })
    .catch(function(error) {
        console.log("Unable to read file due to error:" + error);
    });

Location

Namespace: Fuse.FileSystem
Package: Fuse.FileSystem 2.9.1

Show Uno properties and methods

Interface of FileSystemModule

appendTextToFile(filename) js

Asynchronously appends a string to a UTF-8 encoded file.

appendTextToFileSync(filename) js

Synchronously appends a string to a UTF-8 encoded file.

copy(source, destination) js

Asynchronously copies a file or directory recursively from source to destination path

copySync(source, destination) js

Synchronously copies a file or directory recursively from source to destination path

createDirectory(path) js

Asynchronously creates a directory.

createDirectorySync(path) js

Synchronously creates a directory.

exists(path) js

Asynchronously check if a file exists.

existsSync(path) js

Synchronously check if a file exists.

FileSystemModule Constructor uno

androidPaths : Dictionary<string, string> js

An object containing paths only exposed on Android devices:

cacheDirectory : string js

A directory to put cached files.

dataDirectory : string js

A directory to put data files that are private to the application.

getDirectoryInfo(path) js

Asynchronously gets info about a directory.

getDirectoryInfoSync(path) js

Synchronously gets info about a directory.

getFileInfo(path) js

Asynchronously gets info about a file.

getFileInfoSync(path) js

Synchronously gets info about a file.

iosPaths : Dictionary<string, string> js

An object containing paths only exposed on iOS devices:

listDirectories(path) js

Asynchronously list subdirectories in a directory.

listDirectoriesSync(path) js

Synchronously list subdirectories in a directory.

listEntries(path) js

Asynchronously lists both files and subdirectories in a directory.

listEntriesSync(path) js

Synchronously lists both files and subdirectories in a directory.

listFiles(path) js

Asynchronously list files in directory.

listFilesSync(path) js

Synchronously list files in directory.

move(source, destination) js

Asynchronously moves a file or directory from source to destination path

moveSync(source, destination) js

Synchronously moves a file or directory from source to destination path

readBufferFromFile(filename) js

Asynchronously reads a file and returns a Promise of an ArrayBuffer with its contents.

readBufferFromFileSync(filename) js

Synchronously reads a file and returns an ArrayBuffer with its contents.

readTextFromFile(filename) js

Asynchronously reads a file and returns a Promise of its contents.

readTextFromFileSync(filename) js

Synchronously reads a file and returns its contents as a string.

remove(path) js

Asynchronously delete a file.

removeSync(path) js

Synchronously delete a file.

writeBufferToFile(filename, data) js

Asynchronously writes an ArrayBuffer to a file.

writeBufferToFileSync(filename, data) js

Synchronously writes an ArrayBuffer to a file.

writeTextToFile(filename, text) js

Asynchronously writes a string to a UTF-8 encoded file.

writeTextToFileSync(filename, text) js

Synchronously writes a string to a UTF-8 encoded file.

Inherited from NativeModule

AddMember(NativeMember) uno

Reset : EventHandler (object, EventArgs) ux

Inherited from Module

Dispose uno

Evaluate(Context, ModuleResult) uno

Evaluate(Context, string) : ModuleResult uno

Evaluated : EventHandler (object, EventArgs) ux

EvaluateExports(Context, string) : object uno

GetFile : FileSource uno

Returns the file source that will be watched by the Context for changes in Fuse preview. Override in subclasses and return correct file source to support live updates in Fuse preview.

IsEvaluated : bool uno

Inherited from object

Equals(object) : bool uno

GetHashCode : int uno

GetType : Type uno

ToString : string uno

Attached UX Attributes

GlobalKey (attached by Resource) : string ux

The ux:Global attribute creates a global resource that is accessible everywhere in UX markup.