File

File

Class representing gpgfs File

Methods

(async) create(valueopt)

Source:

file.js, line 106

Create file if it does not exist

Parameters:

Name	Type	Attributes	Default	Description
`value`	string	<optional>	`''`	Content to save in file

(async) exists() → {boolean}

Source:

file.js, line 60

Check if all metadata and content exists on disk

Returns:

Type: boolean

(async) getLastchange() → {gpgfs_model.object_lastchange}

Source:

file.js, line 247

Last change metadata

Returns:

See gpgfs_model.object_lastchange

Type: gpgfs_model.object_lastchange

(async) getMetadata() → {gpgfs_model.object_meta}

Source:

file.js, line 195

File metadata

Returns:

See gpgfs_model.object_meta

Type: gpgfs_model.object_meta

(async) open()

Source:

file.js, line 26

Open and read metadata

(async) read() → {string}

Source:

file.js, line 143

Read content from file

Returns:

Type: string

(async) save(newContentopt)

Source:

file.js, line 154

Write content to file. Update metadata and re-index file in bucket index.

Parameters:

Name	Type	Attributes	Default	Description
`newContent`	string	<optional>	`this.content`