Gpgfs - Documentation

new Gpgfs(options)

Source:

gpgfs.js, line 28

A gpgfs file-system

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`path`	string	Path to a `gpgfs` file directory
`keychain`	GpgPromised.KeyChain	See `GpgPromised.KeyChain`

Members

(static) FuseMount :FuseMount

Source:

gpgfs.js, line 63

Type:

FuseMount

(static) GPG :GpgPromised

Source:

gpgfs.js, line 253

Type:

GpgPromised

whoami :string

Source:

gpgfs.js, line 39

Type:

string

Methods

(async) bucket(name) → {Array.<Bucket>}

Source:

gpgfs.js, line 117

Load bucket

Parameters:

Name	Type	Description
`name`	string	Name of bucket to load

Returns:

Matching bucket

Type: Array.<Bucket>

(async) cacheWhoami()

Source:

gpgfs.js, line 46

Load keychain owner into cache

(async) getBuckets(options) → {Array.<Bucket>}

Source:

gpgfs.js, line 83

Load all matching bucket metadata

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`id`	string	Bucket Id filter
`name`	string	Name filter

Returns:

Array of Bucket

Type: Array.<Bucket>

(async) open()

Source:

gpgfs.js, line 55

Open file system for read & write operations