Class: NodeDrive

NodeDrive()

SalmonDrive implementation for standard node js file system. This provides a virtual drive implementation that you can use to store and access encrypted files on the local server. Use static methods open() or create() to create an instance.

Constructor

new NodeDrive()

Private constructor, use open() and create() instead.
Source:

Classes

NodeDrive

Methods

getPrivateDir() → {IFile}

Get a private dir for sharing files with external applications.
Source:
Throws:
Exception
Returns:
The private dir
Type
IFile

getVirtualFile(file) → {AesFile}

Parameters:
Name Type Description
file The real file.
Source:
Returns:
The encrypted file.
Type
AesFile

onUnlockError()

When authorization fails.
Source:

onUnlockSuccess()

When authorization succeed.
Source:

(async, static) create(dir, password, sequencer) → {Promise.<AesDrive>}

Helper method that creates and initializes a Drive
Parameters:
Name Type Description
dir IFile The real directory that will contain the drive.
password string Text password to use with this drive.
sequencer ISalmonSequencer The nonce sequencer that will be used for encryption.
Source:
Returns:
The drive.
Type
Promise.<AesDrive>

(async, static) open(dir, password, sequenceropt) → {Promise.<AesDrive>}

Helper method that opens and initializes a Drive
Parameters:
Name Type Attributes Description
dir IFile The real directory that contains the drive.
password string Text password to use with this drive.
sequencer ISalmonSequencer <optional>
 Optional nonce sequencer that will be used for importing files.
Source:
Returns:
The drive.
Type
Promise.<AesDrive>