Bucket

Bucket

Class representing gpgfs Bucket

Methods

(async) addActor(options)

Source:

Allow access for list of actors to type level of access

Parameters:
Name Type Description
options Object
Properties
Name Type Description
type 'meta' | 'readers' | 'writers'

Access type

list Array.<string>

List of emails or fingerprints

(async) create()

Source:

Create bucket if it does not exist

(async) exists() → {boolean}

Source:

Check if all metadata exists on disk

Returns:
Type
boolean

(async) file(name) → {File}

Source:

Get a file instance

Parameters:
Name Type Description
name string

File path

Returns:
Type
File

(async) getIndex() → {gpgfs_model.bucket_index}

Source:

Bucket index

Returns:
Type
gpgfs_model.bucket_index

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

Source:

Bucket metadata

Returns:
Type
gpgfs_model.bucket_meta

(async) indexFile(file)

Source:
Parameters:
Name Type Description
file File

(async) open()

Source:

Open and read metadata