fs - Documentation

HTML5 Filesystem API

Source:

index.js, line 1

Methods

(static) appendFile(path, data) → {Promise}

Source:

index.js, line 107

Appends data to file. If file does not exist - it will be created.

Parameters:

Name	Type	Description
`path`	String \| FileSystemFileEntry
`data`	String \| Blob \| File \| ArrayBuffer

Returns:

Type: Promise

(static) clear() → {Promise}

Source:

index.js, line 233

Clears whole filesystem

Returns:

Type: Promise

(static) copy(oldPath, newPath, optionsopt) → {Promise.<FileSystemEntry>}

Source:

index.js, line 154

Copies file or entire directory. If file or directory does not exist - error thrown.

Parameters:

Name Type Attributes Description

oldPath String | FileSystemEntry

newPath String

options

Object

Properties

Name	Type	Attributes	Default	Description
`create`	Boolean	<optional>	`false`	create missing directories

Returns:

Type: Promise.<FileSystemEntry>

(static) createReadStream(path) → {ReadableStream}

Source:

index.js, line 275

Create a ReadableStream for reading

Parameters:

Name	Type	Description
`path`	String \| FileSystemFileEntry

Returns:

Type: ReadableStream

(static) createWriteStream(path) → {WritableStream}

Source:

index.js, line 285

Create a WritableStream for writing

Parameters:

Name	Type	Description
`path`	String \| FileSystemFileEntry

Returns:

Type: WritableStream

(static) exists(path) → {Promise.<Boolean>}

Source:

index.js, line 193

Checks that file or directory exists by provided path.

Parameters:

Name	Type	Description
`path`	String

Returns:

Type: Promise.<Boolean>

(static) getEntry(path) → {Promise.<FileSystemEntry>}

Source:

index.js, line 261

Gets file or directory

Parameters:

Name	Type	Description
`path`	String \| FileSystemEntry

Returns:

Type: Promise.<FileSystemEntry>

(static) getRoot() → {FileSystemDirectoryEntry}

Source:

index.js, line 64

Returns root directory

Returns:

Type: FileSystemDirectoryEntry

(static) getUrl(path) → {String}

Source:

index.js, line 250

Gets URL for path

Parameters:

Name	Type	Description
`path`	String \| FileSystemEntry

Returns:

Type: String

(static) init(optionsopt) → {Promise}

Source:

index.js, line 33

Init filesystem

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`type`	Number	<optional>	`window.PERSISTENT`	window.PERSISTENT \| window.TEMPORARY
`bytes`	Number	<optional>	`1Mb`
`requestQuota`	Boolean	<optional>	`true`	show request quota popup for PERSISTENT type. (for Chrome extensions with `unlimitedStorage` permission it is useful to pass options.requestQuota = false)

Returns:

Type: Promise

(static) isSupported() → {Boolean}

Source:

index.js, line 19

Is filesystem API supported by current browser

Returns:

Type: Boolean

(static) mkdir(path) → {Promise.<FileSystemDirectoryEntry>}

Source:

index.js, line 183

Recursively creates required directories in provided path.

Parameters:

Name	Type	Description
`path`	String

Returns:

Type: Promise.<FileSystemDirectoryEntry>

(static) readdir(path, optionsopt) → {Promise.<Array.<FileSystemEntry>>}

Source:

index.js, line 221

Reads directory content

Parameters:

Name Type Attributes Description

path String | FileSystemDirectoryEntry

options

Object

Properties

Name	Type	Attributes	Default	Description
`deep`	Boolean	<optional>	`false`	read recursively and attach data as `children` property

Returns:

Type: Promise.<Array.<FileSystemEntry>>

(static) readFile(path, optionsopt) → {Promise.<String>}

Source:

index.js, line 80

Reads file content.

options.type='Blob' returns a immutable snapshot of the file. Slower but safer.
options.type='File' returns a mutable instance of File. Faster but may have a data race.

If file does not exist - error thrown.

Parameters:

Name Type Attributes Description

path String | FileSystemFileEntry

options

Object

Properties

Name	Type	Attributes	Default	Description
`type`	String	<optional>	`'Text'`	how content should be read: Text\|ArrayBuffer\|BinaryString\|DataURL\|Blob\|File

Returns:

Type: Promise.<String>

(static) rename(oldPath, newPath, optionsopt) → {Promise.<FileSystemEntry>}

Source:

index.js, line 140

Renames file or directory. If source file or directory does not exist - error thrown. If target already exists - it will be overwritten.

Parameters:

Name Type Attributes Description

oldPath String | FileSystemEntry

newPath String

options

Object

Properties

Name	Type	Attributes	Default	Description
`create`	Boolean	<optional>	`false`	create missing directories

Returns:

Type: Promise.<FileSystemEntry>

(static) rmdir(path) → {Promise}

Source:

index.js, line 165

Removes directory recursively. If directory does not exist - method does nothing without error.

Parameters:

Name	Type	Description
`path`	String \| FileSystemDirectoryEntry

Returns:

Type: Promise

(static) stat(path) → {Promise.<StatObject>}

Source:

index.js, line 208

Gets info about file or directory. If it does not exist - error thrown.

Parameters:

Name	Type	Description
`path`	String \| FileSystemEntry

Returns:

Type: Promise.<StatObject>

(static) unlink(path) → {Promise}

Source:

index.js, line 119

Removes file. If file does not exist - no error thrown.

Parameters:

Name	Type	Description
`path`	String \| FileSystemFileEntry

Returns:

Type: Promise

(static) usage() → {Promise.<{usedBytes, grantedBytes}>}

Source:

index.js, line 55

Gets used and granted bytes

Returns:

Type: Promise.<{usedBytes, grantedBytes}>

(static) writeFile(path, data) → {Promise}

Source:

index.js, line 94

Writes data to file. If file does not exist - it will be created. If file already exists - it will be overwritten.

Parameters:

Name	Type	Description
`path`	String
`data`	String \| Blob \| File \| ArrayBuffer

Returns:

Type: Promise