Namespace: fs

Members

---

<static, readonly> openFor :enum

File system open mode enumeration

Type:

• enum

Properties:

Name	Type	Description
reading	enum	Read as a IReadableStream from the beginning of the file
appending	enum	Append as a IWritableStream to the end of the file. NOTE: if you want to overwrite a file, delete it first

Since:

• 0.1.9

---

<static, readonly> types :enum

File system object type enumeration

Type:

• enum

Properties:

Name	Type	Description
notFound	enum	Storage path does not exist
directory	enum	Storage path points to a container of files
file	enum	Storage path points to a stream-able file
unknown	enum	Storage path points to an object but it can't be handled

Since:

• 0.1.9

Methods

---

<static> getFileStorage()

Get the current host file storage (null if none)

Since:

• 0.1.9

Returns:

IFileStorage interface

Type

gpf.interfaces.IFileStorage | null

---

<static> read(path)

Generic read method

Parameters:

Name	Type	Description
path	String	File path

Since:

• 0.2.2

Deprecated:

• since version 0.2.6, use gpf.read instead

Returns:

Resolved with the file content

Type

Promise.<String>