Class: JsNodeDrive

JsNodeDrive()

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 JsNodeDrive()

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

Classes

JsNodeDrive

Methods

getFile(file)

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

getPrivateDir() → {IRealFile}

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

onUnlockError()

When authorization fails.
Source:

onUnlockSuccess()

When authorization succeed.
Source:

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

Helper method that creates and initializes a JsDrive
Parameters:
Name Type Description
dir IRealFile 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.<SalmonDrive>

(async, static) open(dir, password, sequencer) → {Promise.<SalmonDrive>}

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