FileSystemStorageAdapter | virgil-sdk

Implementation of IStorageAdapter that uses file system for persistence. For use in Node.js.

Hierarchy

FileSystemStorageAdapter

Implements

IStorageAdapter

Index

Constructors

constructor

Methods

Constructors

constructor

new FileSystemStorageAdapter(config: IStorageAdapterConfig): FileSystemStorageAdapter

- Defined in Storage/adapters/FileSystemStorageAdapter.ts:18
Initializes a new instance of FileSystemStorageAdapter.

Parameters
- config: IStorageAdapterConfig
  
  Configuration options. Currently only dir is supported and must be a file system path to the folder where the data will be stored.
Returns FileSystemStorageAdapter

Methods

clear

clear(): Promise<void>

Implementation of IStorageAdapter.clear
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:118
Removes all of the entries from persistent storage.

Returns Promise<void>

exists

exists(key: string): Promise<boolean>

Implementation of IStorageAdapter.exists
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:62
Checks if the data for the key exists.

Parameters
- key: string
Returns Promise<boolean>
- Promise resolved with true if data for the key exists, or false otherwise.

list

list(): Promise<string[]>

Implementation of IStorageAdapter.list
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:132
Retrieves a collection of all of the values in persistent storage.

Returns Promise<string[]>

load

load(key: string): Promise<string | null>

Implementation of IStorageAdapter.load
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:52
Retieves the data for the key.

Parameters
- key: string
Returns Promise<string | null>
- Promise resolved with the data for the given key, or null if there's no data.

remove

remove(key: string): Promise<boolean>

Implementation of IStorageAdapter.remove
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:82
Removes the data for the key.

Parameters
- key: string
Returns Promise<boolean>

Promise resolved with true if data have been removed, or false otherwise.

store

store(key: string, data: string): Promise<void>

Implementation of IStorageAdapter.store
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:35
Saves the data under the key in persistent storage. If the key already exists, throws StorageEntryAlreadyExistsError.

Parameters
- key: string
- data: string
Returns Promise<void>

update

update(key: string, data: string): Promise<void>

Implementation of IStorageAdapter.update
- Defined in Storage/adapters/FileSystemStorageAdapter.ts:102
Sets the new data for the key.

Parameters
- key: string
- data: string
Returns Promise<void>